You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

projectdoc Toolbox

projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.

Audience
Level of Experience
Expected Duration
5 minutes
Tags
Contents

 

Create Documents

projectdoc is about document properties and document sections.

To define a document add document properties with the Document Properties Marker Macro and document sections with the Section Macro.

There are properties and sections that are available for all document types created by smartics.

 

projectdoc documents are usually defined as page blueprints by the Template Author.

Page Authors select the type of document that suits their requirements and simply add content. If they add new sections they are encouraged to use the Section Macro. But if the content is not meant to be transcluded, authors may decide to use simple HTML headers.

 

 

What is Transclusion?

Transclusion is the inclusion of a document or part of a document into another document by reference.

B is transcluded in the document A.

Wikipedia
What is Single Sourcing?
To single source is to allow the same content to be used in different documents or in various formats. Wikipedia

Select Documents

With properties and sections defined in a document, authors may employ the autolist feature (e.g. the Display Table Macro) to select and list documents.

Select documents by their properties and display properties and sections of the selected documents.

Transclude Sections and Properties

Modular documentation supports reuse and collaboration for your team.

Transclusion of information (i.e. include information from another page) supports single-sourcing (i.e. have information in one and only one place).

Use the Transclusion Macro or the Transclude Documents Macro to transclude sections and the display property macros (e.g. Display Document Property Macro or Display Document Properties Macro) to transclude property values.

A document transcludes information (properties, sections, and page fragments) from other documents.

Resources

The following resources provide information to get started with projectdoc.

projectdoc Introduction
A short introduction into the concepts and features of the projectdoc Toolbox.
Tour for Document Authors
Tour through the documentation for users who want to learn to create documents based on projectdoc doctypes.

projectdoc Introduction
A short introduction into the concepts and features of the projectdoc Toolbox.
projectdoc Document
projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
projectdoc Spaces
projectdoc introduces structure on a Confluence space. It adds the concept of homepages for document types.
projectdoc Space Relationships
projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.
Learning projectdoc
Getting started with the projectdoc Toolbox is not easy. Some basic concepts are more than just good-to-know and the number of macros and doctypes may be simply overwhelming. This tip gives some advice on how to get started.

  • No labels