plugin:indexmenu
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:indexmenu [2017-11-28 01:38] – 103.4.236.13 | plugin:indexmenu [2024-02-08 00:38] (current) – Klap-in | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : samuele@samuele.netsons.org | email : samuele@samuele.netsons.org | ||
type : syntax, | type : syntax, | ||
- | lastupdate : 2015-08-26 | + | lastupdate : 2024-01-05 |
- | compatible : rincewind, angua, adora belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor Of Tsort, Frusterick Manners | + | compatible : !Greebo, !Hogfather, Igor, Jack Jackrum, Kaos |
depends | depends | ||
conflicts | conflicts | ||
- | similar | + | similar |
- | tags : navigation, menu, listing, namespace, ajax, index | + | tags : navigation, menu, listing, namespace, index |
sourcerepo : https:// | sourcerepo : https:// | ||
Line 19: | Line 19: | ||
---- | ---- | ||
- | This [[plugin]] allows you to insert a fully customizable index or a list of pages starting from a specified namespace. | + | ^ :!: Since December 2023 two JavaScript trees are available for Indexmenu' |
+ | |||
+ | ===== Description ===== | ||
+ | |||
+ | This plugin | ||
It should be useful in DokuWiki sites where pages are organized by [[: | It should be useful in DokuWiki sites where pages are organized by [[: | ||
Main features are: | Main features are: | ||
Line 48: | Line 52: | ||
The indexmenu plugin is not sponsored by anyone but I develop and support it for free during my spare time. | The indexmenu plugin is not sponsored by anyone but I develop and support it for free during my spare time. | ||
- | If want to offer me a friendly beer (({{http://www.enjoytoz.it/images/uploads/Auld_Dubliner/tennents.jpg?60}})), you can consider to make a [[http:// | + | If you want to offer me a friendly beer (({{https://upload.wikimedia.org/wikipedia/commons/thumb/8/ |
====Examples: | ====Examples: | ||
|Root namespace. Expands all |'' | |Root namespace. Expands all |'' | ||
+ | |Current namespace. Expands all |'' | ||
|Current namespace. Show only current level, don't expand any nodes. |'' | |Current namespace. Show only current level, don't expand any nodes. |'' | ||
|Parent namespace. Show parent namespace (" | |Parent namespace. Show parent namespace (" | ||
Line 59: | Line 64: | ||
====== Syntax ====== | ====== Syntax ====== | ||
- | Basic syntax usage: | + | **Basic syntax usage:** |
^ Main ^ Options | ^ Main ^ Options | ||
Line 66: | Line 71: | ||
:!: All the syntax options can be easily accessed with the indexmenu picker in the [[:edit window]] [[: | :!: All the syntax options can be easily accessed with the indexmenu picker in the [[:edit window]] [[: | ||
+ | |||
+ | |||
+ | **Minimum syntax: | ||
+ | |||
+ | '' | ||
+ | That means this '' | ||
Line 72: | Line 83: | ||
Settings **before the " | Settings **before the " | ||
^Main ^Action ^Note| | ^Main ^Action ^Note| | ||
- | ^ //'' | + | ^ //'' |
^ //''# | ^ //''# | ||
- | ^ //'' | + | ^ //'' |
- | Optional settings **after the " | + | Optional settings **after the " |
^Option ^Action ^Note| | ^Option ^Action ^Note| | ||
^ '' | ^ '' | ||
Line 87: | Line 98: | ||
^ '' | ^ '' | ||
^ '' | ^ '' | ||
- | ^ '' | + | ^ '' |
- | ^ '' | + | ^ '' |
+ | ^ '' | ||
^ '' | ^ '' | ||
^ '' | ^ '' | ||
^ '' | ^ '' | ||
^ '' | ^ '' | ||
- | | Next options are //only// available with //**js**// option. ||| | + | | Next options are //only// available with //**js**// option |
^ '' | ^ '' | ||
^ '' | ^ '' | ||
Line 101: | Line 113: | ||
^ '' | ^ '' | ||
^ '' | ^ '' | ||
+ | | \\ Next options are //only// available with //**js**// option -- with '' | ||
+ | ^ '' | ||
+ | |||
+ | ===== Temporary multiple js trees ===== | ||
+ | The js option uses so far the JavaScript [[http:// | ||
+ | |||
+ | To replace it, the JavaScript [[https:// | ||
===== Examples ===== | ===== Examples ===== | ||
- | A sample of an indexmenu JS index that could be used inside a navigation sidebar. Its initial status is blocked by the nocookie option, so, when the page is reloaded, it doesn' | + | A sample of an indexmenu JS index that could be used inside a navigation sidebar. Its initial status is blocked by the nocookie option, so, when the page is reloaded, it doesn' |
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
JS navigation index with " | JS navigation index with " | ||
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
Line 120: | Line 139: | ||
</ | </ | ||
- | Js tree showing pages and namespaces both sorted by reverse title. For example,if " | + | JS tree showing pages and namespaces both sorted by reverse title. For example, if " |
< | < | ||
{{indexmenu>: | {{indexmenu>: | ||
</ | </ | ||
- | Standard index showing the tree of the current context ((the namespace of the page displayed by a user who is navigating your site)) opened at the second level . | + | Standard index showing the tree of the current context((the namespace of the page displayed by a user who is navigating your site)) opened at the second level. |
< | < | ||
{{indexmenu> | {{indexmenu> | ||
</ | </ | ||
- | Show all current namespace pages . | + | Show all current namespace pages. |
< | < | ||
{{indexmenu> | {{indexmenu> | ||
Line 168: | Line 187: | ||
in this way: | in this way: | ||
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
< | < | ||
Line 182: | Line 201: | ||
Pages without sort number, like the last three pages, are sorted by page name as default, but you can force a different sort: | Pages without sort number, like the last three pages, are sorted by page name as default, but you can force a different sort: | ||
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
< | < | ||
Line 256: | Line 275: | ||
Set this option with a DokuWiki page ID (i.e: '' | Set this option with a DokuWiki page ID (i.e: '' | ||
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
or | or | ||
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
You may also want to hide this page in any indexmenu trees with the [[.: | You may also want to hide this page in any indexmenu trees with the [[.: | ||
Line 312: | Line 331: | ||
====== How to install ====== | ====== How to install ====== | ||
- | Search and install | + | Search and install |
Alternative download link: http:// | Alternative download link: http:// | ||
Line 328: | Line 347: | ||
==== Github changelog ==== | ==== Github changelog ==== | ||
- | {{rss> | + | {{rss> |
- | |||
- | ==== Release changelog ==== | ||
- | |||
- | * **2014-08-01** | ||
- | * Default options can be configured in Config Manager for whole wiki | ||
- | * Supports nolatin pagenames better | ||
- | * remove more empty nodes (only with indexmenu indexer, which is used when one of sort options added) | ||
- | * contextmenu can be translated as well | ||
- | |||
- | * **2013-04-24 Version 5.0**: | ||
- | * Reformat of all code to Dokuwiki code style | ||
- | * Rewrite all javascript to jQuery instead of old js api (includes improvements from [[tindexmenu]] plugin) | ||
- | * Added a new toolbar wizard | ||
- | * Used Dokuwikis javascript include mechanism | ||
- | * add '' | ||
- | * Rewrite the ajax stuff into action plugin (not theme handling stuff) | ||
- | * Change configuration via menu js files to one file. | ||
- | * add option '' | ||
- | * Improved support for [[config: | ||
- | * Added syntax option to add '' | ||
- | * Adding curid span like DokuWiki performs on internal links. | ||
- | * Fixed: When only had indexmenu syntax in sidebar, in js rendered index the backup index wasn't hidden. | ||
- | * Fixed: Ajax completion supports Korean characters too. - by [[user> | ||
- | |||
- | * **2009-08-29 Version 4.6**: | ||
- | * :!: //New Feature//: Namespace declaration complies with DokuWiki [[: | ||
- | * //New Feature//: Added the //context// option. It resolves relative requested namespaces starting from the current user location instead of the page containing the indexmenu syntax. | ||
- | * :!: //New Feature//: Changed skip_file and skip_index syntax to use DokuWiki ID instead of system paths. Thanks to Dmitry Katsubo. | ||
- | * //New Feature//: Metatada titles are not rendered when recursively building the indexmenu tree. This will speed up the page loading when cache expires, but could not display the heading title for nodes without metadata information. | ||
- | * //New Feature//: Added the nojs button in the edit toolbar and toolbar CSS classes. | ||
- | * //New Feature//: The right JS context menu is closed by any document click. Thanks to Urban. | ||
- | * //Bug//: Fixed a bug which prevents page caching when it contains only indexmenu syntax. | ||
- | * //Bug//: Disable JS indexmenu cookies in preview mode. | ||
- | * //Bug//: Fixed an ACL issue. | ||
- | * //Bug//: Fixed UTF8 TOC preview bug. | ||
Line 383: | Line 367: | ||
When the '' | When the '' | ||
- | Inside | + | The indexmenu has already a couple of themes included. Adding another theme is simply as adding another folder with the theme name filled with the relevant files. (As long as it is still available |
- | + | ||
- | Instead of installing you can also simply download a theme into your PC with the '' | + | |
The JavaScript tree menu is based on [[http:// | The JavaScript tree menu is based on [[http:// | ||
Line 414: | Line 396: | ||
Use your theme with **'' | Use your theme with **'' | ||
- | You can also customize a theme style further by creating its [[.:indexmenu#Custom theme CSS style|own css style]] as '' | + | You can also customize a theme style further by creating its [[#Custom theme CSS style|own css style]] as '' |
The default icons file format is GIF, but PNG and JPG are also supported. To use them in place of GIF, you have to name your theme directory with the appropriate image extension. For example: '' | The default icons file format is GIF, but PNG and JPG are also supported. To use them in place of GIF, you have to name your theme directory with the appropriate image extension. For example: '' | ||
Line 524: | Line 506: | ||
- To have the last indexmenu version installed. For example check that its date is the same of [[.: | - To have the last indexmenu version installed. For example check that its date is the same of [[.: | ||
- To have used a correct [[.: | - To have used a correct [[.: | ||
+ | - To have purged CSS and JavaScript and more as cached by DokuWiki. Go to the [[plugin: | ||
- To have purged your browser cache. Use '' | - To have purged your browser cache. Use '' | ||
- | - To have purged server cache following the [[: | ||
- | - To have purged CSS and JavaScript as cached by DokuWiki. Go to the Configuration Manager and just resave, to refresh this caching. | ||
- When you try the javascript version of the indexmenu and it fails, please disable all the self-installed plugins check if now works. Nextly, you enable the plugins one-by-one to find the bad one. | - When you try the javascript version of the indexmenu and it fails, please disable all the self-installed plugins check if now works. Nextly, you enable the plugins one-by-one to find the bad one. | ||
If problem still persists, please, report the bug with details of your configuration in [[.: | If problem still persists, please, report the bug with details of your configuration in [[.: | ||
+ | ==== I see nothing in sidebar when I login like user ==== | ||
+ | Check your ACL settings, please note that the user needs at least READ permissions to the page " | ||
==== DokuWiki is getting slow ==== | ==== DokuWiki is getting slow ==== | ||
Line 544: | Line 527: | ||
I have in my sidebar the following code | I have in my sidebar the following code | ||
< | < | ||
- | {{indexmenu> | + | {{indexmenu> |
</ | </ | ||
Line 556: | Line 539: | ||
> When you have a sidebar defined a sidebar, but it is used as normal page too e.g. an index page, it is recommended to create a separate page for the index page. A separate page prevents displaying same index twice so they can not conflict anymore. The index page may have the same syntax options as the sidebar, but when you use id with a self defined id# | > When you have a sidebar defined a sidebar, but it is used as normal page too e.g. an index page, it is recommended to create a separate page for the index page. A separate page prevents displaying same index twice so they can not conflict anymore. The index page may have the same syntax options as the sidebar, but when you use id with a self defined id# | ||
+ | >> A workaround to get rid of the warning message, is to use the [[: | ||
==== Can I sort the tree nodes (filename or page heading or creation time)? ==== | ==== Can I sort the tree nodes (filename or page heading or creation time)? ==== | ||
Line 591: | Line 575: | ||
You could need a browser cache purging. | You could need a browser cache purging. | ||
+ | The name of the graphic is no longer '' | ||
+ | To ensure that the changes are not lost during an update, it is better to make an entry in ''/ | ||
+ | For example, the graphic disappears as follows: | ||
+ | '' | ||
+ | Or you can insert another graphic as follows: | ||
+ | '' | ||
==== About ACLs ==== | ==== About ACLs ==== | ||
Line 665: | Line 654: | ||
==== I'm using " | ==== I'm using " | ||
- | The text used for the nodes in the tree is retrieved from DokuWiki' | + | The text used for the nodes in the tree is retrieved from DokuWiki' |
plugin/indexmenu.1511829538.txt.gz · Last modified: 2017-11-28 01:38 by 103.4.236.13