Versions Compared

Key

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

...

Section
titlePrerequisites


Section
titleAbstract


Section
titleReferences

References

...

 are used to back-up the information provided in a document.

Use references if you want to provide a list of citation targets. Often this preciseness is not that important in project documentation.


Section
titleResources

Resources

...

 on the other hand suggest further readings. Information that is related to that given in the document and may also be interesting to the reader.

Tip Box

If you are unsure if you need both references and resources, skip references.



Section
titleRendering Links to Documents

Typically you add one to three sentences describing the referenced resource, similar to

...

Short Description. If the resources are found in your project documentation, you may use

...

the Display Table Macro

...

 to list

...

the tagged

...

 resources. For single entries you may use

...

the Display Document Properties Macro

...

 with a template like

Code Block
$[Name] - ${Short Description}

Another approach is to use the Tour Macro to render additional properties as columns. As long as there are only two columns, the tour can be rendered as a definition list instead of a table.

Image Modified

...

Tip Box

If you are unsure if you need both references and resources, skip references.


Section
titleSubtopics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...