Skip to content

Commit

Permalink
Clarified option settings
Browse files Browse the repository at this point in the history
  • Loading branch information
splorp committed May 17, 2022
1 parent 4c01346 commit a55daad
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
4 changes: 2 additions & 2 deletions index.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@
$pages = $pages->listed();
}

/* Include only the children of the specified page */
/* Include only the children of specified pages */

if ($includeChildren) {
$pages = $pages->find($includeChildren)->children();
}

/* Exclude pages using certain templates */
/* Exclude pages using specified templates */

$pages = $pages->filterBy('intendedTemplate', 'not in', $excludeTemplate);

Expand Down
14 changes: 8 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,9 @@ Updating the plugin as a Git submodule:

## Options

By default, Kirby Paperback Export will include the text from the title and description fields for every page on your Kirby site, including unlisted pages. The following options allow you to filter which pages are included in the exported data.
By default, text located in the `$page->title()` and `$page->text()` fields for 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.

These optional settings can be added to the `site/config/config.php` file.

### Include Unlisted Pages
### Include unlisted pages

This option is set to true by default.

Expand All @@ -59,7 +57,9 @@ return [
];
```

### Include only the children of specific pages
### 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.

Expand All @@ -77,7 +77,9 @@ return [
];
```

### Exclude specific templates
### Exclude Templates

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

This option is not set by default.

Expand Down

0 comments on commit a55daad

Please sign in to comment.