No prior experience.

Topics

Name Space Short Description
Document types (or doctypes for short) define a set of properties and sections. Each doctype matches at least one Confluence Page Blueprint. Confluence Page Blueprints are a collection of templates, but often the collection contains only one element.
Properties are metadata that can be added to every projectdoc document. If you require a set of metadata for each instance of a document type, you should write your own doctype.
The main body of a document is divided into sections. Besides the sections defined by a doctype, an author may add any number of additional sections. Sections that are regularly added to a given doctype should be added to the doctype's template.
The purpose and the differences between the name and title property of a doctype.
Benefits of and tips on writing short descriptions.
Techniques to tag content with arbitrary labels: Tags, Labels, Flags, and Selectors.
Sort keys help to control the sort order of a set of documents. This order seems to come magical for users, since the sort key is usually not displayed. The order establishes a path to a set of documents displayed as a list as the result of a query.
Discussion on whether or not to use more than one heading on level 1.
A short introduction into the concepts and features of the projectdoc Toolbox.
References are links to information that back up the information in this document. Resources refer to additional information to the topic discussed in the document and related information.
Create an index space to learn what it is and what it is used for.
Start with projectdoc by creating a space with the standard blueprint.
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.
projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
Macros to help authors to reference other documents that are relevant to the current document.
Organized information of a context, such as a glossary or an address book, in a dedicated space. These spaces are called attachment spaces.
A template assists authors in writing documents of a given type. Templates help that documents are similar in structure and therefore are also easier to read by members of the project team. projectdoc only renders table rows and sections, if they actually contain information. This reduces clutter to distract readers.
Adjust your Confluence personal space to work as a personal space for projectdoc.
projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.
Macros to help authors to a document structure so that the information is easier to understand.
Add roles to your space and set the audience of a topic document to one of the roles.
Create a space to work on a given topic. This spaces uses an index space to reuse content.
Home and index pages help to organize documents by type. For each doctype there is a homepage and and index page. The homepage shows the central documents that are added to it (immediate children). Index pages list all documents of the space, regardless of their location.
Macros to support single sourcing for creating modular documents.
Learn about properties and sections of a document.
The Display Table Macro allows to specify queries on documents. The documents are listed in a tabular form per default. Authors declare the document properties to be displayed in the columns of the table
Doctypes that help to write modular documentation and therefore support single sourcing.
Macros to render information in a visually appealing format.
Authors use the Display Table Macro to list documents that match a query. This screencast shows how to add one to a document.
Macros that help authors to create templates and content.
These are the generic working horses that are used whenever no specific doctype matches the intention of the author.
Learn about the central most heavily used macros of your projectdoc Toolbox.
Resources describe relevant information for a project. The essential parts are noted to make it easier for finding the most relevant parts quickly. Excerpts allow to add the information as subdocuments.
Organize your spaces with generic and specialized categories.
Macros to support a team to write their documentation collaboratively.
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.
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.
The lifetime of a subdocment is associated with that of its parent. Subdocuments help to organize content within a document by externalizing it. This makes it easier for teams to work on a document together. Referencing parts of the document is also easier.
Checkout further resources on working with projectdoc.
What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.
Sometimes you need to add properties to a set of documents in a given context. This can be handled in two ways: add the property to each document or use the Tour Macro.
Userscripts for Confluence is one way to implement userscripts for users of a Confluence server. This article introduces alternatives.
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content.
Tables often require a lot of space to be rendered. This tip shows how to reduce the demand of space.
Compare the features provided by the projectdoc Toolbox with features that come with Confluence out-of-the-box.
The Display Table Macro provides a quick fix feature to control the width of the table columns.
Screencast to show how the Definition List Macro is used to create definition lists in Confluence.
A gentle introduction to page blueprints provided by doctype add-ons. The page blueprints are grouped semantically to make it easier for users to build a conceptual mind map for them.
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.
Instructions on how to download the artifact of this project.
Instructions on how to download the artifact of this project.
Instructions on how to download the artifact of the Projectmetadata Maven Plugin.
Instructions on how to download the library artifact of the smartics Enforcer Rules for Maven.
Provides information about features potential users should consider for their evaluation process on using the projectdoc Toolbox for Confluence.
Get started with the projectdoc Toolbox: learning by doing
A short introduction to write userscripts for the Userscripts for Confluence App.
A short introduction to manage (add, alter, remove) userscripts with the Userscripts for Confluence App.
Provides information to get new users of projectdoc get started with projectdoc documents and spaces.
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.
projectdoc provides a number of artificial properties for documents. Spaces may inherit properties from delegate spaces. All properties can be accessed by macros of the toolbox.
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).
projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about.
The plugin is part of a development process. Therefore there are some prerequisites to get started.
Screencasts to introduce to the concepts and workings of projectdoc. Users get an impression on how projectdoc works and find information on its concepts.
Provides an overview over the model descriptors to describe the add-on, spaces, and doctypes.
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
A short introduction on compiling projectdoc documents in dynamic lists using constraints.
Use the Section Macro to define sections. This tip introduces the macro by listing its features.
Provides a gentle introduction to the concept of spaces using projectdoc.
Starting with the projectdoc Toolbox might be intimidating at first. So start small using the basic features and add what is needed, when it is needed.
Despite the name of the Topic Doctype, it is not supposed to be used for any topic. Use the Generic Doctype or the Section Doctype for general purposes.
The projectdoc Toolbox provides a lot of macros to create documentation. It also replaces two macros provided by Confluence. The Excerpt Macro and the Page Properties Macro.
List of usage scenarios creating blueprints with the plugin for Maven.
Property values are inherently considered to be a list of strings. Typically this a good thing since it makes working with list of names very easy. Sometimes it makes things more difficult.
Switch views on documents dependent on the user's role by setting space properties in the user's homepage.