- Created by Robert Reiner, last modified on 03. Jun 2018
projectdoc Toolbox
Never be limited to the vendor's ideas: Create your own spaces, templates/blueprints/doctypes and macros based on components provided by the projectdoc Toolbox!
The projectdoc Toolbox for Confluence is a set of tools to support you and your team to define your own page blueprints and space blueprints. It also allows you to build your own macros based on the infrastructure the projectdoc Toolbox provides.
Note that the Java API is currently not stable. Therefore we recommend to do the integration work for your tools by the use of the Web API Extension.
If you do need to use our Java API we recommend to get in touch!
To define your blueprints, you could use any approach that allows you to use macros from the projectdoc Toolbox. Make sure that your page blueprint creates a projectdoc Document!
Consider to use the Doctype Maven Plugin to define your project based on the projectdoc Toolbox on models. These models hide some of the more complex requirements to build your blueprint add-on.
Note that we call page blueprints doctypes since these doctypes provide some more features than blueprints do.
Also note that you need programming skills, especially you need to know how to work with Maven to create a deployable artifact from a project.
Resources
More information on this feature.
- projectdoc Document
- projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
- Document Type
- A document type (doctype) defines the properties and section for document instances. It also provides home and index pages. In Confluence these doctypes are implemented as page blueprints, usually with one template. This template is used to create new pages in Confluence.
- Web API Extension
- Add-on to extend projectdoc with an API to access on the web.
- Doctype Maven Plugin
- Create doctype add-ons (OBRs) for the projectdoc Toolbox with Confluence Blueprints based on XML model descriptions easily!
- Guided Writing & clutter-free Reading
- Do not clutter the view with non-information sections. Instead help authors writing identical structured content by the use of templates.
- Document Types
- Document types allow to guide authors producing information of a given type. They also help readers to find the information they are looking for quickly.
More Features
List of features of the projectdoc Toolbox for Confluence.
- Deep Links
- With deep links properties from referenced properties can be accessed for rendering.
- Default Locations
- Document types have their default location within a documentation space. These default locations are called 'homepages'. If authors create new documents they can send them to these default locations within a given space. Delegate spaces expand this feature to find the default location in associated spaces.
- Delegate Document
- Delegating documents transclude sections and properties from a delegate document. Information may be overridden.
- Document Types
- Document types allow to guide authors producing information of a given type. They also help readers to find the information they are looking for quickly.
- Dynamic Linking
- A document template that uses query macros enables documents to dynamically render links to a set of related documents. If new documents are added to the system that meet the query criteria, links to these documents are automatically added to the querying document. This feature is also called dynamic lists or automatic linking.
- Enhanced Transclusion
- Transclude more than one self-contained snippet and mark transcluded information for authors. The projectdoc toolbox allows multi-transclusion from one document and even several documents.
- Guided Writing & clutter-free Reading
- Do not clutter the view with non-information sections. Instead help authors writing identical structured content by the use of templates.
- Information Systems Integration
- Via a free extension information from remote information systems may be rendered on a wiki page.
- Live Templates / Impersonator
- Use the structure from a page and render it in the current page's context.
- Remote Control
- The projectdoc Toolbox supports rendering a page controlled by request properties. This way a URL controls the contents of a page.
- Rich Custom Document Metadata
- Authors may add any metadata to a document and use these in their queries. The metadata may be displayed or hidden. This way authors can use metadata target at the reader and metadata used for authoring purpose.
- Single Sourcing
- The projectdoc Toolbox provides doctypes and macros to support teams to modularize their documentation.
- Space Hierarchies
- Organize spaces in hierachies with delegate and search spaces.
- Space Properties
- Properties may be set on space level and are inherited through space hierarchies.
- Variables
- Space and document properties may be used as variables with the projectdoc Toolbox.
- Web API
- To integrate projectdoc documents with remote systems the projectdoc Toolbox provides a REST API. This API is installed separately with a free extension add-on.
