You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
The URI to a JSON document containing the URLs to the documentation for the blueprints.
Description
By providing such a JSON file with the space property documentation-json-uri
a template author can provide the documentation for the template (Document Properties Marker Macro) and for the sections (Section Macro) of the template. Authors then are able to access the documentation by clicking the help button in edit mode.
How it works
Here is an example of a short JSON file containing the documentation for the category doctype.
{
"category": {
"_default_" :"https://www.smartics.eu/confluence/display/PDAC1/Category",
"Description":"https://www.smartics.eu/confluence/display/PDAC1/Category#Description",
}
}
The name of the doctype and the name of the section determines the URL to use to guide the author to the documentation section.
The default key will be used, when for a given section title (e.g. "Note
") there is no mapping in the JSON file. The URL, in this case
https://www.smartics.eu/confluence/display/PDAC1/Category
is used to construct the URL to the note section
https://www.smartics.eu/confluence/display/PDAC1/Category#Note
Cache
The JSON file, which is referenced by using the space property documentation-json-uri
, will be cached by projectdoc for one day. If you need to use the new content you provided in your JSON file right now you can flush this cache by selecting flush on the Confluence cache management admin page.
For more details please visit the Confluence help page for Cache Statistics.
To flush the cache: Go to > General Configuration > Cache Management and flush the cache projectdoc Documentation Cache