Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionThe projectdoc Toolbox makes it easy to search for documents with a given set of constraints in a document tree with a given root.
Doctypetopichide
NameSubtree
Searches
Queries
Short Name
Parent
Parent Property
propertyParent
property-nameName

Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
propertyAudience


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesAdvanced Beginner
propertyLevel of Experience


Expected Duration15 min
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesprojectdoc Toolbox, add-on, Confluence, Search
propertyTags

hide
Iteration

Iteration
value

filled

finished

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType

hide
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Section
show-titlefalse
titleDescription

This tip shows how users of the PDAC1 can constrain their searches to documents that have a given ancestor page.

Section
titleSummary

If you need to constrain the search result to documents with a given ancestor, you can take advantage of the artificial properties  like AncestorNames and AncestorIds.

Section
titleUsage Examples

The following examples can be used with macros that execute searches like the Display Table Macro or the Transclude Documents Macro.

Section
titleSubtree Search

Suppose you have a Component document "Server" with documents for sub components. Now you need to list all documents of type View that are associated with the component or any of its subordinate documents.

To limit your search to all documents that have the document named "Server" as their ancestor add

Code Block
languagetext
$<AncestorNames>=[Server]

to your where clause.

To filter on the doctype View, you need to append another constraint so that the final where clause looks like this:

Code Block
languagetext
$<AncestorNames>=[This Root Page] AND Doctype=view
Section
titleSearch for own Descendants

If you need to list the descendants of a document on that document, you can use the AncestorIds property.This is especially helpful for template authors since the ID is unique, whereas the name might not be.

The projectdoc Toolbox adds the page identifier as artificial property. So the where clause for this search looks like this:

Code Block
languagetext
$<AncestorIds> = [${Page ID}]

...

Section
titleResources

Here is more information related to searches with the PDAC1.

Tour
render-as-definition-listtrue
replace-title-with-nametrue
Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto