You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

projectdoc Toolbox

Show how to use document properties to filter on searches.

Contents

The projectdoc Toolbox for Confluence adds every property to the Lucene search index. This way not only projectdoc macros, like the Display Table Macro or the Transclude Documents Macro, can filter on documents. Users may also apply constraints on searches they type into the search box.

This tip shows how this feature can be used by readers of documentation to remove unwanted pages from the search result set.

Filter Navigation Pages

If you search for a term like "Role" or "Stakeholder" you'll get plenty of hits. This is because the Core Doctypes provide doctypes with this name. For each space there may be a home page and an index page for each of these doctypes and these pages also contain the string "Role" or "Stakeholder". In addition to those, there are also home pages and index pages for the corresponding type doctype, like "Role Type" and "Stakeholder Type". So these pages will also clutter your search result.

Home page and index pages typically have only navigation purposes. Readers know where to look for a list of roles or the address book of stakeholders. When searching for "Role" or "Stakeholder" these navigation pages should not show up as search results. Only destination pages, containing actual relevant information, should.

Confluence does not distinguish between destination pages and navigation pages. The projectdoc Toolbox provides navigation pages by the doctype named docsection. This makes it easy to remove these pages from the search results.

Instead of 

"Stakeholder" -Doctype: docsection

you would type the following:

"Stakeholder" -Doctype: docsection

Now Confluence will only return destination pages related to "Stakeholder" and remove all navigation pages from the result set.

Summary

A Confluence site consists of a number of spaces. Within a space home pages and index pages provide navigation support to users. They make it easy to browse documents of a given type and find related information.

Besides navigation page as space's main purpose is to server destination pages. In searches user typically want only destination pages in their result set.

To remove navigation pages add -Doctype: docsection to your search query.


  • No labels