82 lines
2.4 KiB
Markdown
82 lines
2.4 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]: img/thumbnail.png
|
|
[screenshot]: img/screenshot.png
|
|
|
|
## Installation
|
|
|
|
Right now, only installation through git is available. Alternatives will be
|
|
proposed at a later point.
|
|
|
|
### Installation using archives
|
|
|
|
#### Requirements
|
|
|
|
* `curl`
|
|
* `tar`
|
|
* `gzip`
|
|
|
|
#### Current stable version (1.0.0)
|
|
|
|
Assuming the root directory of your DokuWiki installation is `/srv/dokuwiki`:
|
|
```
|
|
DOKUWIKI_PATH=/srv/dokuwiki
|
|
TARBALL_URL=https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages/-/archive/1.0.0/dokuwiki-childrenpages-1.0.0.tar.gz
|
|
curl "$TARBALL_URL" > dokuwiki-childrenpages-1.0.0.tar.gz
|
|
mkdir --parents "$DOKUWIKI_PATH/lib/plugins/childrenpages"
|
|
gzip --stdout --decompress dokuwiki-childrenpages-1.0.0.tar.gz | tar xf - --strip-components=1 --directory="$DOKUWIKI_PATH/lib/plugins/childrenpages"
|
|
rm dokuwiki-childrenpages-1.0.0.tar.gz
|
|
```
|
|
|
|
### Installation using git
|
|
|
|
#### Requirements
|
|
|
|
* `git`
|
|
|
|
#### Current stable version (1.0.0)
|
|
|
|
Assuming the root directory of your DokuWiki installation is `/srv/dokuwiki`:
|
|
```
|
|
DOKUWIKI_PATH=/srv/dokuwiki
|
|
REPO_URL=https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages.git
|
|
git clone --branch 1.0.0 --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://forge.dotslashplay.it/vv221/dokuwiki-childrenpages.git
|
|
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
|
|
```
|
|
|
|
## Developers instructions
|
|
|
|
Up-to-date installation instructions for developers can be found [on the project wiki].
|
|
|
|
[on the project wiki]: https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages/-/wikis/home#installation-instructions
|
|
|
|
## Template builders instructions
|
|
|
|
Up-to-date installation instructions for template builders can be found [on the project wiki].
|
|
|
|
[on the project wiki]: https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages/-/wikis/home#manipulation-in-templates
|