dokuwiki-plugin-childrenpages/README.md

# 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

### Installation using archives

#### Requirements

* `curl`
* `tar`
* `gzip`

#### Current stable version (1.1.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.1.0.tar.gz
curl "$TARBALL_URL" > dokuwiki-childrenpages-1.1.0.tar.gz
mkdir --parents "$DOKUWIKI_PATH/lib/plugins/childrenpages"
gzip --stdout --decompress dokuwiki-childrenpages-1.1.0.tar.gz | tar xf - --strip-components=1 --directory="$DOKUWIKI_PATH/lib/plugins/childrenpages"
rm dokuwiki-childrenpages-1.1.0.tar.gz
```

#### Latest development version

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/master/dokuwiki-childrenpages-master.tar.gz
curl "$TARBALL_URL" > dokuwiki-childrenpages-master.tar.gz
mkdir --parents "$DOKUWIKI_PATH/lib/plugins/childrenpages"
gzip --stdout --decompress dokuwiki-childrenpages-master.tar.gz | tar xf - --strip-components=1 --directory="$DOKUWIKI_PATH/lib/plugins/childrenpages"
rm dokuwiki-childrenpages-master.tar.gz
```

### Installation using git

#### Requirements

* `git`

#### Current stable version (1.1.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.1.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
```

## 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