projectdoc Toolbox

Space shortcuts

Page tree

projectdoc Toolbox


Section

Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents.

ID
section
Suite
Core
Documentation Type
Categories
/ Document / Part
Tags
Since
1.0

Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents.

In contrast to modules, sections are not intended to be used by other documents (but they may be used by reference or transclusion). The lifetime of a section is, contrary to modules, bound to the lifetime of its parent document. That is, if the parent document, this section is part of, is deleted, so is the section. Modules on the other side are not bound to the lifetime of documents that reference or transclude them.

If you do not want subdocuments to be bound to the lifetime of the parent document, use another doctype, usually Topics.

Properties

The document type section 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

Subordinate Sections

Lists subsections attached as child documents.

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

Naming

The association of a section document with its parent is by adding the title of the parent document to the title of the section document. This helps to make the document's name unique within the space.

In addition it is usually a subdocument with a parent reference in the document properties section.

Related Doctypes

Excerpt

Excerpts are specific sections that are only applicable as children to resource documents. They are meant to summarize parts of the content of the resource.

Generic

A generic document is a toplevel document that is not associated with its parent.

Resources

Title Short Description
Section in Action
Use the Section Macro to define sections. This tip introduces the macro by listing its features.
Modularization
Using sections and modules to organize and reference content.
Colored Sections and Boxes
Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content.
Heading Level Transposition
Reusing sections typically includes the transcluded content to match the document structure of the transcluding document. The projectdoc Toolbox does this automatically.
Topic is not meant to be multi-purpose
Despite the name of the Topic Doctype, it is not supposed to be used for any topic. Use the Generic Doctype or the Section Doctype for general purposes.
The hidden Section
The Content Marker Macro identifies content that can be displayed using the Display Table Macro. This is a short tip on how to transclude content from a projectdoc document.
Transclude transcluded Sections
Shows how to transclude transcluded content.
No need to render the Section Title
It is often obvious that the introduction text is a description of the information of the document. Therefore the title 'Description' or 'Summary' may be irrelevant. You may suppress the rendering of the title easily.
Content Marker Macro
Marks a piece of content within a document. This content can be referenced for transclusion.

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