Child pages
  • Death by Macros?

Versions Compared

Key

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

...

Section
titleDescription

Section
titleQuestion

I'm overwhelmed by the number of macros provided by projectdoc! Which of the macros are most useful to me?

Section
titleAnswer

Unfortunately there is no quick answer on which macros are most useful in any context.

If you are a beginner, we recommend to get familiar with the following macros first:

Section
level2
titleCreate a Document
Tour
TitleShort DescriptionNotes
Document Properties Marker Macro Added automatically by the projectdoc templates. Use the properties to query and select information.
Section Macro Use sections to make content on a page referenceable. You may associate help for document authors to support document creation. The macro makes it also easy to drag sections around.
Section
level2
titleList Documents
Tour
TitleShort DescriptionNotes
Display Table Macro Use Select, Where, Sort By to define queries on documents in your wiki. New documents that meet the criteria are automatically added on next visit of the page.
Tour Macro If you want to explicitly specify the documents your want to list, and select information from it, use the Tour Macro. This makes sure that the number of elements is fixed.
Section
level2
titleTransclude Information
Tour
TitleShort DescriptionNotes
Transclusion Macro To remove redundancy strive for modular documentation. This does not only make team collaboration on documents easier, it also removes redundancy and inconsistencies. The Transclusion Macro allows to include a text snippet from another document. The text has to be marked either with the Section Macro   or the   Content Marker Macro .
Transclude Documents Macro To transclude content from a list of documents, use the Transclude Documents Macro. This combines the query ability of the Display Table Macro with the Transclusion Macro .
Display Document Property Macro If you want to reference a single property from a document (probably with a link to that document), use the Display Document Property Macro. If you want to arrange a couple of properties by a template, have a look at the   Display Document Properties Macro .

The overview lists all projectdoc macros in alphabetical order. You may experience the Macros Introduction as a more gentle approach, since the macros are introduced in a semantic context.

Section
titleSubordinate FAQs
Display Table
doctypefaq
render-no-hits-as-blanktrue
selectName, Short Description
sort-bySort Key, Name
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
required-permissionswrite-access
titleNotes

...