Table of Contents

Documentation Includer Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" yes
  • 2023-04-04 "Jack Jackrum" unknown
  • 2022-07-31 "Igor" unknown
  • 2020-07-29 "Hogfather" unknown

plugin Includes documentation pages for templates (template:doc) into a documentation template or the template page itself.

Last updated on
2024-06-01
Provides
Syntax
Repository
Source
Requires
wst

Similar to include

Tagged with documentation, include, template

Installation

:!: External requirements: This plugin requires the following additional components that must be installed separately:

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Examples/Usage

See the plugin in action here.
:!: Warning: The website linked above (Lemming DokuWiki) might not be active 24/7! This will be fixed soon.
A basic example:

<noinclude>
~~DOC~~
</noinclude>

You can also embed it into a separate template, presumably named “documentation” or “doc” for short, like this:
The documentation template (Note that this example uses the var plugin):

===== Template documentation =====
~~DOC~~
This documentation was transcluded from (your namespace for template documentation, e. g. "template:doc:", which is used here) template:doc:@PAGE@

Then, add the newly made template into your template page like this:

<noinclude>
{{wst>documentation}}
</noinclude>

Of course, you can do it however you like to.

Syntax

~~DOC~~

Configuration and Settings

Development

The source code of the plugin is available at GitHub: https://github.com/Lemming789TT/docincluder.

Changelog

ToDo/Wish List

  1. Links to the documentation page, e. g. view, edit and see the history of the documentation page.

Known Bugs and Glitches

FAQ

Will the plugin work with the templater plugin?

This plugin is only compatible with wst for templates, as templater doesn't have the <noinclude> and <includeonly> tags, like wst does.