List related Pages

Listing related pages to a page is quite easy using the projectdoc Toolbox.

Parent
Tips
Audience
Author, Template Author
Level of Experience
Advanced Beginner
Expected Duration
10 min
Tags
Confluence, projectdoc, related, documents
Type
Tip

projectdoc documents may be categorized in multiple dimensions. Typically subjects, categories, and tags are supported by every document type.

Linking is required to build a web of information. The projectdoc Toolbox provides macros to create lists of links automatically. One macro to create such a list is the Display Table Macro.

To create a list of related pages use the defined properties of the page and feed it to the query. This can be done by the template author on creation time of a document type or by the page author on a ad-hoc basis.

Example

Here is a short example that shows how to automatically link related pages for a new page.

Existing Document Base

Suppose you have five documents, tagged as shown in the following table.

Four of these documents are related to the topic security. Two of them to security and jaas.

Create a new Document

Now the document author creates a new document and tags it with jaas and security.

Related to this documents are all documents that have both tags, jaas and security.

Select related Documents

Use the Display Table Macro and add the following where clause.

This query selects all documents where the tag property (left hand side from the equal sign) matches the list of tags of this document (right hand side of the equal sign; the ${...} references the values of referenced property of the document this query is part of).

List related Documents

The result of the query, executed by the Display Table Macro, is this:

As expected all documents that are tagged with security and jaas are listed. The order in which the tags are actually specified on the single pages do not matter.