Differences

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

--- plugin:navbox [2018-04-09 17:02] – [Examples/Usage] 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: http://github.com/JovinJovinsson/dokuwiki-plugin-navbox/zipball/master
+downloadurl: https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/zipball/master
-bugtracker : http://github.com/JovinJovinsson/dokuwiki-plugin-navbox/issues
+bugtracker : https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/issues
-sourcerepo : http://github.com/JovinJovinsson/dokuwiki-plugin-navbox/
+sourcerepo : https://github.com/JovinJovinsson/dokuwiki-plugin-navbox/
 donationurl:
@@ Line 23: / Line 23: @@
 ===== Installation =====
-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.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Examples/Usage =====
-See the plugin in action [[https://openwiki.midgardapps.com|here]].
+See the plugin in action [[https://openwiki.midgardapps.com|here]]. FIXME
-Using the basic syntax:
+===== 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.
-  <navbox>
+==== Basic Tags ====
-  nb-title The NavBox Title
+^ Syntax Tag               ^ Example Usage                                                 ^ Result                                                                                                                                                                                                                                    ^
-  nbg-title Group 1
+^  <code><navbox></code>   |                                                               | Initiates the NavBox Container.                                                                                                                                                                                                           |
-  nbg-items [[link1|Some text]][[link2]][[https://openwiki.midgardapps.com|External Link]]
+^  <code>#</code>          | <code># My NavBox</code>                                      | Sets the title of the NavBox, at the top.                                                                                                                                                                                                 |
-  </navbox>
+^  <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.                                                                                                                                                                                                        |
-===== Syntax =====
+=== 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}}  |
-//[Complete syntax]//
+==== 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.
-Basic syntax:
-<code>{{actionlink>action|title}}</code>
-  * **action** can be one of this:
-    * //edit//    --- edit/create/show
-    * //history// --- old revisions
+Example:
+<code>
+<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 =====
-//[also CSS style tips]//
+There are no configuration or settings options available at this time.
+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.
 ===== 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]].