Changes for page Document Tree Macro

Last modified by Admin on 2024/03/25 16:45

<
From version < 1.2 >
edited by Marius Dumitru Florea
on 2014/11/06 16:23
To version < 2.1 >
edited by Marius Dumitru Florea
on 2014/11/06 16:56
>
Change comment: There is no comment for this version

Summary

Details

EXOExtensionCode.ExtensionClass[0]
Compatibility
... ... @@ -1,0 +1,1 @@
1 +6.3RC1+
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,0 +1,64 @@
1 +Displays the hierarchy of wiki documents using the [[Tree Macro>>Extension.Tree Widget]].
2 +
3 += Usage =
4 +
5 +{{code language="none"}}
6 +{{documentTree /}}
7 +{{/code}}
8 +
9 +== Parameters ==
10 +
11 +|=Name|=Description|=Default Value
12 +|checkboxes|Whether to display a checkbox in front of each tree node to allow the user to select multiple tree nodes.|false
13 +|compact|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.|false
14 +|links|Specifies whether the node labels should look and behave as links (anchors).|true
15 +|readOnly|Should the user be able to modify the tree structure, provided she has the necessary rights?|true
16 +|root|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.|None
17 +|showAttachments|Whether to show the document attachments or not.|true
18 +|showChildDocuments|Whether to show the child documents based on the document parent field.|true
19 +|showClassProperties|Whether to show the class properties for documents that define classes.|false
20 +|showDocumentTitle|Whether to show the document title instead of the document name when displaying a document node.|true
21 +|showObjects|Whether to show the document objects or not.|false
22 +|showSpaces|Whether to show the space nodes or not. The documents are grouped by space if the space nodes are displayed.|false
23 +|showTranslations|Whether to show the document translations or not.|true
24 +|showWikis|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.|false
25 +|showWikiPrettyName|Show the wiki pretty name instead of the wiki id when displaying a wiki node.|true
26 +
27 += Examples =
28 +
29 +== Document Index Tree ==
30 +
31 +{{code language="none"}}
32 +{{documentTree showSpaces="true" /}}
33 +{{/code}}
34 +
35 +== Document Hierarchy Tree ==
36 +
37 +{{code language="none"}}
38 +{{documentTree /}}
39 +{{/code}}
40 +
41 +=== Compact Document Hierarchy Tree ===
42 +
43 +{{code language="none"}}
44 +{{documentTree compact="true" /}}
45 +{{/code}}
46 +
47 +== Wiki > Space > Page Tree ==
48 +
49 +{{code language="none"}}
50 +{{documentTree showWikis="true" showSpaces="true" showTranslations="false" showAttachments="false" showChildDocuments="false" /}}
51 +{{/code}}
52 +
53 +=== Navigation Panel ===
54 +
55 +{{code language="none"}}
56 +{{documentTree showSpaces="true" showTranslations="false" showAttachments="false" showChildDocuments="false" compact="true" /}}
57 +{{/code}}
58 +
59 +== Full Entity Tree ==
60 +
61 +{{code language="none"}}
62 +{{documentTree showWikis="true" showWikiPrettyName="false" showSpaces="true" showDocumentTitle="false"
63 + showChildDocuments="false" showObjects="true" showClassProperties="true" /}}
64 +{{/code}}
Display Icon Location
... ... @@ -1,1 +1,1 @@
1 -chart_organization
1 +icon:chart_organisation
Source
... ... @@ -1,0 +1,1 @@
1 +https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-index/xwiki-platform-index-ui/src/main/resources/XWiki/DocumentTree.xml

Get Connected