projectdoc Toolbox

Document the semantics of a tag. May also be used to document Confluence labels.

ID
tag
Suite
Documentation Type
Categories
Tags
Title Encoding

Description

Documents the semantics of a tag. May also be used to document Confluence labels.

Tags do not exist for only a subset of document types. Therefore tags require a unique meaning for all doctypes.

Properties

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

Subordinate Tags

Usually tags are not hierarchic. But it may be more easy to use tags, if they are grouped.

Documents

List of documents that are associated with this tag.

Per default only documents within the same space are listed. If you want to reference

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

Grouping by Parentship

While categories and tags are added to documents as properties, to add semantic structure to a documentation, structure can also imposed by the parent relationship.

Taglist Macro

The Tag List Macro adds all labels of the page to the set of tags for this document. Use this macro to specify values for the Tags property within the Document Properties Marker Macro.

Title Encoding

Spaces are limited such that there can only be one page with a given title. Tags typically define an alternate view on a topic. There may be other documents with the same title, but of different document types. Therefore Tags prepend a hashmark ('#') in front of the name.

You may check the box on the wizard to create a new tag to care for this conventional encoding.

Available since version 1.10.

Related Doctypes

Category

Categories are part of hierarchies while tags typically have no or shallow hierarchies documents.

Tags are typically easier to use for an adhoc organization. Categories may help to structure the domain with one or more taxonomies. For categories the path to the root is part of the name, for tags it is not.

Resources