Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleCreate projectdoc Documents

Creating a projectdoc document is very simple.

Section
titleFrom scratch
  1. Provide Document Properties
    1. Create a blank Confluence page
    2. Add the Document Properties Marker Macro
    3. Add a three columned table to the body of the macro
    4. Mark the first column as table heading column
  2. For each section add a Section Macro
projectdoc-box-warning
titleNo support for Ancestor Queries!

From-scratch pages do not support ancestor queries!

To support these queries you need to define a blueprint (see From a Page Blueprint).

projectdoc-section
titleFrom a Template

This is basically the same as "From scratch" except that in step 1a you create a new template instead of a blank page.

  1. Provide Document Properties
    1. Create a new template
    2. Add the Document Properties Marker Macro
    3. Add a three columned table to the body of the macro
    4. Mark the first column as table heading column
  2. For each section add a Section Macro

New documents are then based on this template.

Warning Box
titleNo support for Ancestor Queries!

Plain templates do not support ancestor queries!

To support these queries you need to define a blueprint (see From a Page Blueprint).

Section
titleFrom a Page Blueprint

Blueprints are templates authors employ via wizards that support to provide basic information.

New documents are based on such a blueprint. As with templates, the default properties and default sections have already been added.

projectdoc provides a large number of blueprints in form of projectdoc doctype add-ons. These are available on the Atlassian Marketplace (ready to install) and on Bitbucket (in source to adjust and build by yourself).

Note Box
titleSupport for Ancestor Queries

projectdoc documents provided with page blueprints support ancestor queries!

Section
titleWhat is next?

Using projectdoc documents will provide you with all the power you need for working with the projectdoc Toolbox. Here are some topics to increase your fun and success!

Section
titleOverwhelmed with Blueprints?

The large amount of blueprints may be intimidating. But if some blueprints exist that makes the work of a team easier? We recommend that you get a general idea what is available. The blueprints are organized in sets.

Display Table
doctypetopic
render-modedefinition
selectName, Short Description
where$<DirectAncestorTitle>=[Doctypes] && $<Status>=[Available]

Tip Box

A team typically selects a couple of blueprints they decided to use in their work. In Overwhelmed with Blueprints? we describe how the team can focus on these selected blueprints.

Section
titleLearn the basics

To learn more about the projectdoc Toolbox, take your areas of interest from the following list of introduction materials:

Tour
render-as-definition-listtrue
Section
titleRead the Tips

We provide a growing list of tips to show interesting aspects of the working with the projectdoc Toolbox.

Section
titleDelve into more Topics

For more information on the projectdoc Toolbox browse the list of topics or pick a macro.

...