# Changes for page Document Tree

Last modified by superadmin on 2017/11/28 14:52

#### Export

#### Office Formats

Export as PDF Export as ODT Export as RTF

#### Other Formats

Export as HTML
From empty
To version 1.1
edited by superadmin
on 2017/11/28 14:52
Change comment: Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/9.9]

## Summary

- Page properties (5 modified, 0 added, 0 removed)
- Objects (0 modified, 22 added, 0 removed)
  - XWiki.WikiMacroClass[0]
  - XWiki.WikiMacroParameterClass[0]
  - XWiki.WikiMacroParameterClass[1]
  - XWiki.WikiMacroParameterClass[2]
  - XWiki.WikiMacroParameterClass[3]
  - XWiki.WikiMacroParameterClass[4]
  - XWiki.WikiMacroParameterClass[5]
  - XWiki.WikiMacroParameterClass[6]
  - XWiki.WikiMacroParameterClass[7]
  - XWiki.WikiMacroParameterClass[8]
  - XWiki.WikiMacroParameterClass[9]
  - XWiki.WikiMacroParameterClass[10]
  - XWiki.WikiMacroParameterClass[11]
  - XWiki.WikiMacroParameterClass[12]
  - XWiki.WikiMacroParameterClass[13]
  - XWiki.WikiMacroParameterClass[14]
  - XWiki.WikiMacroParameterClass[15]
  - XWiki.WikiMacroParameterClass[16]
  - XWiki.WikiMacroParameterClass[17]
  - XWiki.WikiMacroParameterClass[18]
  - XWiki.WikiMacroParameterClass[19]
  - XWiki.WikiMacroParameterClass[20]

## Details

Page properties
  Title

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Document Tree

  Parent

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Main.AllDocs

  Author

    ... | ... | @@ -1,1 +1,1 @@
    1 |  | -XWiki.XWikiGuest
    | 1 | +xwiki:XWiki.superadmin

  Hidden

    ... | ... | @@ -1,1 +1,1 @@
    1 |  | -false
    | 1 | +true

  Content

    ... | ... | @@ -1,0 +1,29 @@
    | 1 | +{{include reference="XWiki.DocumentTreeMacros" /}}
    | 2 | +
    | 3 | +{{velocity wiki="false"}}
    | 4 | +#if ($xcontext.action == 'get')
    | 5 | + #updateDocTreeConfigFromRequest
    | 6 | + #handleDocumentTreeRequest
    | 7 | +#end
    | 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]
  Macro code

    ... | ... | @@ -1,0 +1,11 @@
    | 1 | +{{template name="documentTree_macros.vm" /}}
    | 2 | +
    | 3 | +{{velocity}}
    | 4 | +#set ($options = {})
    | 5 | +#foreach ($parameterName in $xcontext.macro.params.parameterNames)
    | 6 | + #set ($discard = $options.put($parameterName, $xcontext.macro.params.get($parameterName)))
    | 7 | +#end
    | 8 | +{{html clean="false"}}
    | 9 | +#documentTree($options)
    | 10 | +{{/html}}
    | 11 | +{{/velocity}}

  Macro content type

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No content

  Default category

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Navigation

  Macro description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Displays the tree of XWiki documents.

  Macro id

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +documentTree

  Macro name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Document Tree

  Supports inline mode

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Macro visibility

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Current Wiki

XWiki.WikiMacroParameterClass[0]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Should the user be able to modify the tree structure, provided she has the necessary rights?

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +readOnly

XWiki.WikiMacroParameterClass[1]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showWikis

XWiki.WikiMacroParameterClass[2]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Show the wiki pretty name instead of the wiki id when displaying a wiki node.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showWikiPrettyName

XWiki.WikiMacroParameterClass[3]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showSpaces

XWiki.WikiMacroParameterClass[4]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Whether to show the document title instead of the document name when displaying a document node.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showDocumentTitle

XWiki.WikiMacroParameterClass[5]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Whether to show the document translations or not.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showTranslations

XWiki.WikiMacroParameterClass[6]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Whether to show the document attachments or not.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showAttachments

XWiki.WikiMacroParameterClass[7]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Whether to show the document objects or not.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showObjects

XWiki.WikiMacroParameterClass[8]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Whether to show the class properties for documents that define classes.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showClassProperties

XWiki.WikiMacroParameterClass[9]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +reference

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +hierarchyMode

XWiki.WikiMacroParameterClass[10]
  Parameter description

    ... | ... | @@ -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

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +root

XWiki.WikiMacroParameterClass[11]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +compact

XWiki.WikiMacroParameterClass[12]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +Specifies whether the node labels should look and behave as links (anchors).

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +links

XWiki.WikiMacroParameterClass[13]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +checkboxes

XWiki.WikiMacroParameterClass[14]
  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +openTo

XWiki.WikiMacroParameterClass[15]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -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).

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showOnlyViewable

XWiki.WikiMacroParameterClass[16]
  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +filterByClass

XWiki.WikiMacroParameterClass[17]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +finder

XWiki.WikiMacroParameterClass[18]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +false

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +showRoot

XWiki.WikiMacroParameterClass[19]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +true

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +filterHiddenDocuments

XWiki.WikiMacroParameterClass[20]
  Parameter default value

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +15

  Parameter description

    ... | ... | @@ -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.

  Parameter mandatory

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +No

  Parameter name

    ... | ... | @@ -1,0 +1,1 @@
    | 1 | +limit

# Applications

# Tips

Did you know that you can improve XWiki? Take 5 minutes to fill this survey and help this open source project!

# Need help?

If you need help with XWiki you can contact:

- Community Support
- Professional Support