projectdoc Toolbox

Node types categorize nodes.

ID
node-type
Suite
Parent
Documentation Type
Categories
Tags
Since
3.0.0

Nodes are organized by their types. Instances of the document type define those types.

Properties

The document type node type 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.

Sections

Description

A more detailed description of the node type than already provided in the short description.

This helps authors to select the appropriate type for their nodes.

Related Indices

Lists space index documents related to this type.

Every space index that references this type by the property Node Type Constraint is listed in this section. This makes it easier for readers to navigate to related information by browsing.

Since 11.1

 

This section is available since version 11.1.

Subordinate Types

List subtypes of this type.

Nodes of this Type

An overview over nodes of this type.

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.

Related Doctypes

Here is a list of related doctypes to document system environments.

Artifact
Document requirements you impose on artifacts. Artifacts are created by processes defined and used by the team. This includes assemblies created by the build process, source code artifacts or reports.
Artifact Type
Artifact types categorize artifacts.
Environment
Document logical or physical groups of nodes.
Environment Type
Type of an environment used by the project to deploy the application or the solution.
Node
Nodes are part of environments where artifacts are deployed to.