Различия

Показаны различия между двумя версиями страницы.

--- wiki:syntax [2021/11/29 10:21] – старая версия восстановлена (2021/02/24 01:01) 62.210.149.60
+++ wiki:syntax [2021/12/20 18:25] (текущий) – старая версия восстановлена (2020/12/15 09:16) kot
@@ Строка 405: / Строка 405: @@
 ~~INFO:syntaxplugins~~
+===== NSPages =====
+**NSPages** -- плагин для создания удобного сортированного списка страниц в [[doku>ru:namespaces|пространстве имён]]. Основное использование с помощью соответствующей кнопки редактора, подробности синтаксиса либо [[https://www.dokuwiki.org/plugin:nspages|здесь]] (англ), либо ниже по тексту, опять же на английском.
+This plugin nicely displays a table of content of the pages -and optionally the subnamespaces- of a given (sub)namespace.
+Using this plugin is easy: just write
+  <nspages>
+and see the result. (You may also use the button {{http://wiki.scooterclub.by/lib/images/toolbar/../../plugins/nspages/images/tb_nspages.png}} from the toolbar.)
+The general syntax is
+  <nspages path_to_a_namespace -option1 -option2 ...>
+where:
+  *path_to_a_namespace represents the path to the wanted namespace. It can be an absolute (ex: namespace1:subnamespace) or a relative path (ex: .:subnamespace). If no path is specified, the current namespace is selected.
+  *-option may be one of the following (it is possible to specify several options):
+^ Common options ^^
+|  <code>-subns</code>  |displays the subnamespaces of the selected namespace (and provide links to their main page) |
+|  <code>-nopages</code>  |do not list the pages of the selected namespace (of course this option is useful only if you use -subns) |
+|  <code>-exclude:nameOfPage</code>  |won't include the page nameOfPage. This option may be use several times in order to exclude several pages |
+|  <code>-exclude:subNs:</code>  |won't include the subnamespace subNs. This option may also be used more than once |
+|  <code>-exclude</code>  |won't include the current page |
+|  <code>-h1</code>  |will display the first h1 title found. If a page doesn't contain such a title, the name of the page  is used instead |
+|  <code>-textPages="some text"</code>  |//some text// will be displayed instead of the default text, to introduce the pages list |
+|  <code>-textNS="some text"</code>  |//some text// will be displayed instead of the default text, to introduce the namespaces list |
+|  <code>-title</code>  | alias of -h1 |
+|  <code>-simpleList</code>  | display the list on a single column |
+|  <code>-numberedList</code>  | display the list on a single column, as an ordered list |
+|  <code>-simpleLine</code>  | display the list on a single line (incompatible with -simpleList) |
+|  <code>-simpleLineBreak</code>  | display the list on a single column, separated only by line breaks (incompatible with the previous flags) |
+|  <code>-nbCol=3</code>  | Change the number of columns to use (default is 3)  |
+|  <code>-sortId</code>  | Sort the pages according to their id, even if -title is used |
+^ Less common options ^^
+|  <code>-reverse</code>  | Sort the pages in reverse order |
+|  <code>-naturalOrder</code>  | Sort the pages in [[http://stackoverflow.com/q/5167928/1796345|natural order]] |
+|  <code>-pagesInNs</code>  | The pages will appear among the namespaces |
+|  <code>-r</code>  | recurse : display elements of the subnamespaces. You may use just "-r" to check every subnamespace, or e.g. "-r=3" to have a depth limit to 3 levels  |
+|  <code>-exclude:[page1 subNs: page2]</code>  |an easier syntax to exclude several pages/subnamespaces|
+|  <code>-pregPagesOn
+-pregPagesOff
+-pregNSOn
+-pregNSOff</code>  | Enable the use of regex to select the documents that should be displayed. Eg: -pregPagesOn="/doku/i" will display only pages which contains "doku" in their id.\\ Several options may be used, and each of them may be used several times. |
+|  <code>-anchorName=myName</code>  | Add anchors on each title-letters, to let link directly to them. Anchors will look like, e.g. for the letter A: nspages_myName_A |
+|  <code>-actualTitle</code>  |print an actual html title (not just a bold and underlined text) |
+|  <code>-actualTitle=n</code>  |print an actual html title <hn> |
+|  <code>-idAndTitle</code>  |Use the format "id of the item - title of the item" |
+|  <code>-nbItemsMax=n</code>  |Display at most n pages or subnamespaces  |
+  ex: <nspages path_to_a_namespace -exclude>  or <nspages -subns -nopages> will work.