splorp/paperback-export

Export Kirby 3 CMS content for use with the PaperBack Book Maker

Maintainers

Details

github.com/splorp/kirby-paperback-export

Homepage

Source

Issues

Documentation

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 4

Forks: 0

Open Issues: 0

Type:kirby-plugin

2.0.6 2023-01-11 18:21 UTC

Requires

MIT e36b9c7a09b5dd9cb4920fe8c01dac9fd0d38ccc

kirby3kirby-pluginkirby-cmspaperback-book-makernewton-booknewton-os

This package is auto-updated.

Last update: 2024-04-17 17:48:58 UTC

README

Export Kirby CMS content for use with the Paperback Book Maker.

This plugin is compatible with both Kirby 3 and Kirby 4.

What does this plugin do?

The plugin generates a lightly formatted plain text file from a set of pages specified by the user. The text file is used to create a “book” package which can be viewed on a Newton OS device.

An example of the exported file can be downloaded using the link below. The file contains all of the terms currently published on the Newton Glossary site.

newtonglossary.com/export/paperback

What is a Paperback book, you ask?

Paperback is a simple cross-platform utility created by David Fedor that takes plain text files and quickly packages them for viewing on a Newton OS device. Since the Paperback utility only runs under classic Mac OS and Windows, an online Paperback Book Maker was developed by Victor Rehorst for all your cross-platform needs.

Installation

After installing the plugin using one of the methods below, visiting yoursite.com/export/paperback should automatically download a text file without any additional configuration.

Download

To install the plugin manually, download the current release, decompress the archive, and put the files in:

site/plugins/paperback-export

For Kirby 2 sites, download version 1.0.1 of the plugin.

Git Submodule

Installing the plugin as a Git submodule:

$ cd your/project/root
$ git submodule add https://github.com/splorp/kirby-paperback-export.git site/plugins/paperback-export
$ git submodule update --init --recursive
$ git commit -am "Add Kirby Paperback Export plugin"

Updating the plugin as a Git submodule:

$ cd your/project/root
$ git submodule foreach git checkout master
$ git submodule foreach git pull
$ git commit -am "Update submodules"
$ git submodule update --init --recursive

Options

Table of Contents Prefix

Paperback books can include a table of contents created from the text found located in the $page->title() field. The following option can be added to the site/config/config.php file, allowing you to specify a custom table of contents prefix.

This option is not set by default.

return [
	'splorp.paperback-export.prefix' => '',
];

Specify a table of contents prefix.

return [
	'splorp.paperback-export.prefix' => '@@TOC ',
];

Include Other Content Fields

By default, text located in the $page->title() and $page->text() fields will be included in the exported data. The following option can be added to the site/config/config.php file, allowing you to specify other content fields to be included. These fields will be appended after the title and text fields.

This option is not set by default.

return [
	'splorp.paperback-export.fields' => [],
];

Specify one or more content fields and their type as an array.

return [
	'splorp.paperback-export.fields' => ['author' => 'text','posts' => 'related'],
];

Use the text content type for any field containing alphanumberic data, such as an author name or date.

Use the related content type for fields formatted using the YAML syntax for related articles. The title field of each related article or page will be included in the exported data.

Include Unlisted Pages

By default, every page on your Kirby site will be included in the exported data. The following options can be added to the site/config/config.php file, allowing you to filter which pages are included based on certain criteria.

This option is set to true by default.

return [
	'splorp.paperback-export.includeUnlisted' => true,
];

Include Children Pages

Pages specified in this option will not be included, but the children of those pages will be included in the exported data.

This option is not set by default.

return [
	'splorp.paperback-export.includeChildren' => [],
];

Specify one or more pages as an array.

return [
	'splorp.paperback-export.includeChildren' => ['blog','newsletter'],
];

Exclude Templates

Pages using the templates specified in this option will be excluded from the exported data.

This option is not set by default.

return [
	'splorp.paperback-export.excludeTemplate' => [],
];

Specify one or more templates as an array.

return [
	'splorp.paperback-export.excludeTemplate' => ['about','search'],
];

Include Datestamp

The following option can be added to the site/config/config.php file, allowing you to add a datestamp that indicates when the data was exported. The datestamp is formatted as YYYY-MMM-DD and is inserted after the site title and description.

This option is set to false by default.

return [
	'splorp.paperback-export.includeDatestamp' => false,
];

Release Notes

2.0.6

  • Improved handling of pages containing <img> elements

2.0.5

  • Added option to specify inclusion of the datestamp

2.0.4

  • Added option to specify other content fields

2.0.3

  • Added option to specify the table of contents prefix
  • Added better exception checking for option values
  • Fixed malformed support field in composer.json
  • Removed extraneous comments from index.php

2.0.2

  • Added keywords, homepage, support.docs, support.source fields to composer.json

2.0.1.1

  • Fixed version number in index.php

2.0.1

  • Refactored replacement patterns in string functions
  • Removed extra line breaks introduced by heading elements
  • Better handling of pages containing <img> elements
  • Added the current date to the exported file

2.0.0

  • Refactored and updated for Kirby 3
  • Tweaked the option names to be more consistent and self explanatory
  • Moved the file export code into snippets/export.php
  • Renamed snippets/page.php to snippets/content.php

1.0.1

  • Refactored filtering options
  • Fixed formatting of paragraph breaks in $page->text()

1.0.0

  • Initial release

Acknowledgements

A tip of the hat to Pedro Borges and his Kirby XML Sitemap for providing the necessary framework and inspiration to attempt my own plugin.

License

Copyright © 2017–2024 Grant Hutchinson

This project is licensed under the short and sweet MIT License. This license allows you to do anything pretty much anything you want with the contents of the repository, as long as you provide proper attribution and don’t hold anyone liable.

See the license.txt file included in this repository for further details.

Questions?

Contact me via email or Twitter.