Table of Contents
Snippeter Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" yes
- 2023-04-04 "Jack Jackrum" yes
- 2022-07-31 "Igor" yes
- 2020-07-29 "Hogfather" yes
Similar to snippets
Description
This plugin adds a new button to editor toolbar. When clicking on it a popup shows up, showing a list of page templates which can be inserted into the editor window. The list of templates is defined using a special configureable namespace which contains pages which could be used as templates.
Installation
Search and install the plugin using the Extension Manager.
Refer to Plugins on how to install plugins manually. The local plugin directory must have the same name as the plugin is named, otherwise the plugin won't work properly. It seems to be necessary in some cases to reset DokuWikis cache after the manual installation. Please reset DokuWiki's cache: either press the save button in the Configuration Manager page or touch the file conf/local.php
.
Examples/Usage
Configuration
After successful installation you will find an additional section in the wiki's Configuration Manager called “snippeter”. Within that section you can configure the namespace you want to use for your snippets.
The plugin provides a shortcut for each page created in that namespace.
Create snippets
In general you can use any wiki page placed in the namespace you configured for snippeter. To add an icon to identify the snippet within the editor toolbar, you have to add the picture you plan to use using the dokuwiki media manager right within the snippet page.
NOTE: Snippeter only supports PNG (.png) files in the current version. This might be changed in the future. Please refresh dokuwiki's cache to see your new icon! (touch the file conf/local.php)
Valid Example:
{{ :snippets:phone16.png |}} ==== Call: <project> - <description> ==== {{tag>}} * **Person:** * **Time:** **Notes** * ----
Usage
Snippeter create a shortcut within the default editor toolbar (the “+” icon). This icon will open up an overview of your snippets. Choosing one of them with a click on the related icon will insert your snippet without the media manager information for the icon on the current cursor position within your open wiki page.
Development
Changelog
A complete changelog is available here.
- Merge pull request #8 from dokupendium/master (2024-02-18 20:47)
- Update plugin.info.txt (2024-02-18 20:19)
- Merge pull request #7 from fabienli/fr (2024-02-13 21:40)
- Merge pull request #6 from fabienli/templating (2024-02-13 21:39)
- fix lang variable (2024-02-10 08:21)
- fr translation (2024-02-10 08:15)
- Update README.md (2024-02-10 08:11)
- templating in snippet (2024-02-10 08:05)
FAQ
I added a customized icon for my snipped, but snippeter still provide the default one in the toolbar.
Please reset DokuWikis cache while touch the file conf/local.php or press the save button within the Configuration Manager page.