projectdoc Toolbox

Topic Index

List of all topics.

Name	Short Description	Parent
(Not) Using Templates with Variables	Shows what to expect when using variables in 'User Created Templates' or 'Global Templates'.	Tips
Document Types and Templates	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.	Basic Concepts and Conventions for projectdoc
Document Properties	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.	Basic Concepts and Conventions for projectdoc
Document Sections	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.	Basic Concepts and Conventions for projectdoc
Core Doctypes	Provides a basic set of doctypes to create agile documentation.
Developer Diaries	A short introduction to developer diaries.	projectdoc Developer Diaries
Name and Title	The purpose and the differences between the name and title property of a doctype.	Basic Concepts and Conventions for projectdoc
Page Properties and Document Properties	Explains the differences between and commonalities of the Confluence Page Properties and the projectdoc Toolbox Document Properties.	Compare with built-in Features
Writing Short Descriptions	Benefits of and tips on writing short descriptions.	Basic Concepts and Conventions for projectdoc
Excerpt and Transclusion	Explains the differences between and commonalities of the Confluence Excerpt and the projectdoc Toolbox Transclusion features.	Compare with built-in Features
Rendering Code Fragments	Explains the differences between and commonalities of the Confluence Code Block Macro and the projectdoc Toolbox Code Block Placeholder Macro.	Compare with built-in Features
Tagging Documents	Techniques to tag content with arbitrary labels: Tags, Labels, Flags, and Selectors.	Basic Concepts and Conventions for projectdoc
Remote Transclusion	Lists features of the projectdoc Toolbox according transclusion of text content that is stored on remote information system. Macros to transclude content provided by Confluence out-of-the-box are compared to these features.	Compare with built-in Features
Using Sort Keys	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.	Basic Concepts and Conventions for projectdoc
Headings	Discussion on whether or not to use more than one heading on level 1.	Basic Concepts and Conventions for projectdoc
projectdoc Introduction	A short introduction into the concepts and features of the projectdoc Toolbox.
References and Resources	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.	Basic Concepts and Conventions for projectdoc
The Beauty of Sections	Compare the way of creating and maintaining sections in Confluence with and without the projectdoc Toolbox.	Compare with built-in Features
Create a Space	Start with projectdoc by creating a space with the standard blueprint.	projectdoc in Action
Create an Index Space	Create an index space to learn what it is and what it is used for.	Hands-on Tutorial
Doctypes for Software Development	Provides doctypes to create documentation in software development projects. The focus is on documenting the architecture of the product, but it includes templates for other software development documentation requirements as well.
Generic Categories	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.	Doctypes Introduction
Project Documentation Basics	Software documentation is a large field to communicate with different stakeholders with different information needs. This topic introduces to the basics of documenting a project with a wiki.	How to document a Software Development Project
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.	Introduction for new Users
Referencing Macros	Macros to help authors to reference other documents that are relevant to the current document.	Macros Introduction
Working with OKRs	A short introduction on how the doctype is intended to be used to work with OKRs.
projectdoc Add-on for arc42	Provides doctypes to document a system or software architecture based on the arc42 Template.
Create an Attachment Space	Organized information of a context, such as a glossary or an address book, in a dedicated space. These spaces are called attachment spaces.	Hands-on Tutorial
Create your Software Documentation Space	How to create a space to start documenting your software architecture or software system using the projectdoc Toolbox for Confluence and additional free add-ons.	How to document a Software Development Project
Micro Structure	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.	projectdoc in Action
projectdoc Spaces	projectdoc introduces structure on a Confluence space. It adds the concept of homepages for document types.	Introduction for new Users
Create a Personal Space	Adjust your Confluence personal space to work as a personal space for projectdoc.	Hands-on Tutorial
Doctypes for Agile Planning	Provides doctypes to collborate with your team. Run iterations and record discoveries that may be of interest at the end of the iteration or for even later reference. Quick notes are more easily added as records to the team's space than to the official documentation tree. Defer the talk to the documentation architect to the end of the iteration (if the discovery is still of interest).
projectdoc Space Relationships	projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.	Introduction for new Users
Software Project Documentation	How to start your software project documentation? Here are the steps to get started with Confluence and the projectdoc Toolbox.	How to document a Software Development Project
Structuring Macros	Macros to help authors to a document structure so that the information is easier to understand.	Macros Introduction
Type-specific Categories	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.	Doctypes Introduction
Using Roles	Add roles to your space and set the audience of a topic document to one of the roles.	projectdoc in Action
projectdoc Developer Diaries	Provides doctypes to organize the developer's work by the employment of a diary. Take you personal planning and professional records to the next level!
projectdoc for Java Developers	A collection of blueprints for Confluence to create and work with documentation for Java projects.
projectdoc for Maven Developers	A collection of blueprints for Confluence to create and work with documentation for Maven projects.
Aggregating Doctypes	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.	Doctypes Introduction
Create a Workspace	Create a space to work on a given topic. This spaces uses an index space to reuse content.	Hands-on Tutorial
Doctypes for Teamwork	Provides doctypes to define the checklists, processes, patterns, tools, and rules your team agrees upon. Writing them down makes them accessible for anyone - especially for new team members. Keep these documents short and to the point!
Home and Index Pages	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.	projectdoc in Action
Modular Documentation Macros	Macros to support single sourcing for creating modular documents.	Macros Introduction
Doctypes for Business Strategy	Mission, vision, strategy for business planning and execution.
Doctypes for Service Management	Provides doctypes to document services and systems for IT service management (ITSM).
Doctypes in Detail	Learn about properties and sections of a document.	Hands-on Tutorial
Edit Display Table	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	projectdoc in Action
Modular Content Doctypes	Doctypes that help to write modular documentation and therefore support single sourcing.	Doctypes Introduction
Visual Macros	Macros to render information in a visually appealing format.	Macros Introduction
Add Display Table Macro	Authors use the Display Table Macro to list documents that match a query. This screencast shows how to add one to a document.	projectdoc in Action
Doctypes for Project Management	Provides doctypes for documenting decisions, risks, open issues, and meeting minutes.
Doctypes for Risk Management	Provides doctypes for documenting and tracking risks.
Document Development Macros	Macros that help authors to create templates and content.	Macros Introduction
Documenting Doctypes	These are the generic working horses that are used whenever no specific doctype matches the intention of the author.	Doctypes Introduction
The Workhorse Macros	Learn about the central most heavily used macros of your projectdoc Toolbox.	Hands-on Tutorial
Add Excerpts to a Resource	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.	projectdoc in Action
Categorization	Organize your spaces with generic and specialized categories.	Hands-on Tutorial
Collaboration Macros	Macros to support a team to write their documentation collaboratively.	Macros Introduction
Doctypes for App Manuals	Document macros, page blueprints, space blueprints, and components of your Confluence add-on.
Subordinate Documents	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.	Doctypes Introduction
Doctypes for V-Modell^®XT	Use products (templates) from the V-Modell^®XT in your Confluence wiki as blueprints!
Specific Doctypes	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.	Doctypes Introduction
Using Subdocuments	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.	projectdoc in Action
What's next?	Checkout further resources on working with projectdoc.	Hands-on Tutorial
Generic Doctypes	What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.	Doctypes Introduction
Using Subdocuments with Transclusion	Instead of a table listing the name and properties of the subdocuments, transclude the content into the parent document.	projectdoc in Action
Autolists	Autolist macros allow to display a list of documents dependent on a set of properties. This screencast shows how to use the Display Table macro to select all documents tagged with a given keyword.	projectdoc in Action
Query Configuration	Controls the parameter to use for running queries with the projectdoc Toolbox.	Configuration
Dynamic Property Value Handling	Configuration to control how the projectdoc Toolbox handles property values with dynamic content.	Configuration
Organize Pages and Spaces	Use or define page blueprints with properties / metadata and sections that render only if they actually contain information. Use or define space blueprints with homepages for document types for dynamic organization.	Highlights
Index Space	Index spaces provide basic configuration via space properties and homepages for commonly used document types.	Show Cases
Space Properties in Index Space	Space properties that need to be seen by all spaces are defined in the index space.	Index Space
Address Book	Organize information about persons and organizations.	Show Cases
Common generic Types	Index spaces also define generic types that are used by all doctypes.	Index Space
Common type-specific Types	Index spaces define type-specific types that are commonly used throughout spaces.	Index Space
Library Space	A library space holds resources in a separate repository.	Show Cases
Default Homepages	Document type homepages in the index space serve as automatic homepages if the current space lacks a homepage for that document type.	Index Space
Glossary Space	Attachment space for defining or describing terms of one or more domains.	Show Cases
Team Space	A sample space for the collaboration of an agile team.	Show Cases
Learning Center	A sample space for tracking skills of members of an organization.	Show Cases
Modular Documentation	Use rich multi-excerpts (transclusion) for content reuse - even from page result lists. Replace parameters in excerpts. Include properties and sections from pages. Hide content dependent on roles and properties.	Highlights
Enhance Navigability	Add new content to be dynamically listed in existing documents. Create complex property reports with a Select-From-Where syntax. Transclude or link to texts fragments and images locally or on remote servers.	Highlights
Accessing projectdoc Properties with cURL	Learn how to access projectdoc properties via REST API with cURL.	Tips
Accessing projectdoc Space Properties with cURL	Learn how to access projectdoc space properties via REST API with cURL.	Tips
Add HTML Meta Tags	Add HTML meta tags to your Confluence pages. This is for the search engine optimization (SEO) for your website as well as adding semantics for machine reading.	Tips
Additional Properties	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.	Tips
Agile Documentation	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.	Tips
Ancestor Queries	The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in an ancestor context.	Tips
Annotate Dynamic Lists	It is pretty easy to annotate dynamic lists with the projectdoc Toolbox on Confluence.	Tips
arc42 Promotion	A promotion to celebrate arc42's anniversary!
Artificial Properties	In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.
Aspects light	Add a document as a child and automatically make supplied properties available in the parent.	Tips
Auto Increment in Title	Prefix the title with an automatically incremented identifier.
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.
Automatic Lists	Automatic lists are part of every Confluence instance. Especially the Dashboard lists all recent changes automatically. And there are macros to list documents by label and other properties. The projectdoc Toolbox supports queries on any properties defined for your documents. This allows you to provide lists of references to your readers that are relevant in a given context.	Tips
Basic Concepts and Conventions for projectdoc	Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
Being a Pretender	Authors occasionally need to have a look at a page as if they where in the role of a reader. The pretend-being-a user space property supports switching roles. With the use of the Web API Extension and the Bookmarklets Extension switching roles is now really easy!	Tips
Blueprint Properties	Lists the configuration options for template authors to control page creation.
Bookmarklets Extension	Add-on to extend the Toolkit with Bookmarklets. Allows to execute tools via the browser.	projectdoc Extensions
Bookmarklets for projectdoc	A short overview on how to use bookmarklets in your browser to add additional features using the projectdoc Toolbox for Confluence.	Tips
Cache Refresh Actions	projectdoc documents are stored in caches for quick access. Users may want to clear one of these caches.
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.
Changing Names	A name in projectdoc used to identify a document is not considered a hard reference. When changing the name of a particular document, the references to the original name do not automatically change. This is by design. It may also by the cause of annoyance. This tip provides information how to deal with this.	Tips
Colored Sections and Boxes	Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content.	Tips
Compact Columns	Tables often require a lot of space to be rendered. This tip shows how to reduce the demand of space.	Tips
Compact Columns for Tour Macros	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.	Tips
Compacted Lists	Discard unwanted references in manually compiled lists with the projectdoc Toolbox on Confluence.	Tips
Compare with built-in Features	Compare the features provided by the projectdoc Toolbox with features that come with Confluence out-of-the-box.
Configuration	Information for the configuration options of the projectdoc Toolbox.
Confluence as the Information Hub	Tools from the projectdoc Toolbox to import from and export to other information systems.	Tips
Confusing Create-from-Template Macro	The use of the Create-from-Template Macro in the projectdoc blueprints may be a bit confusing, especially for new users. Here we provide some insight into what may trouble you -- without knowing in first place.	Trouble Shooting
Content Reuse	The projectdoc Toolbox provides a number of features to help teams to reuse content. Content can be transcluded individually or in form of a multitransclude. Authors can even transclude content from multiple documents in the wiki, effectively combining transclusion with automatic lists.	Tips
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.
Control Column Width with Display Table Macro	The Display Table Macro provides a quick fix feature to control the width of the table columns.	Tips
Create a Diary in a Personal Space	The recommended way of creating a diary with the Developer's Diary Add-on is to add a page with the Diary Template in one's Personal Space.	projectdoc Developer Diaries
Create a Project Glossary	A step-by-step guide to create a glossary with the projectdoc Toolbox.
Create Doctypes with a Model	A short introduction the the Doctype Maven Plugin to generate Confluence Blueprints for projectdoc Doctypes based on an XML description.	Tips
CSS Styles	Lists CSS selectors provided by the projectdoc Toolbox to apply styles.
Deep Links in Queries	Deep links can be used on both sides of predicates in a Where Clause.	Tips
Define Status Tags	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.	Tips
Definition List Macro in Action	Screencast to show how the Definition List Macro is used to create definition lists in Confluence.
Dependency Check Message	A system service to check the compatibility of the projectdoc Toolbox with installed extensions and doctype add-ons.	System Messages
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.
Doctypes Overview	List of all doctypes provided by add-ons. Provides an overview over doctype IDs and blueprint keys.
Document Properties as Data	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.	Tips
Document Property Controls	Lists valid controls for properties to be used in document properties tables.
Documentation Quadrants	A view on documentation to locate types of documents.
Dynamic Property Values	Property values should only change when a document is saved. They should not be dependent on request-time. If they are, then they are called 'dynamic'.
Employ the Autolist Feature with Categories	Categories, tags, and others allow to organize the pages in your wiki. First define categories pages with display table macros. Second tag your pages with these categories. With this two-step process it is easy to have multiple views to link to your information in your wiki.	Tips
Empty Content	Introduces to the concept of content to be considered to be empty.	Tips
Evaluation Topics	Provides information about features potential users should consider for their evaluation process on using the projectdoc Toolbox for Confluence.
Export Metadata	Export document properties as metadata to the rendered HTML page.
Filter on Table Rows	The projectdoc Toolbox for Confluence provides a macro to merge tables. The macro also allows to filter on table rows. This tip provides a short overview.	Tips
Fragments Cache for Transclusions	Information on how to use the fragments cache.
From a Table to Views	Short introduction on using data tables or using views on data.	Tips
Graph Extension	Add-on to extend the projectdoc Toolbox for drawing document graphs.	projectdoc Extensions
Hands-on Tutorial	Get started with the projectdoc Toolbox: learning by doing
Heading Level Transposition	Reusing sections typically includes the transcluded content to match the document structure of the transcluding document. The projectdoc Toolbox does this automatically.	Tips
Hide projectdoc Tools within Browser	The projectdoc Toolbox installs a lot of macros and additional doctype add-ons install a lot of doctypes. This tips shows ways that allow to remove the projectdoc tools from the current page.	Tips
Highlights	Lost in wiki space? Blank-Wikipage-Syndrome? Where to add? How to find? No fun anymore?
How to document a Software Development Project	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.	Doctypes for Software Development
HTML Title as Link Text	The Information Systems Extension for the projectdoc Toolbox allows to render a link with the HTML title as label via autoconvert of the pasted URL.	Tips
Identifiers with Dots	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.	Tips
Identify Document Elements	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.	Tips
Impersonator - using Live Templates	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.	Tips
Import Properties for Transclusion	Shows how to import properties from another document to be applied to placeholders in transclusions.	Tips
Increasing the Document Cache	If you have lots of projectdoc documents then the in-memory properties cache might not perform optimal.	Tips
Information for Audiences	You may want to provide information for specific audiences.	Tips
Information System Macros	List of macros linking to or transcluding from external information systems.
Information Systems Extension	Add-on to extend the projectdoc Toolbox to integrate remote information systems.	projectdoc Extensions
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.
Learning projectdoc	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.	Tips
Limitations on Query Results	The number of hits for document queries is limited due to performance reasons.
Linking to Glossary Terms	Show how to use the Name List Macro to render links to glossary terms.	Tips
List all Properties	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.	Tips
List of Services	Lists all services provided by the Web API Extension.	Web API Extension
List related Pages	Listing related pages to a page is quite easy using the projectdoc Toolbox.	Tips
Living Documentation	Integrate information from different sources into your documentation using Confluence and the projectdoc Toolbox.	Tips
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.
Logging	List of loggers for monitoring projectdoc.
Lucene Search Fields	Names for fields added to the Lucene search index.
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.
Materialize Properties	Using existing properties from other documents.	Tips
Maven Extension	Add-on to extend projectdoc for Confluence with Maven Tools.	projectdoc Extensions
Maven POM Import	Import project information from Maven POM files. Provides information about required configuration to get this import running.	Maven Extension
Merge Content	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.	Tips
Merging Tables and Lists	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).	Tips
Modularization	Using sections and modules to organize and reference content.	Tips
Monitoring Confluence	Have you ever experienced performance problems with your Confluence on premise (Server) installation? This tip might help you.	Tips
Name Refactorings	A short overview over tools in the projectdoc Toolbox that support authors and information architects to rename elements of their technical documentation.
Navigating Documentations	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.	Tips
No dynamic Property Values	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.	Tips
No need to render the Section Title	It is often obvious that the introduction text is a description of the information of the document. Therefore the title 'Description' or 'Summary' may be irrelevant. You may suppress the rendering of the title easily.	Tips
Overwhelmed with Blueprints?	Templates are a great tool to make creating and maintaining documents very easy. Blueprints support authors to create documents based on templates. But a large number of blueprints may make it difficult for authors to select the appropriate template. Here are a few tips on dealing with larger amounts of blueprints.	Tips
Page Wizard Placeholder	The pages wizards provide placeholder to make page creation easier.
Parent Property of projectdoc Documents	projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about.	Tips
projectdoc Bulk Changes to Documents	The Web API Extension for the projectdoc Toolbox can be employed to make bulk changes to documents. Since there is no safety net, these actions need to be take with care. This tip introduces a way to conduct this task.	Tips
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 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.
projectdoc Rebuild Manual	Information for administrators on how to maintain projectdoc documents or to build them from scratch.
projectdoc System Properties	Lists recognized system properties specified on the command line for starting the Confluence server.
projectdoc Toolbox Online Manual	The online manual for version 1 of the projectdoc Toolbox for Confluence.
Projects using the projectdoc Toolbox	Lists projects that use the projectdoc Toolbox for their documentation. We include real projects as well as interesting examples.
Prototypes	Reusing type instances for documents.
Referencing Property Values	Shows how to render the value of a document property with a display macro. There are actually three variants of this macro that we are discussion in this short article.	Tips
Remote Control	Changing the rendered contents of a projectdoc document dynamically for each request.	Tips
Remote Controls for Transclusion	Alter the rendering of macros of transcluded content with remote controls.	Tips
Rendering Navigation Links	There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.	Tips
Reporting	A short introduction on compiling projectdoc documents in dynamic lists using constraints.	Tips
Rescue Confluence Pages	Rescue and restore data of a Confluence page that does not render anymore.	Tips
REST Login to Confluence with cURL	To access Confluence via its REST API with cURL you typically need to authenticate. Learn how to login with cURL and avoid some common security pitfalls.	Tips
Search Filter based on Properties	Show how to use document properties to filter on searches.	Tips
Search Functions	Using functions to run searches with the projectdoc Toolbox.	Tips
Search Space for Index Spaces	Define the default search space for index spaces.	Tips
Search Tips	Tips on specifying search queries for Lucene. This also applies to projectdoc's query macros.
Section in Action	Use the Section Macro to define sections. This tip introduces the macro by listing its features.	Tips
Selection Boxes on ad-hoc Doctypes	Define a doctype on document instances to select from its set of values.	Tips
Show Cases	A set of Confluence spaces showing projectdoc in action.
Space Groups	The projectdoc Toolbox supports organizing collections of spaces. Some of these spaces provide general information, some are specific for a product, a project, or a team. Teams may organize their spaces in groups with shared configuration and information.	Tips
Space Properties	Lists the configuration options at space level.
Space Property Controls	Lists valid controls for properties to be used as space properties.
Space Wizard Parameters	List of parameters to control the context when creating spaces with the projectdoc Toolbox.
Spaces Introduction	Provides a gentle introduction to the concept of spaces using projectdoc.
Specify Doctype Homepage	It is easy to define the default homepage for a given doctype in a space.	Tips
Styling	Information on how to apply styles to your space using the OKRs doctype add-on.
Subtree Queries	The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in a document tree with a given root.	Tips
Supply Documents	Show how to import properties from other projectdoc documents into a projectdoc document.	Tips
Support Browsing	Tools from the projectdoc Toolbox to allow users to browse for information.	Tips
Support Recalling	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!	Tips
System Identifier to URI Resolution Algorithm	Describes how the system calculates the URI to an information system based on its identifier.
System Messages	Overview over system messages displayed in the browser or in a log file.
Tasks as Property Values	Properties may represent an editable boolean value. Use Confluence tasks to define the value for those properties.	Tips
Teamwork to create a Paper	To investigate on a topic or to create a positioning paper collaboratively with a team, a workspace is a handy tool. Information is collected and arranged and the results may be exported to a PDF to be send to interested stakeholders.
Template Button fails to create Document	Instead of creating a new document instance for a doctype, the template button macro only logs an error to the browser's console.	Trouble Shooting
Template Variables	List of variables provided in the blueprint context for templates.
The hidden Section	The Content Marker Macro identifies content that can be displayed using the Display Table Macro. This is a short tip on how to transclude content from a projectdoc document.	Tips
Think big, start small	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.	Tips
Think Repositories	To organize your documentation place documents in a typed repository and add additional views on demand.	Tips
Tips	List of tips to use Confluence with the projectdoc Toolbox and fun! Tips address users of different experience levels.
Toggle Views	Shows how to use the Wiki Link Macro based on Remote Controls to alternate between two different views on a single document.	Tips
Topic is not meant to be multi-purpose	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.	Tips
Track Team Mood	Tracking team mood (or excitement) can be tracked by the use of the Display Table Macro and the Confluence Chart Macro.	projectdoc Developer Diaries
Transclude transcluded Sections	Shows how to transclude transcluded content.	Tips
Transclusion References	Keeping track of transclusions using artificial properties.	Tips
Trouble Shooting	List of issues encountered with the projectdoc Toolbox and solutions or workarounds to resolve them.
Troubleshooting Reindexer for projectdoc Documents	In order to completely restore the projectdoc document index, not only must the Lucene index be re-created and the projectdoc document cache cleared, but the internal projectdoc structures must also be rebuilt.	Trouble Shooting
Two central Use Cases for the projectdoc Toolbox	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.	Tips
Use Cases	An overview over the use cases for which the projectdoc Toolbox provides support.
Use Context Controlled Macros	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.	Tips
Use Display Properties Macro for List Items	If you want to list a reference to a document with name and short description, use the Display Properties Macro. If you specify no property names, it defaults to Name and Short Description.	Tips
Use Display Table for Transclusion References	It is easy to list all pages that transclude a section from the current page. This allows you, as an author, to check quickly if changes to a document that is transcluded, needs changes to the transcluding documents.	Tips
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.
Use Quotes in Resources and Excerpts	Quotes automatically collect information provided in resources or from an associated excerpt of a resource. This makes it easy for you to quote text. Simply add the Quote Macro, set the page. Associating the metadata of the resource to form a quote is taken care of by projectdoc.	Tips
User Macro Integration	A short introduction to use projectdoc services in the context of velocity to integrate with user macros.
Using Aspects	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.	Tips
Using Commas in Property Values	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.	Tips
Using Heading Numbers	A short introduction to use heading numbers with the projectdoc Toolbox.	Tips
Using Placeholders	An overview over features employing placeholders to create a modular documentation.	Tips
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.
Using Space Properties	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.	Tips
Using Spaces	A short introduction on using spaces with the projectdoc Toolbox for Confluence.	Tips
Using Variables	Using document and space properties as variables in the projectdoc Toolbox for Confluence.	Tips
Variables for Blueprints	The projectdoc Toolbox provides an interface for template authors to replace placeholders with space and context properties.
Versioning for Maven Developers	A short introduction on how to work with different versions of documentation for a Maven plugin.	projectdoc for Maven Developers
Versioning with Java Doctype Add-on	A short introduction on how to work with different versions of documentation for a Java library.	projectdoc for Java Developers
Views on Documents	Switch views on documents dependent on the user's role by setting space properties in the user's homepage.	Basic Concepts and Conventions for projectdoc
Views on Topics	projectdoc makes it easy to create a modular documentation and provide multiple views on topics.	Tips
Web API Extension	Add-on to extend projectdoc with an API to access on the web.	projectdoc Extensions
Web of Documents	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.	Tips

Central Topics

Need more Info?

More information on doctype:

Topic

Index Views for Topics

Central Topics

Related Information

Related information in your wiki:

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Topic Index

About

Keep up-to-date!

Powered by