plugin:navbox
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:navbox [2018-04-08 03:57] – MidgardApps | plugin:navbox [2024-01-28 22:33] (current) – Aleksandr | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
author | author | ||
email : hello@midgardapps.com | email : hello@midgardapps.com | ||
type : syntax | type : syntax | ||
- | lastupdate : 2018-04-08 | + | lastupdate : 2018-05-06 |
- | compatible : | + | compatible : Hrun, Detritus, Elenor of Tsort, Frusterick Manners, !Hogfather |
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
- | tags : | + | tags : |
- | downloadurl: | + | downloadurl: |
- | bugtracker : # eg. http:// | + | bugtracker : https:// |
- | sourcerepo : # eg. http:// | + | sourcerepo : https:// |
donationurl: | donationurl: | ||
- | screenshot_img : | + | screenshot_img : https:// |
---- | ---- | ||
- | |||
- | //:!: This template contains various hints on how to fill in data (formatted in italics). Be sure to remove the hints and unwanted sections (Eg. the Syntax/ | ||
===== Installation ===== | ===== Installation ===== | ||
- | //[First, last and only chance to warn users before installing (some has already done that before reading this)]// | + | Search |
- | + | ||
- | :!: **External requirements: | + | |
- | * [[A banana]] | + | |
- | * [[Another banana]] | + | |
- | + | ||
- | Install | + | |
===== Examples/ | ===== Examples/ | ||
- | //[Most people learn by example, so this goes first]// | + | See the plugin in action |
- | See the plugin | + | ===== Syntax ===== |
+ | The plugin | ||
- | A simple box: | + | ==== Basic Tags ==== |
+ | ^ Syntax Tag ^ Example Usage ^ Result | ||
+ | ^ < | ||
+ | ^ < | ||
+ | ^ < | ||
+ | ^ < | ||
+ | ^ < | ||
+ | ^ < | ||
- | | + | === Example of Basic NavBox === |
+ | ^ Code Sample | ||
+ | | <code> < | ||
- | Some more complex boxes | + | ==== Advanced Tags ==== |
+ | Using an advanced tag will create it's own Group (equivalent of the ## tag) unless it is specified as a Sub Group (preceeded by the ### tag). It will close the previously created group, and after the Advanced Tag a new group will need to be created for further links. | ||
- | | + | Example: |
- | <box 50% left blue>the box contents</box|a caption> | + | <code> |
- | <box 60% round #f99 #fc9 #fcc #f60|title> | + | < |
+ | # Title | ||
+ | ## Group 1 | ||
+ | [[some links]] | ||
+ | !ns <<< | ||
+ | ## Group 3 | ||
+ | ### SubGroup 1 | ||
+ | [[sub links]] | ||
+ | ### !ns <<< | ||
+ | </navbox> | ||
+ | </code> | ||
+ | === Namespace Tag (!ns) === | ||
+ | Creates a list of links in the current namespace, automatically creates the group name based on the lowest level of the current namespace. For example, if you are building the NavBox on animals: | ||
+ | ^ Modifier | ||
+ | ^ <code>###</code> | ||
+ | ^ <code>+n</ | ||
+ | ^ <code>+t</code> | ||
+ | ^ < | ||
+ | ===== Configuration and Settings ===== | ||
- | //[Pictures showing the rendered result will help users to understand]// | + | There are no configuration or settings options available at this time. |
- | ===== Syntax ===== | + | If you use user stylings you can override any element in the CSS code to provide different colours, fonts or sizes. You can view the CSS code on the GitHub page linked above. |
- | + | ||
- | //[Complete syntax]// | + | |
- | + | ||
- | Basic syntax: | + | |
- | <code> | + | |
- | * **action** | + | |
- | * // | + | |
- | * //history// --- old revisions | + | |
- | + | ||
- | ===== Configuration and Settings ===== | + | |
- | + | ||
- | // | + | |
===== Development ===== | ===== Development ===== | ||
- | //[downloadable blocks, development comments]// | + | Ongoing development is always happening in this repository. If you have any issues or requests please log them against the [[https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/ |
=== Change Log === | === Change Log === | ||
- | //[preferable GitHub RSS feed or similar]// | + | {{rss> |
- | + | ||
- | * **2009-01-01** | + | |
- | * Initial release | + | |
=== Known Bugs and Issues === | === Known Bugs and Issues === | ||
- | //[this section might not be needed in case of external bug manager, or use RSS feed]// | + | All bugs & issues are being tracked in the [[https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/ |
=== ToDo/Wish List === | === ToDo/Wish List === | ||
- | // | + | **Up Next** |
+ | * Table background colour parameter | ||
+ | * Table width parameter | ||
+ | * Image column (similar to Wikipedia screenshot at the top of the page) | ||
+ | |||
+ | **Soon** | ||
+ | * Automatic population of current hierarchy of page/namespaces | ||
+ | |||
+ | **Long Term** | ||
+ | * Discovery of pages with shared ' | ||
===== FAQ ===== | ===== FAQ ===== | ||
- | // | + | None yet! |
===== Discussion ===== | ===== Discussion ===== | ||
- | //Could be placed on an external page (e.g. plugin:pluginname:discussion) to have a distinction between user comments and author docs// | + | Please log any discussion points [[plugin:navbox:discussion|here]]. |
- | + | ||
plugin/navbox.1523152637.txt.gz · Last modified: 2018-04-08 03:57 by MidgardApps