Skip to content

Commit 587269e

Browse files
committed
Added plugin installation, edited text file export details
1 parent 626cf16 commit 587269e

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

readme.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Export [Kirby](https://getkirby.com/) content for use with the [Paperback Book M
44

55
## What does this plugin do?
66

7-
The plugin generates a lightly formatted plain text file from a set of pages specified by the user.
7+
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.
88

99
An example of this file can be downloaded using the following link. The file contains all of the terms currently published on the [Newton Glossary](http://newtonglossary.com/) site.
1010

@@ -14,9 +14,46 @@ An example of this file can be downloaded using the following link. The file con
1414

1515
Paperback is a simple cross-platform utility created by [David Fedor](http://thefedors.com/pobox/) 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](https://ritsuko.chuma.org/paperback/) was developed by [Victor Rehorst](https://github.com/chuma) for all your cross-platform needs.
1616

17+
## Installation
18+
19+
After installing the plugin using one of the methods listed below, visiting `yoursite.com/export/paperback` should automatically download a text file without any additional configuration.
20+
21+
### Download
22+
23+
To install the plugin manually, [download the files](https://github.com/splorp/kirby-paperback-export/archive/master.zip) and put them in:
24+
25+
`site/plugins/paperback-export`
26+
27+
### Kirby CLI
28+
29+
Installing the plugin using the Kirby [command line interface](https://github.com/getkirby/cli):
30+
31+
$ kirby plugin:install splorp/kirby-paperback-export
32+
33+
Updating the plugin using the Kirby CLI:
34+
35+
$ kirby plugin:update splorp/kirby-paperback-export
36+
37+
### Git Submodule
38+
39+
Installing the plugin as a Git submodule:
40+
41+
$ cd your/project/root
42+
$ git submodule add https://github.com/splorp/kirby-paperback-export.git site/plugins/paperback-export
43+
$ git submodule update --init --recursive
44+
$ git commit -am "Add Kirby Paperback Export plugin"
45+
46+
Updating the plugin as a Git submodule:
47+
48+
$ cd your/project/root
49+
$ git submodule foreach git checkout master
50+
$ git submodule foreach git pull
51+
$ git commit -am "Update submodules"
52+
$ git submodule update --init --recursive
53+
1754
## Options
1855

19-
By default, Kirby Paperback Export will include the text of every page on your Kirby site, including invisible pages. The following options allow you to select and filter which pages are included.
56+
By default, Kirby Paperback Export will include the text from the title and description fields for every page on your Kirby site, including invisible pages. The following options allow you to select and filter which pages are included.
2057

2158
```php
2259
// Include invisible pages

0 commit comments

Comments
 (0)