Child pages
  • Template Author


Template authors create templates to be used by the team.

Group
projectdoc-template-authors

Resources

Name Short Description Doctype Audience
tour
This 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.
tour
Doctypes to help organize the space. This includes homepages for particular information (like the homepages for each doctype) and tours that provide a specific view on existing documentation.
topic
Agile documentation is not another buzzword. There is actually a set of rules to follow which will lead to meaningful documentation. Writing helpful documentation is not easy, but it gets a lot easier with the agile mindset - and with the projectdoc Toolbox.
topic
The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in an ancestor context.
topic
Add a document as a child and automatically make supplied properties available in the parent.
topic
Prefix the title with an automatically incremented identifier.
topic
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
topic
Lists the configuration options for template authors to control page creation.
topic
Macros to support a team to write their documentation collaboratively.
topic
Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content.
topic
The Display Table Macro allows to render the values for a collection of properties for compact tables. With Version 4.5 this feature is also supported by the Tour Macro. This tip shows how to use it.
topic
Discard unwanted references in manually compiled lists with the projectdoc Toolbox on Confluence.
topic
The main purpose of content providers is to add additional context entries for the blueprints provided by an add-on. projectdoc defines a number of context providers to be used by add-on developers.
topic
The Display Table Macro provides a quick fix feature to control the width of the table columns.
topic
Deep links can be used on both sides of predicates in a Where Clause.
topic
Doctypes and the Name List Macro allow to specify a range of valid tokens for a value. These values can be rendered by applying specific CSS styles.
topic
Macros that help authors to create templates and content.
topic
These are the generic working horses that are used whenever no specific doctype matches the intention of the author.
topic
We like to think of document properties as metadata. But in some contexts it is natural to think of them as data for the entity described by the document.
topic
Introduces to the concept of content to be considered to be empty.
topic
Categories that are defined to be used with any doctype. So any document instance defined for these categories has to make sense for any doctype.
topic
What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.
topic
There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence.
topic
Writing page blueprints includes to configure wizards for easy page creation. If the field identifier contains dots there is a problem with a simple solution.
topic
In case an author requires to identify document elements to readers, for instance a numbering of paragraphs or sentences, the Content Marker Macro allows to employ a page-related auto-numbering and provides means to specify the format for these consecutive numbers.
topic
A short introduction using the impersonator feature of the projectdoc Toolbox. In this example we examine what to do to reuse a layout defined in another document.
topic
Shows how to import properties from another document to be applied to placeholders in transclusions.
topic
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.
topic
Show how to use the Name List Macro to render links to glossary terms.
topic
Listing related pages to a page is quite easy using the projectdoc Toolbox.
topic
Using existing properties from other documents.
topic
Shows how content can be decomposed and merged. This feature can be used to allow transclusion of single sentences and render all sentences in a single paragraph.
topic
References listed in tables and lists may come from different sources. The Table Merger Macro allows to render a number of tables (or lists) as one table (or list).
topic
Doctypes that help to write modular documentation and therefore support single sourcing.
topic
Macros to support single sourcing for creating modular documents.
topic
Using sections and modules to organize and reference content.
topic
Categories provide easy navigation. The category page documenting the category automatically lists all documents tagged with this category. A defined set of categories has per default no such homepage.
topic
The projectdoc Toolbox does not support dynamic values as property values. Use sections to render dynamic values and select the contents of this section instead of property values.
topic
The pages wizards provide placeholder to make page creation easier.
topic
projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about.
topic
projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
topic
projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.
topic
projectdoc introduces structure on a Confluence space. It adds the concept of homepages for document types.
topic
Macros to help authors to reference other documents that are relevant to the current document.
topic
Changing the rendered contents of a projectdoc document dynamically for each request.
topic
Alter the rendering of macros of transcluded content with remote controls.
topic
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
topic
A short introduction on compiling projectdoc documents in dynamic lists using constraints.
topic
Use the Section Macro to define sections. This tip introduces the macro by listing its features.
topic
A list of doctypes that have a specific purpose. The core doctypes are none-the-less quite generic so that they can be used in almost any project.
topic
Macros to help authors to a document structure so that the information is easier to understand.
topic
Subdocuments are associated with the lifetime of the parent document. The section doctype is the most generic type of document, but there are others, that are specific to a certain doctype.
topic
The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in a document tree with a given root.
topic
Show how to import properties from other projectdoc documents into a projectdoc document.
topic
Tools from the projectdoc Toolbox to allow users to browse for information.
topic
Links allow readers to find related information. Autocomplete allows authors to recall the names of related information. Let's have a closer look on the Autocomplete Feature of the projectdoc Toolbox!
topic
List of variables provided in the blueprint context for templates.
topic
Shows how to use the Wiki Link Macro based on Remote Controls to alternate between two different views on a single document.
topic
Keeping track of transclusions using artificial properties.
topic
Categories that are defined to be used for a specific doctype. May be used for a couple of doctypes, but is not intended to make sense for any doctype.
topic
A collection of macros supports dynamic parameters that may be controlled remotely or by their context. This tip provides some information on context controlled macros.
topic
Add a document as a child and automatically make supplied properties and sections available in the parent. A short walk-through to use the Aspect Feature in your information architecture.
topic
Space properties are defined for spaces and are accessed via the Space Property Macro. This tip goes into detail in how to use space properties with inheritence and extension pages.
topic
The projectdoc Toolbox provides an interface for template authors to replace placeholders with space and context properties.
topic
Macros to render information in a visually appealing format.
topic
The projectdoc Toolbox makes it easier to create links for navigation for users to browse the documentation. This tip explains some the concept in the context of organization, person, role, and stakeholder.
topic