projectdoc Toolbox

Introductional Topics

Topics for novice users and advanced beginners.

Basic Concepts and Conventions for projectdoc
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
Compare with built-in Features
Compare the features provided by the projectdoc Toolbox with features that come with Confluence out-of-the-box.
Definition List Macro in Action
Screencast to show how the Definition List Macro is used to create definition lists in Confluence.
Doctypes Introduction
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.
Evaluation Topics
Provides information about features potential users should consider for their evaluation process on using the projectdoc Toolbox for Confluence.
Hands-on Tutorial
Get started with the projectdoc Toolbox: learning by doing
Highlights
Lost in wiki space? Blank-Wikipage-Syndrome? Where to add? How to find? No fun anymore?
Installation Guide
Installing the projectdoc Toolbox on Confluence is very easy.
Introduction for new Users
Provides information to get new users of projectdoc get started with projectdoc documents and spaces.
Macros Introduction
This is a gentle introduction to the core macros. The macros are grouped semantically to make it easier for users to build a conceptual mind map for them.
projectdoc in Action
Screencasts to introduce to the concepts and workings of projectdoc. Users get an impression on how projectdoc works and find information on its concepts.
Spaces Introduction
Provides a gentle introduction to the concept of spaces using projectdoc.
Tips
List of tips to use Confluence with the projectdoc Toolbox and fun! Tips address users of different experience levels.
Using projectdoc to document Maven Plugins
We decided to move our documentation from the XDoc format to projectdoc on Confluence. This allows us to update the information independent of the release cycles of the products. Here are some tips on how to use projectdoc for this task.

Hot Topics

The following lists topics we consider to be important for the daily work with the projectdoc Toolbox.

Search Tips
Tips on specifying search queries for Lucene. This also applies to projectdoc's query macros.
Tips
List of tips to use Confluence with the projectdoc Toolbox and fun! Tips address users of different experience levels.
Artificial Properties
In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.
Space Properties
Lists the configuration options at space level.
Cache Refresh Actions
projectdoc documents are stored in caches for quick access. Users may want to clear one of these caches.

Main Topics

A list of articles that provide information on design principles and conventions of the projectdoc Toolbox.

To read topics in a given context, please refer to the projectdoc tours.

Autocomplete
Support for users of projectdoc macros to select from a range of valid values.
Autoconvert Information System URIs
Introduction to the autoconvert feature for URIs to external systems.
Categories of Information System Macros
Overview over the different categories of macros that are part of the Information Systems Extension.
Category Trees
Download JSON documents to create category trees.
Export Metadata
Export document properties as metadata to the rendered HTML page.
Fragments Cache for Transclusions
Information on how to use the fragments cache.
Localization
Using projectdoc with a non-supported locale (language) works, but lacks some of its features. This short topic provides some details on this matter.
Name Refactorings
A short overview over tools in the projectdoc Toolbox that support authors and information architects to rename elements of their technical documentation.
Projects using the projectdoc Toolbox
Lists projects that use the projectdoc Toolbox for their documentation. We include real projects as well as interesting examples.
Properties Update
Properties are not updated transitively. Users may refresh documents via page tools.
Prototypes
Reusing type instances for documents.
Space Wizard Parameters
List of parameters to control the context when creating spaces with the projectdoc Toolbox.
Use Doctype Name as Border Image
With the doctypeBorderImageServlet and some custom CSS it is possible to render a border image that contains the doctype name of the currently displayed Confluence page.
User Macro Integration
A short introduction to use projectdoc services in the context of velocity to integrate with user macros.

References

The following topics are references to lookup information.

Artificial Properties
In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.
Blueprint Properties
Lists the configuration options for template authors to control page creation.
Cache Refresh Actions
projectdoc documents are stored in caches for quick access. Users may want to clear one of these caches.
CSS Styles
Lists CSS selectors provided by the projectdoc Toolbox to apply styles.
Doctypes Overview
List of all doctypes provided by add-ons. Provides an overview over doctype IDs and blueprint keys.
Document Property Controls
Lists valid controls for properties to be used in document properties tables.
Information System Macros
List of macros linking to or transcluding from external information systems.
Lucene Search Fields
Names for fields added to the Lucene search index.
Page Wizard Placeholder
The pages wizards provide placeholder to make page creation easier.
projectdoc Doctype Add-ons
Doctype add-ons provide space and page blueprints based on macros from the projectdoc Toolbox.
projectdoc Extensions
Extensions augment the projectdoc Toolbox. Features that are not relevant for all users are separated and may be installed on-demand by customers of the Toolbox.
projectdoc System Properties
Lists recognized system properties specified on the command line for starting the Confluence server.
Search Tips
Tips on specifying search queries for Lucene. This also applies to projectdoc's query macros.
Space Properties
Lists the configuration options at space level.
Space Property Controls
Lists valid controls for properties to be used as space properties.
Trouble Shooting
List of issues encountered with the projectdoc Toolbox and solutions or workarounds to resolve them.

Topics for Template Authors

The following topics are for creators of doctype templates.

Auto Increment in Title
Prefix the title with an automatically incremented identifier.
Basic Concepts and Conventions for projectdoc
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
Blueprint Properties
Lists the configuration options for template authors to control page creation.
Context Provider
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.
Page Wizard Placeholder
The pages wizards provide placeholder to make page creation easier.
Template Variables
List of variables provided in the blueprint context for templates.
Variables for Blueprints
The projectdoc Toolbox provides an interface for template authors to replace placeholders with space and context properties.

Related Documentation

The following links direct you to related documentation within this wiki.