Versions Compared

Key

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

...

Section
show-titlefalse
titleDescription

A template author's job is to define templates that help the team to create documents for a given type of information. Maybe there is already a template that the template author can use and adjust. But sometimes it is required to define a new set of templates or design a template for a new kind of information that is relevant for the project.

Writing templates is one of the great supporters for teams defining their way of documenting their project. projectdoc helps to make this task much easier.

This tour shows how to accomplish the task of writing a new template with projectdoc macros.

The tour assumes that the template author adds a new template to the project. This tour will not show the details on how to edit the atlassian-plugin.xml or where to place the template and the additional JavaScript et al. files.

This tour shows how to create the XML template file and link to the projectdoc macros that help you to define this template.

Tip Box
titleBasics for the projectdoc Toolbox

Before creating a new doctype, make sure that none of the existing doctypes really fits.

Doctypes Introduction is a gentle introduction to the core doctypes. The Doctypes page provides an overview of all doctypes provided by extension add-ons.


Tip Box
titleTool Support

Since there is nothing special with projectdoc documents besides the need for properties and sections, you can probably use any tool to create your Confluence Blueprints.

The Doctype Maven Plugin provides an alternative approach to create your doctypes based on a model.


Table of Contents
outlinetrue
excludeDescription
stylenone

...