差别

这里会显示出您选择的修订版和当前版本之间的差别。

--- wiki:插件语法:indexmenu [2026/10/15 06:59] – 外部编辑 127.0.0.1
+++ wiki:插件语法:indexmenu [2026/10/15 21:29] (当前版本) – 外部编辑 127.0.0.1
@@ 行 17: / 行 17: @@
 donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=102873
 ---
-^ :!: If you use the Indexmenu's option 'js' in the Hogfather release (June 2020+), you have to disable the [defer_js feature flag](config:defer_js). The indexmenu plugin does not support deferred javascript loading at the moment.\\ \\ Work-in-progress: [issue #230](https://github.com/samuelet/indexmenu/issues/230)  ^
+^ :!: If you use the Indexmenu's option 'js' in the Hogfather release (June 2020+), you have to disable the [defer_js feature flag](config:defer_js). The indexmenu plugin does not support deferred javascript loading at the moment.    Work-in-progress: [issue #230](https://github.com/samuelet/indexmenu/issues/230)  ^
 This plugin allows you to insert a fully customizable index or a list of pages starting from a specified namespace.
@@ 行 33: / 行 33: @@
   * Hide namespaces/pages according to [ACLs](ACLs) and plugin [settings](.indexmenu#skip_index).
-Themed indexmenu based on the Javascript index builder:\\
+Themed indexmenu based on the Javascript index builder:\
-![indexmenu1.jpg](http://samuele.netsons.org/dokuwiki/media/indexmenu1.jpg)\\
+![indexmenu1.jpg](http://samuele.netsons.org/dokuwiki/media/indexmenu1.jpg)\
-Indexmenu based on Dokuwikis index builder:\\
+Indexmenu based on Dokuwikis index builder:\
 ![indexmenu2.jpg](http://samuele.netsons.org/dokuwiki/media/indexmenu2.jpg)
@@ 行 55: / 行 55: @@
 | Current namespace. Show only current level, don't expand any nodes. | `%%{{indexmenu>.#1}}%%` |
 | Parent namespace. Show parent namespace ("uplink") and current level, don't expand any nodes. | `%%{{indexmenu>..:#1}}%%` |
-| `wiki` namespace, expand containing namespaces, not subnamespaces.\\ Using the themed Javascript indexmenu. | `%%{{indexmenu>:wiki#1\|js}}%%` |
+| `wiki` namespace, expand containing namespaces, not subnamespaces.  Using the themed Javascript indexmenu. | `%%{{indexmenu>:wiki#1\|js}}%%` |
@@ 行 91: / 行 91: @@
 | Option | Action | Note |
 | --- | --- | --- |
-| `js` \\ undo: `nojs` | JavaScript render method: the index is an expandable tree menu. Without the `js` option DokuWikis index renderer is used | Without _**n**_, all nodes are open, with it, nodes are open till _**n**_ level. |
+| `js`   undo: `nojs` | JavaScript render method: the index is an expandable tree menu. Without the `js` option DokuWikis index renderer is used | Without _**n**_, all nodes are open, with it, nodes are open till _**n**_ level. |
-| _`#theme`_ \\ undo: `#default` | Theme name for indexmenu icons | A theme is a set of icons inside `_images_` directory as described in [Theme tutorial](.:indexmenu#Theme tutorial). Admins can download and share themes in admin panel. It works only in _**js**_ e.g. _**js#tango**_ |
+| _`#theme`_   undo: `#default` | Theme name for indexmenu icons | A theme is a set of icons inside `_images_` directory as described in [Theme tutorial](.:indexmenu#Theme tutorial). Admins can download and share themes in admin panel. It works only in _**js**_ e.g. _**js#tango**_ |
 | Next options are available with or without _**js**_ option. |  | |
-| `navbar` \\ undo: `nonavbar` | The tree opens itself automatically at the current page namespace. Useful in a navigation sidebar. | Without _**js**_ option, the indexmenu page is never cached (just like the default DokuWiki index page) and the DokuWiki loading could be slower depending on the amount of child nodes displayed. |
+| `navbar`   undo: `nonavbar` | The tree opens itself automatically at the current page namespace. Useful in a navigation sidebar. | Without _**js**_ option, the indexmenu page is never cached (just like the default DokuWiki index page) and the DokuWiki loading could be slower depending on the amount of child nodes displayed. |
-| `context`  \\ undo: `nocontext` | [Relative](namespaces#creating namespaces) _**main namespace**_ and _**optional namespaces**_ will refer to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) instead of to the namespace of the page containing the indexmenu syntax. Useful in a navigation sidebar. | The indexmenu page is now never cached so the DokuWiki loading could be slower depending on the amount of child nodes displayed (In _**js**_ mode, when a lot of nodes are usually displayed, the _`max`_ option is recommended). It automatically enable the _**nocookie**_ option. |
+| `context`    undo: `nocontext` | [Relative](namespaces#creating namespaces) _**main namespace**_ and _**optional namespaces**_ will refer to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) instead of to the namespace of the page containing the indexmenu syntax. Useful in a navigation sidebar. | The indexmenu page is now never cached so the DokuWiki loading could be slower depending on the amount of child nodes displayed (In _**js**_ mode, when a lot of nodes are usually displayed, the _`max`_ option is recommended). It automatically enable the _**nocookie**_ option. |
-| `tsort`   \\ undo: `notsort` | Sort (only) pages by title. | Useful when [useheading](config:useheading) is on. By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
+| `tsort`     undo: `notsort` | Sort (only) pages by title. | Useful when [useheading](config:useheading) is on. By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
-| `dsort`   \\ undo: `nodsort` | Sort (only) pages by date creation (first the oldest). | By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
+| `dsort`     undo: `nodsort` | Sort (only) pages by date creation (first the oldest). | By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
-| `msort[#meta]`   \\ undo: `nomsort` | Sort (only) pages by a custom [metadata](devel:metadata) information. Without the `#meta` parameter, i.e. `msort`, it looks for the custom sorting number specified with the `%%{{indexmenu_n>N}}%%` syntax  (see the below [metadata tag syntax](.indexmenu#metadata tag syntax)).\\ With `#meta` parameter you can refer to the [meta data structure](devel:metadata#data structure) (Array values are managed through the ":" separator, for example: `msort#date:modified`). | By default, pages without metadata tag are sorted by page name (the default DokuWiki way), but you can override this behaviour adding also the tsort or dsort option in the indexmenu syntax. By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
+| `msort[#meta]`     undo: `nomsort` | Sort (only) pages by a custom [metadata](devel:metadata) information. Without the `#meta` parameter, i.e. `msort`, it looks for the custom sorting number specified with the `%%{{indexmenu_n>N}}%%` syntax  (see the below [metadata tag syntax](.indexmenu#metadata tag syntax)).  With `#meta` parameter you can refer to the [meta data structure](devel:metadata#data structure) (Array values are managed through the ":" separator, for example: `msort#date:modified`). | By default, pages without metadata tag are sorted by page name (the default DokuWiki way), but you can override this behaviour adding also the tsort or dsort option in the indexmenu syntax. By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
-| `hsort`   \\ undo: `nohsort` | Sort the headpages as defined by config setting [startpage](config:startpage) to the top | msort overrules hsort |
+| `hsort`     undo: `nohsort` | Sort the headpages as defined by config setting [startpage](config:startpage) to the top | msort overrules hsort |
-| `rsort`   \\ undo: `norsort` | Reverse the sorting of pages (change between ascending and descending). | By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
+| `rsort`     undo: `norsort` | Reverse the sorting of pages (change between ascending and descending). | By default namespaces are **not** sorted, you need the **_nsort_** option for this. |
-| `nsort`   \\ undo: `nonsort` | Also sort namespaces according to page sort options but grouped separately. | To use in _addition_ to the above sort options. tsort, dsort, msort, hsort apply only for namespaces when using [headpages](#namespaces_title_and_link_headpages). rsort is applicable always together with nsort. |
+| `nsort`     undo: `nonsort` | Also sort namespaces according to page sort options but grouped separately. | To use in _addition_ to the above sort options. tsort, dsort, msort, hsort apply only for namespaces when using [headpages](#namespaces_title_and_link_headpages). rsort is applicable always together with nsort. |
-| `nons`   \\ undo: `ns` | Exclude namespaces nodes from index. It shows only the pages. | Without **_js_**, the closing **_n_** namespace option prevents to display nodes below the **_n_** namespace level. |
+| `nons`     undo: `ns` | Exclude namespaces nodes from index. It shows only the pages. | Without **_js_**, the closing **_n_** namespace option prevents to display nodes below the **_n_** namespace level. |
-| `nopg`  \\ undo: `pg` | Exclude pages nodes from index. It shows only the namespaces. | All namespace nodes will link to the start pages (as defined by [startpage](config:startpage) setting) |
+| `nopg`    undo: `pg` | Exclude pages nodes from index. It shows only the namespaces. | All namespace nodes will link to the start pages (as defined by [startpage](config:startpage) setting) |
 | `skipfile[+\|=]/regexp/` | Skip files matching the regexp. | `skipfile**+**/../` skips files defined with this regexp additional to [global skip](#skip_files_in_index) config. `skipfile**=**/../` replace the global skip config with regexp from this syntax. See the global config explanation for some regexp [examples](#skip_namespaces_in_index). |
 | `skipns[+\|=]/regexp/` | Skip namespaces matching the regexp. | Just like skipfile, but [namespaces](#skip_namespaces_in_index). |
 | Next options are _only_ available with _**js**_ option. |  | |
-| `max#n`*`[#m]`* \\ undo: `nomax` | If initially closed, the node at _**n**_ level will retrieve all its child nodes through the AJAX mechanism when opened for the first time. Optionally, the nodes after the _**n**_ level can be retrieved with AJAX every _**m**_ sublevels instead of in one go. | It affects the server loading and speeds up the loading of pages in DokuWiki with an high amount of pages. It works only in _**js**_. Cookie are automatically disabled, just like with _**nocookie**_. |
+| `max#n`*`[#m]`*   undo: `nomax` | If initially closed, the node at _**n**_ level will retrieve all its child nodes through the AJAX mechanism when opened for the first time. Optionally, the nodes after the _**n**_ level can be retrieved with AJAX every _**m**_ sublevels instead of in one go. | It affects the server loading and speeds up the loading of pages in DokuWiki with an high amount of pages. It works only in _**js**_. Cookie are automatically disabled, just like with _**nocookie**_. |
-| `maxjs#_n_`  \\ undo: `nomaxjs` | It sets how many js tree levels to render when page loads. Remaining nodes are rendered (slightly slower) only when they are open by users, by  _**optional namespaces**_ option, by cookies or by _**navbar**_ option. | Default _**n**_ is 1 so that it will speed up the page loading, above all with an high amount of pages. It affects only the user-client CPU speed, not the webserver load. It works only in _**js**_ |
+| `maxjs#_n_`    undo: `nomaxjs` | It sets how many js tree levels to render when page loads. Remaining nodes are rendered (slightly slower) only when they are open by users, by  _**optional namespaces**_ option, by cookies or by _**navbar**_ option. | Default _**n**_ is 1 so that it will speed up the page loading, above all with an high amount of pages. It affects only the user-client CPU speed, not the webserver load. It works only in _**js**_ |
-| `id#[random\|ns\|_number_]`   \\ undo: `id#random` | [Cookie](https://en.wikipedia.org/wiki/HTTP_cookie) Identifier for a js indexmenu where the previously opened/closed nodes by a user are stored. | Useful when a page is uncached and you like the tree state is stored in cookie. (See _**nocookie**_ for disabling cookies.)  Default the option `_id#random_` is active, also when the option is not specified in the syntax. You can apply self a number as unique identifier for your indexmenu  ( e.g. `_id#20_` ) or let generate a number unique for requested namespace with `_id#ns_`. Read the [Js does not remember its previous state](.:indexmenu#Js does not remember its previous state) section. **ATTENTION:** ID must be unique for every indexmenu in your DokuWiki site or you'll get strange js behaviors. Tree state storage with cookie only in _**js**_ |
+| `id#[random\|ns\|_number_]`     undo: `id#random` | [Cookie](https://en.wikipedia.org/wiki/HTTP_cookie) Identifier for a js indexmenu where the previously opened/closed nodes by a user are stored. | Useful when a page is uncached and you like the tree state is stored in cookie. (See _**nocookie**_ for disabling cookies.)  Default the option `_id#random_` is active, also when the option is not specified in the syntax. You can apply self a number as unique identifier for your indexmenu  ( e.g. `_id#20_` ) or let generate a number unique for requested namespace with `_id#ns_`. Read the [Js does not remember its previous state](.:indexmenu#Js does not remember its previous state) section. **ATTENTION:** ID must be unique for every indexmenu in your DokuWiki site or you'll get strange js behaviors. Tree state storage with cookie only in _**js**_ |
-| `nocookie`  \\ undo: `cookie` | Disable [cookies](https://en.wikipedia.org/wiki/HTTP_cookie). By default js indexmenu remember selected,open and closed nodes by user during navigation. With this option it doesn't remember them and the tree is blocked to its start status. | Tree state storage with cookie only in _**js**_ |
+| `nocookie`    undo: `cookie` | Disable [cookies](https://en.wikipedia.org/wiki/HTTP_cookie). By default js indexmenu remember selected,open and closed nodes by user during navigation. With this option it doesn't remember them and the tree is blocked to its start status. | Tree state storage with cookie only in _**js**_ |
-| `noscroll`   \\ undo: `scroll` | Disable the JavaScript scrolling feature when it doesn't fit the container width. It could solve visualization problems. | It works only in _**js**_ |
+| `noscroll`     undo: `scroll` | Disable the JavaScript scrolling feature when it doesn't fit the container width. It could solve visualization problems. | It works only in _**js**_ |
-| `notoc`  \\ undo: `toc` | Disable the TOC-preview feature. | ToC preview only available in _**js**_ |
+| `notoc`    undo: `toc` | Disable the TOC-preview feature. | ToC preview only available in _**js**_ |
-| `nomenu`  \\ undo: `menu` | Disable the contextmenu feature. | Context menu only available in _**js**_ |
+| `nomenu`    undo: `menu` | Disable the contextmenu feature. | Context menu only available in _**js**_ |
@@ 行 311: / 行 311: @@
 The configuration setting `skip_index` let you globally hide namespaces (and their pages) in your indexmenu trees.
-Just fill this option with the ids of namespaces to skip using [Regular Expression](http://www.php.net/manual/en/reference.pcre.pattern.syntax.php).\\
+Just fill this option with the ids of namespaces to skip using [Regular Expression](http://www.php.net/manual/en/reference.pcre.pattern.syntax.php).\
 :!: Till V4.5, a namespaces full path has to be declared as a file system path (i.e.: "mydir/mysubdir") instead of DokuWiki IDs.
 There are also some issues [About empty namespaces](.:indexmenu#About empty namespaces) that should be read.
-**Simple examples:**\\
+**Simple examples:**\
 Skip any namespace whose ID contains the word `copyright` or `privatens:users`. Attention: `allprivatens:usersmich` will be also matched
@@ 行 333: / 行 333: @@
 ### Skip Files in index
 This configuration option `skip_file` let you to globally hide one or more pages in your indexmenu trees.
-Just fill this option with the ids of pages to skip using [Regular Expression](http://www.php.net/manual/en/reference.pcre.pattern.syntax.php).\\
+Just fill this option with the ids of pages to skip using [Regular Expression](http://www.php.net/manual/en/reference.pcre.pattern.syntax.php).\
 :!: Till v4.5, pages are checked as DokuWiki text files (i.e.: start.txt). A page full path have to be declared as a file system path (i.e.: "mydir/start.txt") instead of DokuWiki IDs.
@@ 行 456: / 行 456: @@
 Since the April 2013 plugin release you can add the **`nomenu`** option to indexmenu syntax to disable the contextmenu.
-Modification of menu in performed in `scripts/contextmenu.local.js`:\\
+Modification of menu in performed in `scripts/contextmenu.local.js`:\
 (You can rename the example file from `scripts/contextmenu.local.js.example`)
-  * Overriding menu entry \\
+  * Overriding menu entry\
 ```javascript
 indexmenu_contextmenu['all']['pg']['view'][0] = ['Custom Title'];
 ```
-  * Adding menu entry \\
+  * Adding menu entry\
 ```javascript
 indexmenu_contextmenu['all']['pg']['view'].splice(
@@ 行 482: / 行 482: @@
   * `entryDescriptionArray` - array with description of a menu entry
-**How to write utf8 chars, like èåäö, in the context menu file?**\\
+**How to write utf8 chars, like èåäö, in the context menu file?**\
 A solution is to encode them yourself: Find your char at http://unicode.coeurlumiere.com, replace the last zero of the left code by the character in the upper row and prepend the result with `\u` : i.e. `\u00E3` for 'ã'
@@ 行 544: / 行 544: @@
 # FAQ and Notes
 ### The tree is not working as expected
-  * If you installed for the first time the indexmenu plugin or upgraded it from a previous release, it could be merely a cache issue. Example of symptoms are: tree is not displayed (or a static DokuWiki index is displayed in its place), context menu is not working, any new release feature reported in the [changelog](.indexmenu#changelog) is working.\\ Try to follow instructions to purge cache described in the [The tree is not displayed](.indexmenu#The tree is not displayed) section and retry to display it.
+  * If you installed for the first time the indexmenu plugin or upgraded it from a previous release, it could be merely a cache issue. Example of symptoms are: tree is not displayed (or a static DokuWiki index is displayed in its place), context menu is not working, any new release feature reported in the [changelog](.indexmenu#changelog) is working.\
-  * When an updated indexmenu plugin fails in a _2013-05-10 "Weatherwax" release_ and later:\\ Please check whether all plugins and your theme don't use the old javascript functions. Since the Weatherwax release, these deprecated functions are missing (some plugins still require an update) and will break the javascript rendering.\\ Check for errors:\\ - in console of browser e.g. as part of the Developer toolbar\\ - by disabling all plugins and enabling one by one
+ Try to follow instructions to purge cache described in the [The tree is not displayed](.indexmenu#The tree is not displayed) section and retry to display it.
+  * When an updated indexmenu plugin fails in a _2013-05-10 "Weatherwax" release_ and later:\
+ Please check whether all plugins and your theme don't use the old javascript functions. Since the Weatherwax release, these deprecated functions are missing (some plugins still require an update) and will break the javascript rendering.\
+ Check for errors:\
+ - in console of browser e.g. as part of the Developer toolbar\
+ - by disabling all plugins and enabling one by one
   * If you think that indexmenu are still not fitting your needs, be sure to using a correct [syntax](.indexmenu#syntax), and read carefully the [configuration](plugin:indexmenu#configuration) instructions. There are a lot of options for this plugin, maybe you missed the good one.
   * You are sure that the syntax is correct. Perhaps you missed something in this [FAQ and Notes](.indexmenu#FAQ and Notes) section.
@@ 行 632: / 行 637: @@
   * **Disabled**: Indexmenu doesn't stop its recursive search and it could show denied namespaces (**NOT** pages).
-In both cases, unauthorized pages are never showed. There are also some issues [About empty namespaces](.:indexmenu#About empty namespaces) that should be read.\\
+In both cases, unauthorized pages are never showed. There are also some issues [About empty namespaces](.:indexmenu#About empty namespaces) that should be read.\
 This namespace behaviour in presence of ACLs can not be changed until it's not changed in the DokuWiki core itself.
@@ 行 691: / 行 696: @@
 When the `max#nr` option or level of folded nodes are configured and the node has to retrieve its children through the Ajax request, there can appear empty nodes because indexmenu hasn't looked forward and doesn't know yet that the node was empty.
-**Why do you need a sort option to correctly hide empty namespaces?**\\
+**Why do you need a sort option to correctly hide empty namespaces?**\
 When any of the sort options `tsort`, `dsort`, `msort` `nsort` or `hsort` is used indexmenu replaces the faster, but less featured, core DokuWiki search with the slower, but more featured, indexmenu search that filters more empty nodes.
-**Why will sneaky_index hide forbidden namespaces**\\
+**Why will sneaky_index hide forbidden namespaces**\
 Enabling the `[sneaky_index](config:sneaky_index)` also checks for access to forbidden namespaces, instead of only checking access to pages. This means that it hides deeper allowed pages or namespaces as well. These nodes aren't reachable via the index anymore.. See also [About ACLs](#About ACLs).
@@ 行 711: / 行 716: @@
 # Discussion
-Please, use the [discussion](.:indexmenu:discussion) page for feature requests and general discussion.\\ Old discussions are archived in the [olddiscussion](.:indexmenu:olddiscussion) page.
+Please, use the [discussion](.:indexmenu:discussion) page for feature requests and general discussion.\
+ Old discussions are archived in the [olddiscussion](.:indexmenu:olddiscussion) page.