dokuwiki-plugin-childrenpages/README.md

51 lines
1.5 KiB
Markdown

# DokuWiki plugin: Children pages
For each page, this plugin adds children pages in pre-set namespaces, reachable
through links in the page menu.
[![thumbnail]][screenshot]
[thumbnail]: https://port.numenaute.org/dokuwiki/dokuwiki-plugin-childrenpages/raw/branch/master/img/thumbnail.png
[screenshot]: https://port.numenaute.org/dokuwiki/dokuwiki-plugin-childrenpages/raw/branch/master/img/screenshot.png
## Installation
### Requirements
* `git`
### Current stable version (1.2.1)
Assuming the root directory of your DokuWiki installation is `/srv/dokuwiki`:
```
DOKUWIKI_PATH=/srv/dokuwiki
REPO_URL=https://git.vv221.fr/dokuwiki-childrenpages
git clone --branch 1.2.1 --depth 1 "$REPO_URL" "$DOKUWIKI_PATH/lib/plugins/childrenpages"
```
### Latest development version
Assuming the root directory of your DokuWiki installation is `/srv/dokuwiki`:
```
DOKUWIKI_PATH=/srv/dokuwiki
REPO_URL=https://git.vv221.fr/dokuwiki-childrenpages
git clone --branch master --depth 1 "$REPO_URL" "$DOKUWIKI_PATH/lib/plugins/childrenpages"
```
## Configuration
### Namespaces list
The links to children pages are generated from a list of reserved top level
namespaces. Normal pages should not be created in these namespaces.
This list can be modified in DokuWiki config manager, and defaults to:
```
animation, gameplay, dev, talk
```
## Informations for developers
Up-to-date informations for developers can be found [on the project wiki].
[on the project wiki]: https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages/-/wikis/home