projectdoc Toolbox

Space shortcuts

Page tree

projectdoc Toolbox


Subject

Subject documents allow to set document instance of different doctypes in a common context.

ID
subject
Suite
Core
Documentation Type
Q1 - Process
Categories
/ Organisation / Generic
Tags
Title Encoding
§

Description

Subjects allow to set document instance of different doctypes in a common context.

Properties

The document type subject provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

No further properties are provided.

Sections

Description

Documents the semantics of the subject.

Subordinate Subjects

Add additional aspects of a subject as children to this document.

Documents

Automatically collect documents with this subject.

 

Typically the collection of documents is limited to documents in this space. If there is the Search Space property defined for the space, additional spaces may be included in this search. For global spaces it may be handy to define the @all value for the search space of - for instance - the Display Table Macro.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.

Details

Title Encoding

Spaces are limited such that there can only be one page with a given title. Subjects typically define an alternate view on a topic. There may be other documents with the same title, but of different document types. Therefore Subjects prepend a paragraph ('§') separated by a space in front of the name.You may check the box on the wizard to create a new subject to care for this conventional encoding.

Available since version 1.10.

Related Doctypes

Topics

While topics provides information in a chosen format, the Subject Doctype allows to group information independent of the document types. A subject references work your and your team try to accomplish or need to collect information about.

Tags and Categories

Tags and Categories are similar to Subject. But Categories build hierarchies, while tags do not convey the notion of a dedicated goal. While you usually associate a document with multiple tags and probably more than one category, you usually select a single subject.

Use subjects to group your or your team's work together and to keep track which subjects are relevant for your project.

Resources

Subject
Subject properties allow to set document instance of different doctypes in a common context.
Subject Home
A space property to control the location of the homepage of a given subject. Use the name of the subject to define the space property name. The value is a link to the page to store documents associated with the specified subject. Only available for versions prior to 2.0.

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH