plugin:twistienav
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:twistienav [2018-03-23 00:28] – 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 : 2018-03-23 | + | 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 49: | Line 48: | ||
* **startPagesOnly**: | * **startPagesOnly**: | ||
- | * **exclusions**: | + | * **exclusions**: |
* **twistieMap**: | * **twistieMap**: | ||
- | * **pageIdTrace**: | + | * **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: | ||
Line 57: | Line 56: | ||
==== PageId trace ==== | ==== PageId trace ==== | ||
- | If the corresponding | + | If **pageIdTrace** |
{{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>https://github.com/geekitude/dokuwiki-plugin-twistienav/commits/master.atom date}} | + | 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 | ||
+ | |||
+ | === Sample Results === | ||
+ | |||
+ | //Elements #0 and #1 are both sub-namespaces (note the " | ||
+ | |||
+ | == Basic (" | ||
+ | |||
+ | < | ||
+ | Array | ||
+ | ( | ||
+ | [0] => Array | ||
+ | ( | ||
+ | [id] => fr:test: | ||
+ | [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="/doku.php? | ||
+ | ) | ||
+ | |||
+ | [2] => Array | ||
+ | ( | ||
+ | [id] => fr: | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => f | ||
+ | [level] => 1 | ||
+ | [open] => 1 | ||
+ | [link] => <a href="/doku.php? | ||
+ | ) | ||
+ | ) | ||
+ | </code> | ||
+ | |||
+ | == More structures (" | ||
+ | |||
+ | < | ||
+ | Array | ||
+ | ( | ||
+ | [namespaces] => Array | ||
+ | ( | ||
+ | [0] => Array | ||
+ | ( | ||
+ | [id] => fr: | ||
+ | [ns] => fr | ||
+ | [perm] => 255 | ||
+ | [type] => d | ||
+ | [level] => 1 | ||
+ | [open] => | ||
+ | [link] => <a href="/ | ||
+ | ) | ||
+ | |||
+ | [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 === | ||
- | === Wish List === | + | {{rss> |
- | * <del>:!: support for URL re-write< | + | 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' |
< | < |
plugin/twistienav.1521761312.txt.gz · Last modified: 2018-03-23 00:28 by Geekitude