Versions Compared

Key

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

...

Section


Column
width50%


Section
titleUse Cases

Due to the generic nature of the macros, they can be applied in many areas of documentation work. For instance the following use cases are supported:

Expand
titleShow use cases ...

Display Table
doctypebusiness-use-case
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
sort-bySort Key, Name
space-keyPDAC
header-translationsCategories=Category

Use cases provide links to more resources on their topic.



Column
width50%


Section
titleShow Cases

How the macros can be applied to spaces is provided as examples in our show cases:

Expand
titleShow show cases ...


projectdoc-table-merger-macro

projectdoc-display-table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectDocumentation for, Documentation for->Short Description
sort-bySort Key, Name
where$<DirectAncestorTitle>=[Show Cases]
space-keyPDAC

Definition List


shows
Shows how a new space created with the Core Doctypes looks like.
HTML Sanity Checker Architecture Documentation
shows
Shows an example using the arc42 Template provided by projectdoc Add-on for arc42.








Section
titleGetting your Hands dirty ...

Learning projectdoc is best done by using it. To do so the projectdoc Toolbox provides a demo space to be created on your Confluence server.

This space explains a couple of projectdoc's concepts and - since the pages are editable in your space, makes it easy to see how it works and maybe play with its macros and pages. The space is also available online at projectdoc Demonstration Space.

There is also a Hands-on Tutorial to guide you through the process of creating some spaces and using tools from the toolbox by a step-by-step tutorial.

...