Versions Compared

Key

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

...

Section
titleUse Cases

Here are a couple of use cases that employ space properties.

Section
titleMaven Projects

With projectdoc you may create spaces for software projects built with Maven. Create a space by reading the project's POM file. The properties of the POM are automatically made available as space properties.

Depending on the version of the product, different space properties may be enforced by using space properties extensions.

Note Box

The doctype add-on is not yet available on the Atlassian Marketplace. Large POM files take a long time to create the space. While developers may deal with this, other users may be annoyed by the import process.

Until this problem is fixed users may choose to fork and build the add-on on their own. It is available on Bitbucket!

For more information on documenting projects built with Maven, please refer to:

Tour
render-as-definition-listtrue
Section
titleBeing a Pretender

Sometimes an author needs to look at a page as if she is a reader. For these use cases there is the pretend-being-a property that is only allowed to be specified as a user space property.

Section
titleUser-specific Home Pages

Users may want to define home pages for certain types of documents individually. It is also possible to store documents of a given subject automatically to a specific page.

The example shows how to set the home page for all Resource documents to 'Library' and direct all documents with the Subject 'Team Announcement' to the 'Announcements' page.

For more information on this topic, please refer to:

Tour
render-as-definition-listtrue
Section
titleMacro Configuration

A number of macros in the PDAC1 refer to space properties for a central configuration.

Here are two examples:

Section
titleRemote Information Systems

Space properties allow to specify URLs to remote information systems to be used by macros of the Information Systems Extension. If the URL to such an information system changes, the URL needs to be edited only in one place.

Display Table
doctypemacro
selectName, Iteration, Short Description
where$<Extension>=[Information Systems Extension]
header-translationsIteration=Status
render-counter-columntrue

Note Box

Prior to version 1.11 of the projectdoc Toolbox these macros where part of the add-on. We decided to move them to an extension add-on since they are not required by all users. The extension is available for free, but needs the commercial projectdoc Toolbox Add-on installed.

Section
titleRendering Configuration

The Code Block Placeholder Macro takes advantage of space properties. You may for example define a default language with the code-language property.

...