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

Compare with Current View Page History

« Previous Version 4 Next »

projectdoc Toolbox

Controls how document instances are located in a space.

ID
Data Type
Enumeration of strings
Default Value
heuristic
Value Range
heuristic, search, children-check
Since
4.1
The space property controls how the projectdoc Toolbox is checking for document instances 

Details

Heuristic Mode

The heuristic mode is based on naming conventions of internationalization (I18N) keys. This is the default search mode.

I18N keys are specified in resource bundles, typically in a properties file, that is deployed as an app (formally known as plugin or add-on) to a Confluence server.

The homepage for a given doctype needs to have a I18N key of the following format:

<any-chars>.content.<doctype>.home.title

The index page for doctypes is assumed to be referenced by the following I18N key:

<any-chars>.content.<doctype>.index.all.title

<any-chars> may actually any chars that are valid for an I18N key. <doctype> is a placeholder to represent the identifier of a doctype.

In case all documents are removed, the index page needs to be removed manually.

Requirement Doctype Example

 

A key used by the Requirement doctype.

projectdoc.content.requirement.home.title
projectdoc.content.requirement.index.all.title

Imaginary Fancy Report Doctype

 

A key for the imaginary Fancy Report doctype of a sample organisation.

com.example.myorg.content.fancy-report.home.title
com.example.myorg.content.fancy-report.index.all.title

In order to not clash with keys from projectdoc products, users should use their own key prefixes. These could be defined by the name of their internet domain.

 

todo

Children Check

 

todo

  • No labels