Download the PHP package splorp/paperback-export without Composer

On this page you can find all versions of the php package splorp/paperback-export. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of splorp/paperback-export

Informations about the package paperback-export

Kirby Paperback Export

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.

Specify a table of contents prefix.

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.

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

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.

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.

Specify one or more pages as an array.

Exclude Templates

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

This option is not set by default.

Specify one or more templates as an array.

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.

Release Notes

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1.1

2.0.1

2.0.0

1.0.1

1.0.0

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 Twitter.

All versions of paperback-export with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package splorp/paperback-export contains the following files

Loading the files please wait ....