Aller au contenu

Modifications pour le document Rangee Index

Modifié par Tobias Wintrich le 2025/10/31 08:26
Depuis la version 9.1
modifié par Tobias Wintrich
sur 2021/09/27 14:58
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 7.34
modifié par Tobias Wintrich
sur 2021/09/27 14:48
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Titre
... ... @@ -1,1 +1,1 @@
1 -Rangee Index
1 +Rangee Document Tree
Contenu
... ... @@ -1,4 +1,4 @@
1 -{{include reference="XWiki.DocumentTreeMacros"/}}
1 +{{include reference="XWiki.DocumentTreeMacros" /}}
2 2  
3 3  {{velocity wiki="false"}}
4 4  #if ($xcontext.action == 'get')
... ... @@ -6,3 +6,24 @@
6 6   #handleDocumentTreeRequest
7 7  #end
8 8  {{/velocity}}
9 +
10 +{{velocity}}
11 +#if ($xcontext.action != 'get')
12 + == Document Hierarchy Tree ==
13 +
14 + {{documentTree /}}
15 +
16 + === Compact Document Hierarchy Tree ===
17 +
18 + {{documentTree compact="true" /}}
19 +
20 + == Wiki > Space > Page Tree ==
21 +
22 + {{documentTree showWikis="true" showSpaces="true" showTranslations="false" showAttachments="false" showChildDocuments="false" /}}
23 +
24 + == Full Entity Tree ==
25 +
26 + {{documentTree showWikis="true" showWikiPrettyName="false" showSpaces="true" showDocumentTitle="false"
27 + showChildDocuments="false" showObjects="true" showClassProperties="true" /}}
28 +#end
29 +{{/velocity}}
XWiki.WikiMacroClass[0]
Code de la macro
... ... @@ -1,34 +1,25 @@
1 -{{tree links="true"}}
1 +{{template name="RangeeDocumentTree_macros.vm" /}}
2 +
2 2  {{velocity}}
3 -{{html wiki=true}}
4 -<ul>
5 -#foreach ($child in $doc.getChildren())
6 - <li class="jstree-open">
7 - [[$child]]
8 - <ul>
9 - #foreach ($subchild in $xwiki.getDocument($child).getChildren())
10 - <li class="jstree-open">
11 - [[$subchild]]
12 - <ul>
13 - #foreach ($subsubchild in $xwiki.getDocument($subchild).getChildren())
14 - <li class="jstree-open">
15 - [[$subsubchild]]
16 - <ul>
17 - #foreach ($subsubsubchild in $xwiki.getDocument($subsubchild).getChildren())
18 - <li class="jstree-open">
19 - [[$subsubsubchild]]
20 - </li>
21 - #end
22 - </ul>
23 - </li>
24 - #end
25 - </ul>
26 - </li>
27 - #end
28 - </ul>
29 - </li>
4 +#set ($options = {})
5 +#foreach ($parameterName in $xcontext.macro.params.parameterNames)
6 + #set ($discard = $options.put($parameterName, $xcontext.macro.params.get($parameterName)))
30 30  #end
31 -</ul>
8 +{{html clean="false"}}
9 +#prepareTreeOptions($options)
10 +#documentTree($options)
11 +
12 +{{tree}}
13 +#foreach ($child in $doc.children)
14 + * [[$child]]
15 + #foreach ($subchild in $child.children)
16 + ** [[$subchild]]
17 + #end
18 +#end
19 +{{/tree}}
20 +
21 +
32 32  {{/html}}
23 +
33 33  {{/velocity}}
34 -{{/tree}}
25 +
Identifiant de la macro
... ... @@ -1,1 +1,1 @@
1 -RangeeIndex
1 +RangeeDocumentTree
Nom de la macro
... ... @@ -1,1 +1,1 @@
1 -Rangee Index
1 +Rangee Document Tree
Visibilité de la macro
... ... @@ -1,1 +1,1 @@
1 -Global
1 +Current Wiki
XWiki.WikiMacroParameterClass[0]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Should the user be able to modify the tree structure, provided she has the necessary rights?
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +readOnly
XWiki.WikiMacroParameterClass[1]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the wiki nodes or not. This can be used only on the main wiki and if the tree source has been saved with programming rights.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showWikis
XWiki.WikiMacroParameterClass[2]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Show the wiki pretty name instead of the wiki id when displaying a wiki node.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showWikiPrettyName
XWiki.WikiMacroParameterClass[3]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the space nodes or not. The documents are grouped by space if the space nodes are displayed.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showSpaces
XWiki.WikiMacroParameterClass[4]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the document title instead of the document name when displaying a document node.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showDocumentTitle
XWiki.WikiMacroParameterClass[5]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the document translations or not.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showTranslations
XWiki.WikiMacroParameterClass[6]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the document attachments or not.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showAttachments
XWiki.WikiMacroParameterClass[7]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the document objects or not.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showObjects
XWiki.WikiMacroParameterClass[8]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the class properties for documents that define classes.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showClassProperties
XWiki.WikiMacroParameterClass[9]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +reference
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Specifies which hierarchy to use between documents. Possible values are "reference" (default) and "parentchild". If "reference" is used then the document hierarchy is defined using only the document reference, especially the nested spaces component of the document reference. If "parentchild" is used then the hierarchy is based on the parent/child relationship defined by the "parent" document field from the database.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +hierarchyMode
XWiki.WikiMacroParameterClass[10]
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +The root node id. This is useful if you want to display only the descendants of a given node (which is the specified root). The tree displays the children of the root node on the first level, so the root node is not actually displayed. The entire tree is displayed if the root node is not specified. The format of a node identifier is entityType:entityReference, where the entity type can be for instance wiki, space, document. E.g.: wiki:xwiki, space:xwiki:Main, document:xwiki:Main.WebHome
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +root
XWiki.WikiMacroParameterClass[11]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +If you have limited horizontal space available then you should probably set this to true. The effect is that the node icons and the edges that connect them will be hidden. Some special styles will also be applied to ensure the tree takes less horizontal space while keeping the node labels fully visible.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +compact
XWiki.WikiMacroParameterClass[12]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Specifies whether the node labels should look and behave as links (anchors).
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +links
XWiki.WikiMacroParameterClass[13]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to display a checkbox in front of each tree node to allow the user to select multiple tree nodes.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +checkboxes
XWiki.WikiMacroParameterClass[14]
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +The id of the node to open the tree to. All the ancestors of the specified node, up to the root of the tree, will be opened also. The format of the node id is the one used for the root parameter.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +openTo
XWiki.WikiMacroParameterClass[15]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Show only the wiki, space and document nodes for which the current user has view right. If this is set to false then the wiki, space and document nodes that are not viewable by the current user are listed in the tree using their names. The user won't be able to see their content by following their links though (the user will just be aware of their existence).
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showOnlyViewable
XWiki.WikiMacroParameterClass[16]
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Show only the documents that have an object of the specified type. The value of this parameter is the full name of an XWiki document that holds a class definition. For example, 'Blog.CategoryClass' can be used to show only the documents that represent blog categories. Leave this parameter empty if you don't want to restrict the type of documents shown in the tree.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +filterByClass
XWiki.WikiMacroParameterClass[17]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Show a text input that can be used to find tree nodes. The input is displayed above the tree and offers suggestions as you type based on the content of the tree. When a suggestion is selected the tree is expanded up to the corresponding node.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +finder
XWiki.WikiMacroParameterClass[18]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +false
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Whether to show the root node or not. The root node is not shown by default because it is usually implied from the context where the tree is displayed (e.g. a label before the tree). There are some cases though when you may want to display the root node: to be able to create a new node under the root.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +showRoot
XWiki.WikiMacroParameterClass[19]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +true
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +Set this parameter to false if you want to include the hidden documents in the tree. Otherwise, if the value is true, the hidden documents are excluded or included based on current user's preferences.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +filterHiddenDocuments
XWiki.WikiMacroParameterClass[20]
Valeur par défaut du paramètre
... ... @@ -1,0 +1,1 @@
1 +15
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +The maximum number of child nodes to display when expanding a parent node for the first time. The rest of the child nodes are accessible through a "more ..." link. This parameter is basically used to paginate the child nodes and thus helps the tree scale when the number of child nodes is large.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +limit
XWiki.WikiMacroParameterClass[21]
Description du paramètre
... ... @@ -1,0 +1,1 @@
1 +The list of nodes to exclude from the tree. The nodes are specified by their id and separated by comma.
Paramètre obligatoire
... ... @@ -1,0 +1,1 @@
1 +Non
Nom du paramètre
... ... @@ -1,0 +1,1 @@
1 +exclusions