DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:navbox

NavBox Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" unknown
  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes

plugin NavBox brings the core functionality of the NavBox from Wikipedia (and MediaWiki) across to DokuWiki, allowing a clean and easy-to-use way of linking between related pages. It can be placed anywhere on the page at this point in time but it is intended to be displayed at the bottom of a page.

Last updated on
2018-05-06
Provides
Syntax
Repository
Source

Tagged with navbox, tables

Installation

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.

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.

Basic Tags

Syntax Tag Example Usage Result
<navbox>
Initiates the NavBox Container.
#
# My NavBox
Sets the title of the NavBox, at the top.
##
## Group 1 Title
Sets the title of a group of links, in the left column.
###
### SubGroup A Title

or

### !ns
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.
[[links]]
[[link1|Links]][[another|More]]
A list of links, which can be simply listed one after the other (as per example), or separated by
,

or

;
</navbox>
The closing tag for the container.

Example of Basic NavBox

Code Sample Output
<navbox>
# Animals
## Birds
### Carnivorous Birds
[[falcon]],[[eagle]],[[vulture]]
### Little Birds
[[hummingbird]],[[canary]]
</navbox>

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:

<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>

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
###
### !ns
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.
+n
!ns+n [[other:namespace]]
This will force the plugin to list all pages contained in the specified namespace.
+t
!ns+t Different Title
This will override the automatically created title (or subgroup title) for the listing.
+nt
!ns+nt [[other:namespace|Custom Title]]
Performs both actions of the +n and +t modifiers.

Configuration and Settings

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

Ongoing development is always happening in this repository. If you have any issues or requests please log them against the GitHub repository and I'll respond directly!

Change Log

Known Bugs and Issues

All bugs & issues are being tracked in the GitHub repository.

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 'tags' and categorize them (Scope to be defined)

FAQ

None yet!

Discussion

Please log any discussion points here.

plugin/navbox.txt · Last modified: 2018-05-28 21:33 by Klap-in