Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
doctypetopic
overridefalse
extract-short-desctrue


Short DescriptionThis is a gentle introduction to the core macros. The macros are grouped semantically to make it easier for users to build a conceptual mind map for them.
Doctypetopichide

NameMacros Introduction
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience

Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesAdvanced Beginner
propertyLevel of Experience


Expected Duration
Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration
Iteration
valuefilled
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Sort Keyhide



 
Section
titleDescription


Section
titlePrerequisites

...

Section
titleWorking Horses

Authors add properties and sections to projectdoc documents. This information is transcluded from other documents, either by pointing to a particular property or section or by defining a query to select information from a number of documents.

To enhance navigation authors may render links to related documents by queries. If the list of references is fixed, the documents to link to can be easily defined and any property or section may be rendered.

The following macros are used to accomplish these tasks quite easily.

Tour
replace-title-with-nametrue


TitleShort DescriptionNotes
Document Properties Marker Macro 
Typically this macro is already on every projectdoc document created with a blueprint. Authors supply values for the defined properties and optionally add new ones.
Section Macro 
Defines a section within a projectdoc document. This is text content with a title to be easily transcluded for reuse in other pages.
Display Table Macro 
Since every document has properties, it is very easy to select them. Mind the Search Tips!
Tour Macro 
While the Display Table Macro lists a result set of documents that match your queries, the Tour Macro allows to select the documents to display manually. Then select the properties and sections you want to show.
Transclusion Macro 
If you need to transclude from a single document. Also consider to have a look at the Section Macro if you want to transclude information from a non-standard part of a document.
Transclude Documents Macro 
If you need to transclude from documents in a result set.
Display Document Property Macro 
To render the value of a document property. If you need to render more than one property of a document, have a look at Display Document Properties Macro that allows you to specify a template. Note that there is also a variant for space properties: Display Space Property Macro.
Quote Macro 
To quote relevant information, also consider the External Quote Macro for quoting from resources outside your wiki.


For teams to work collaboratively on their documentation there are more use cases than these basic ones. You may need to transclude information from remote servers, add visuals to put emphasis on important information, or control which information to show for different audiences.

Have a look at the next section to learn of these and all the other macros inside of the PDAC1!

...