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
Includes documentation pages for templates (template:doc) into a documentation template or the template page itself.
Similar to include
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
namespace
: Namespace for documentation pages (default: “template:doc:”)- Besides English, the description of the settings were translated into 2 more languages: French & Japanese
Development
The source code of the plugin is available at GitHub: https://github.com/Lemming789TT/docincluder.
Changelog
- Updated plugin info (2024-06-01 06:52)
- Fixed bug where the missing template info wouldn't show (2024-06-01 06:51)
- Updated syntax.php (2024-05-31 14:22)
- Updated plugin info (2024-05-31 14:20)
- Created lang.php in Japanese (2024-05-31 14:17)
- Created lang.php in French (2024-05-31 14:10)
- Created lang.php for English (2024-05-31 14:04)
- Created settings in Japanese (2024-05-18 10:58)
ToDo/Wish List
- Links to the documentation page, e. g. view, edit and see the history of the documentation page.
Known Bugs and Glitches
- The link to create the documentation page redirects instead to a page of a variable name in the code.