Versions Compared

Key

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

...

Document Properties Marker
extract-short-desctrue
render-asdefinition-list


Short DescriptionThis is a tour through the documentation for users that want to design their own set of templates or just want to create one or two templates. 
Doctypetourhide
NameTour for Template Authors 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesTemplate Author, Documentation Architect
propertyAudience
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Iteration
Iteration
valuefocused
hide
Sort Key000300hide



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
excludeDescription

Section
titleA single Template or a Blueprint?

First the template author has to find out, where the new template should be created. There are basically two options:

  • Define a new template with the Confluence server
  • Add the new template to a project of Blueprints

It is usually the job of the documentation architect to define the process of creating a new template. So template authors may have to consult their colleague for advice on how to start.

We find it easier to define a project of Blueprints to add page and space blueprints for a specific set of projects. This way we have a project stored in our source control and release changes from time to time.

Info Box


Transclusion
documentDoctype Add-on Sources
idsAll

Refer

We plan to release our free doctype add-ons as open source projects on an open source repository. We hope that this will make it easier for teams to start their own projects.

In the meantime, please refer to the documentation provided by the Confluence team to get started with Confluence Blueprints:

Also have a look at Context Provider for information on useful context provider classes provided by projectdoc.



projectdoc-section
titleThe Template

The template is an XML file. It is part of a page blueprint as defined by Confluence. What is specific to projectdoc is the basic structure it mandates. While Confluence puts no restriction on how your template looks like, projectdoc demands that the template author lists the properties and sections that are provided by a document type.

So this is the first task to accomplish: What are the document type's properties and sections?

...

Section
titleSubordinate Tours
Display Table
doctypetour
render-no-hits-as-blanktrue
selectName, Short Description
sort-bySort Key, Name
restrict-to-immediate-childrentrue
sort-bySort Key, Name


Section
required-permissionswrite-access
titleNotes

...