plugin:twistienav
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:twistienav [2017-03-11 03:03] – Geekitude | plugin:twistienav [2020-04-16 08:22] (current) – Geekitude | ||
---|---|---|---|
Line 4: | Line 4: | ||
description: | description: | ||
author | author | ||
- | email : simon.geekitude@gmail.com | + | email : sdelage@gmail.com |
type : Action | type : Action | ||
- | lastupdate : 2017-03-11 | + | lastupdate : 2020-04-16 |
- | compatible : Angua, Adora Belle, !2014-09-29 " | + | compatible : Angua, Adora Belle, !2014-09-29 " |
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
- | tags : navigation, menu, breadcrumb, index, breadcrumbs | + | tags : navigation, menu, breadcrumb, index |
downloadurl: | downloadurl: | ||
Line 25: | Line 25: | ||
===== Installation ===== | ===== Installation ===== | ||
- | :!: This plugin now probably requires " | + | Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. |
- | Install the plugin using the [[plugin: | ||
===== Basic Usage ===== | ===== Basic Usage ===== | ||
Line 42: | Line 41: | ||
* ['' | * ['' | ||
* ['' | * ['' | ||
- | * ['' | + | * ['' |
===== Get more ===== | ===== Get more ===== | ||
Line 48: | Line 47: | ||
==== Settings ==== | ==== Settings ==== | ||
- | * **startPagesOnly** : only add TwistieNavs to breadcrumbs leading to a namespace start page [default: enabled]. If disabled, any breadcrumb can recieve a TwistieNav (as long as it leads to a namespace containing more than excluded pages). | + | * **startPagesOnly**: |
- | * **exclusions** : only add TwistieNavs to breadcrumbs leading to namespaces containing more than any combination of selected pages. By default, both '' | + | * **exclusions**: |
- | * **twistieMap** : if enabled, TwistieNavs showing wiki home index will use a map glyph instead of default one [default: disabled]. | + | * **twistieMap**: |
- | * **pageIdTrace** : if enabled, the plugin will look for a '' | + | * **pageIdTrace**: |
* **pageIdExtraTwistie** : if enabled, the plugin will look for a '' | * **pageIdExtraTwistie** : if enabled, the plugin will look for a '' | ||
- | * **style** : choose between SVG images and Font Awesome glyphs. :!: **IMPORTANT: | + | * **style**: choose between SVG images and Font Awesome glyphs. :!: **IMPORTANT: |
==== PageId trace ==== | ==== PageId trace ==== | ||
- | If the corresponding | + | If **pageIdTrace** |
{{http:// | {{http:// | ||
Line 67: | Line 66: | ||
Latest version uses a selection of SVG images (and corresponding PNG images) from [[https:// | Latest version uses a selection of SVG images (and corresponding PNG images) from [[https:// | ||
- | The available images are : | + | The available images are: |
{{http:// | {{http:// | ||
Line 80: | Line 79: | ||
Paths to images will have to be relative to the user style file you use. | Paths to images will have to be relative to the user style file you use. | ||
- | ===== Development ===== | + | ==== Helper Component |
- | === Change Log === | + | TwistieNav now has a helper component that can be called by plugins or templates (feature added in **2019-01-24** version). |
- | :!: 2016/05/08 version prevents popups from going off-screen ([[https:// | + | === Sample Code === |
- | :!: 2016/05/03 version brings many changes | + | < |
+ | $nsindex = array(); | ||
+ | if (!plugin_isdisabled(' | ||
+ | $tnHelper = plugin_load(' | ||
+ | $nsindex = $tnHelper-> | ||
+ | } | ||
+ | </ | ||
- | {{rss> | + | Parameters are : |
+ | * @param (str) $idx : namespace ID, :!: must not be a page ID, see above how to provide correct ID | ||
+ | * @param (bool) $useexclusions : use `exclusions` setting or not | ||
+ | * @param (bool) $split : return a simple level or more complex array | ||
- | === Wish List === | + | === Sample Results |
- | * <del>:!: support for URL re-write</del> (done with 2016-05-03 version) | + | //Elements #0 and #1 are both sub-namespaces (note the " |
- | | + | |
+ | == Basic (" | ||
+ | |||
+ | <code> | ||
+ | Array | ||
+ | ( | ||
+ | [0] => Array | ||
+ | ( | ||
+ | [id] => fr:test:start | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => d | ||
+ | [level] => 1 | ||
+ | [open] => | ||
+ | [link] => <a href="/doku.php? | ||
+ | ) | ||
+ | |||
+ | [1] => Array | ||
+ | | ||
+ | [id] => fr: | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => d | ||
+ | [level] => 1 | ||
+ | [open] => | ||
+ | [link] => <a href="/ | ||
+ | | ||
+ | |||
+ | [2] => Array | ||
+ | ( | ||
+ | [id] => fr: | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => f | ||
+ | [level] => 1 | ||
+ | [open] => 1 | ||
+ | [link] => <a href="/ | ||
+ | ) | ||
+ | ) | ||
+ | </ | ||
+ | |||
+ | == More structures (" | ||
+ | |||
+ | < | ||
+ | Array | ||
+ | ( | ||
+ | | ||
+ | ( | ||
+ | | ||
+ | ( | ||
+ | [id] => fr:test:start | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => d | ||
+ | [level] => 1 | ||
+ | [open] => | ||
+ | [link] => <a href="/doku.php? | ||
+ | ) | ||
+ | |||
+ | [1] => Array | ||
+ | | ||
+ | [id] => fr: | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => d | ||
+ | [level] => 1 | ||
+ | [open] => | ||
+ | [link] => <a href="/ | ||
+ | ) | ||
+ | |||
+ | ) | ||
+ | |||
+ | [pages] => Array | ||
+ | ( | ||
+ | [0] => Array | ||
+ | ( | ||
+ | [id] => fr: | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => f | ||
+ | [level] => 1 | ||
+ | [open] => 1 | ||
+ | [link] => <a href="/ | ||
+ | ) | ||
+ | ) | ||
+ | ) | ||
+ | </ | ||
+ | |||
+ | ===== Development ===== | ||
+ | |||
+ | === Change Log === | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | See [[https:// | ||
===== FAQ ===== | ===== FAQ ===== | ||
Line 107: | Line 209: | ||
:?: I enabled '' | :?: I enabled '' | ||
- | :!: The plugin can only interfere with template' | + | :!: The plugin can only interfere with template' |
< | < | ||
:!: Currently it is, will see later if it is requested by users.</ | :!: Currently it is, will see later if it is requested by users.</ | ||
+ | |||
===== Discussion ===== | ===== Discussion ===== | ||
- | Please use [[https:// | + | Please use [[https:// |
plugin/twistienav.1489197818.txt.gz · Last modified: 2017-03-11 03:03 by Geekitude