Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Doctypepropertyhide
Namedocumentation-json-uri
 

Short DescriptionThe URI to a JSON document containing the URLs to the documentation for the blueprints.
 

Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
propertyAudience
hide
Categories
Name List
doctypecategory
propertyCategories
 

Tags
Name List
doctypetag
propertyTags
 

Identifier
 

Component
Name List
doctypecomponent
propertyComponent
 

Mandatory
 

Typestring
 

Default Value
 

Value Range
 

Implementation
 

Iteration
Iteration
valuefilled
hide
Since1.2.0
 

Sort Keyhide
Section
show-titlefalse
titleDescription

By providing such a JSON file with the space property documentation-json-uritemplate 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.

The help button

Section
titleFormat

The JSON map has the names of the doctypes as the keys. The value is a map of section names with URLs as values.

The special key _default_ provides the URL for the doctype itself.

Moreover there is a default mapping that is applied when for a title of a section of a doctype no mapping can be found.

Section
titleHow it works

Here is an example of a short JSON file containing the documentation for the category doctype.

Code Block
{
 "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 information on the note section

https://www.smartics.eu/confluence/display/PDAC1/Category#Note

...