Note that prior to version 2.5 of the projectdoc Toolbox only single valued properties can be used with deep links. So if you are using an older version, if more than one link is found in a property value, only the first will be traversed.

Macros supporting Deep Links:

Name

StoryPoints = "1" 

$[Story Points] = "1" 

$[Story Points] = ${Magic Value}

$[Story Points] = $\{Magic Value\}

$<Story Points> = [

Magic Value]

$<Story Points> = [${Magic Value]

$<Story Points> = [${Magic Value}]

}]

$<Name> = [My Name \(with brackets\)]

$<Name> = [My Name \\ containing a slash]

$<Story Points> = [${Master->Ref Story Points}]

$<AncestorNames> = [This Root Page]

$<AncestorIds> = [

$<AncestorNames> = [This Root Page]

$<AncestorIds> = [${Page ID}]

$<Audience> = ^QRT^

$<Audience> = ^${Name}^

$<Name> ~ (One, Two, Three)

$<Name>=[One] OR $<Name>=[Two] OR $<Name>=[Three]

$<Name> ~ (${Some Names})

ReadBy = "jd" AND Readjd = 2014*

Tags = (("test-me" AND "continous-delivery") OR "My-Tag")

+TypeAncestors:[* TO *] AND -TypeAncestors:Fragment 

+Doctype:topic AND -TypeAncestors:Fragment

$[Creation Date§]: [${Last Update§} TO NOW]

$<Name> ~ (One, Two, Three)

$<Name>=[One] OR $<Name>=[Two] OR $<Name>=[Three]

$<Name> ~ (${Some Names})

created:[20150311 TO 20150317]
created:[20150311 TO NOW]

Date§: [20190101 TO ${now("", "-6w")}]
Date§: [${now("", "-6w")} TO ${now("", "-4w")}]

$<PROPERTY NAME>=${function-name(argument-list)}

$<Start Date§>=${now()}

$<Login Name>=${currentUser()}

$<Attendee>=${currentUser("fn")}

currentUser()
currentUser("")
currentUser("id")

Here are some more examples on using queries in various use cases.

To select all resource documents that are read by a specific user ("jd" in this example) in a given year (specified by the document property Readjd in the format yyyy-MM-dd), use the prefix query:

ReadBy = "jd" AND Readjd = 2014*

The Tags Property is one that is supported by all document types. It specifies a comma-separated list of values.

To select on those documents by tag values, use this:

Tags = (("test-me" AND "continous-delivery") OR "My-Tag")

A fragment is a basic document a couple of topic types (table, example, ...) derive from. To select only documents of a type that is not a fragment or one of its subtypes, use the following:

+TypeAncestors:[* TO *] AND -TypeAncestors:Fragment 

currentUser("fn")

Since version 1.10 the projectdoc Toolbox provides normalized date value to be used with Lucene searches. If the property value is specified with the Confluence Date Autocompletion (opened with the shortcut '//'), and for the creation and last modification date, a normalized date is provided as an artificial property.

Image Removed

The name of this artificial property is that of the original property plus the §-sign appended.

Here is an example where the creation date is check against a custom property named Last Update.

$[Creation Date§]: [${Last Update§} TO NOW]

There is also an artificial property value containing the date as a timestamp in milliseconds, prefixed with zeros up to 19 digits (%019d). The name of the artificial property is constructed from the original name plus the suffix Timestamp (separated by a blank). Note that the creation timestamp is called Creation Timestamp (not Creation Date Timestamp).

Confluence provides a couple of search fields to help finding the desired documents.

created:[20150311 TO 20150317]
created:[20150311 TO NOW]

created:[NOW-7DAY TO NOW]
created:[StartOfWeek TO NOW]

$<Date§> >= ${now(-2w)}

$<Date§> >= ${startOfMonth()}
$<Date§> >= ${startOfMonth("")}
$<Date§> >= ${startOfMonth("", "")}

$<Date§> <= ${startOfMonth(-1d)}  // 4.1 and above
$<Date§> <= ${startOfMonth("", "-1d")}

$<Date> = ${now("dd.MM.yyyy", "-6d")}

(+/-)nn(y|M|w|d|h|m)

+2d

5y

-10w

-2d10y

$<Date§> >= ${now("", "-2w")}
$<Date§> >= ${endOfMonth("", "1w")}
$<Date§> >= ${startOfMonth("", "+3d")}

Date§: [${now("", "-6w")} TO ${now("", "-4w")}]

$<Date§> >= ${now("", "-6w")} AND $<Date§> <= ${now("", "-4w")}

$<Date§> >= ${now("", "-2w")}
$<Date§> >= ${endOfMonth("", "1w")}
$<Date§> >= ${startOfMonth("", "+3d")}

$<Date§> >= ${now(-2w)}
$<Date§> >= ${endOfMonth(1w)}
$<Date§> >= ${startOfMonth(+3d)}

A query function is a virtual function call that will replace the call with the return value of the function.

The syntax for using search functions is:

$<PROPERTY NAME>=${function-name(argument-list)}

Functions can be used for a value in a Where clause parameter of a projectdoc macro.

Functions cannot be used for a property name or outside the Where clause.

Here are some usage examples:

$<Start Date§>=${now()}

$<Login Name>=${currentUser()}

$<Attendee>=${currentUser("fn")}

The following functions are supported:

• currentUser()
• now()
• startOfDay()
• endOfDay()
• startOfWeek()
• endOfWeek()
• startOfMonth()
• endOfMonth()
• startOfYear()
• endOfYear()

There is only one user function that provides access to the current user of a session.

The currentUser function supports the format argument.

Valid formats are

• id (default) - login name (id) of the current user
• fn - Full Name of current user

If no user is currently logged in to the current session, then the format id returns "#anonymous" and the format fn returns "#Anonymous".

The following calls will return the login name of the currently logged in user.

currentUser()
currentUser("")
currentUser("id")

In case the full name, as provided in the user's profile is requested, use:

currentUser("fn")

The date functions provide a date in the format "yyyyMMdd". This way it can easily be compared to date properties by the use of the normalized date representation (add '§' to the name of the property like "Start Date§").

The following functions are provided:

now

The current date at the time the page is rendered.

The date at the first millisecond of the first day of the week the current day is part of.

Note that currently you cannot control the definition of the first day.

The date at the last millisecond of the last day of the week the current day is part of.

Note that currently you cannot control the definition of the last day.

The date functions allow two arguments.

• format
• increment 

If you want to specify the increment, but not the format, user "" as the first argument.

Specify the format as defined for the Joda Time date formater: DateTimeFormat.

Typically use:

The default format is: "yyyyMMdd".

For instance:

(+/-)nn(y|M|w|d|h|m)

+ID:[* TO *] AND -ID:6555694

*:* -Parent:[* TO *]

*:* NOT Parent:[* TO *]

Parent:[* TO *]

Tags = "logging" NOT ID = 3704077

Tags = "logging" AND ID NOT 3704077

...