Differences

This shows you the differences between two versions of the page.

--- plugin:navbox [2018-04-09 12:58] – MidgardApps
+++ plugin:navbox [2024-01-28 22:33] (current) – Aleksandr
@@ Line 6: / Line 6: @@
 email      : hello@midgardapps.com
 type       : syntax
-lastupdate : 2018-04-08
+lastupdate : 2018-05-06
-compatible : Hrun, Detritus, Elenor of Tsort, Frusterick Manners
+compatible : Hrun, Detritus, Elenor of Tsort, Frusterick Manners, !Hogfather
 depends    :
 conflicts  :
 similar    :
-tags       : tables, navbox
+tags       : tables, mediawiki
-downloadurl: # eg. http://github.com/JovinJovinsson/dokuwiki-plugin-navbox/zipball/master
+downloadurl: https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/zipball/master
-bugtracker : # eg. http://github.com/JovinJovinsson/dokuwiki-plugin-navbox/issues
+bugtracker : https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/issues
-sourcerepo : # eg. http://github.com/JovinJovinsson/dokuwiki-plugin-navbox/
+sourcerepo : https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/
 donationurl:
-screenshot_img :
+screenshot_img : https://i.imgur.com/2nEF5xp.png
 ----
-//:!: 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/Example section for non-syntax plugins.//
 ===== Installation =====
-//[First, last and only chance to warn users before installing (some has already done that before reading this)]//
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
-:!: **External requirements:** This plugin requires the following additional components that must be installed separately:
-  * [[A banana]]
-  * [[Another banana]]
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Examples/Usage =====
-//[Most people learn by example, so this goes first]//
+See the plugin in action [[https://openwiki.midgardapps.com|here]]. FIXME
-See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin.
+===== Syntax =====
+The plugin reads each line as a new tag / parameter combination. Only insert a new line if you intend on utilising a new tag.
-A simple box:
+==== Basic Tags ====
+^ Syntax Tag               ^ Example Usage                                                 ^ Result                                                                                                                                                                                                                                    ^
+^  <code><navbox></code>   |                                                               | Initiates the NavBox Container.                                                                                                                                                                                                           |
+^  <code>#</code>          | <code># My NavBox</code>                                      | Sets the title of the NavBox, at the top.                                                                                                                                                                                                 |
+^  <code>##</code>         | <code>## Group 1 Title</code>                                 | Sets the title of a group of links, in the left column.                                                                                                                                                                                   |
+^  <code>###</code>        | <code>### SubGroup A Title</code>  or   <code>### !ns</code>  | Sets the title of a subgroup. \\ **Note:** This must follow either a Group Title Tag (##) or a list of links and must also have a list of links following (or one of the [[#Advanced Tags]]), otherwise it will not form a proper group.  |
+^  <code>[[links]]</code>  | <code>[[link1|Links]][[another|More]]</code>                  | A list of links, which can be simply listed one after the other (as per example), or separated by <code>,</code>   or    <code>;</code>                                                                                                   |
+^  <code></navbox></code>  |                                                               | The closing tag for the container.                                                                                                                                                                                                        |
-  <box> the box contents </box>
+=== Example of Basic NavBox ===
+^ Code Sample                                                                                                                                               ^ Output                               ^
+| <code> <navbox> # Animals ## Birds ### Carnivorous Birds [[falcon]],[[eagle]],[[vulture]] ### Little Birds [[hummingbird]],[[canary]] </navbox>  </code>  | {{https://i.imgur.com/H1Q6qjV.png}}  |
-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.
-  <box 80% round orange|a title> the box contents</box>
+Example:
-  <box 50% left blue>the box contents</box|a caption>
+<code>
-  <box 60% round #f99 #fc9 #fcc #f60|title>the box contents></box|caption>
+<navbox>
+# Title
+## Group 1
+[[some links]]
+!ns                <<< This creates a new Group
+## Group 3
+### SubGroup 1
+[[sub links]]
+### !ns            <<< This creates a Sub Group inside Group 3 after SubGroup 1
+</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:birds:carnivorous:start it will name the group "Carnivorous". There are various modifiers that can be used below.
+^ Modifier  ^ Example  ^ Result  |
+^  <code>###</code>  |  <code>### !ns</code>  | This is combined with the Sub Group tag, which indicates that the listing should be contained in the previously created group. This can be combined with the below modifiers as well. |
+^  <code>+n</code>  |  <code>!ns+n [[other:namespace]]</code> | This will force the plugin to list all pages contained in the specified namespace. |
+^  <code>+t</code>  |  <code>!ns+t Different Title</code> | This will override the automatically created title (or subgroup title) for the listing. |
+^  <code>+nt</code>  |  <code>!ns+nt [[other:namespace|Custom Title]]</code> | Performs both actions of the +n and +t modifiers. |
+===== 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>{{actionlink>action|title}}</code>
-  * **action** can be one of this:
-    * //edit//    --- edit/create/show
-    * //history// --- old revisions
-===== Configuration and Settings =====
-//[also CSS style tips]//
 ===== 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/issues|GitHub repository]] and I'll respond directly!
 === Change Log ===
-//[preferable GitHub RSS feed or similar]//
+{{rss>https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/commits/master.atom 10 author date}}
-  * **2009-01-01**
-    * Initial release
 === 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/issues|GitHub repository]].
 === ToDo/Wish List ===
-//[developers roadmap]//
+**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 'tags' and categorize them (Scope to be defined)
 ===== FAQ =====
-//[discussions should ideally be deleted and turned into FAQ entries along the way]//
+None yet!
 ===== 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]].