Helps team members to create documentation that is helpful, fosters the understanding of good and sustainable documentation and keeps the project's documentation up-to-date and clean.

Group: projectdoc-gardeners

Resources

Name	Short Description	Doctype	Audience
Reference Tour	This tour provides a list of links to reference material.	tour	Author, Confluence Administrator, Documentation Gardener, projectdoc Developer, Template Author
Tour for Software Developers	Overview over the most relevant information for software developers to create their documentation on Confluence with the projectdoc Toolbox.	tour	Documentation Architect, Author, Documentation Gardener
Accessing projectdoc Properties with cURL	Learn how to access projectdoc properties via REST API with cURL.	topic	Author, Documentation Architect, Documentation Gardener
Accessing projectdoc Space Properties with cURL	Learn how to access projectdoc space properties via REST API with cURL.	topic	Author, Documentation Architect, Documentation Gardener
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.	topic	Documentation Architect, Documentation Gardener, Author, Template Author
Artificial Properties	In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.	topic	Author, Documentation Architect, Documentation Gardener
Aspects light	Add a document as a child and automatically make supplied properties available in the parent.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Autoconvert Information System URIs	Introduction to the autoconvert feature for URIs to external systems.	topic	Author Documentation Architect Documentation Gardener
Basic Concepts and Conventions for projectdoc	Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.	topic	Author, Documentation Architect, Documentation Gardener, Template Author
Blueprint Properties	Lists the configuration options for template authors to control page creation.	topic	Template Author, Documentation Architect, Documentation Gardener
Cache Refresh Actions	projectdoc documents are stored in caches for quick access. Users may want to clear one of these caches.	topic	Confluence Administrator, Documentation Gardener, projectdoc Developer
Categories of Information System Macros	Overview over the different categories of macros that are part of the Information Systems Extension.	topic	Author Documentation Architect Documentation Gardener
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.	topic	Documentation Gardener Documentation Architect
Configuration	Information for the configuration options of the projectdoc Toolbox.	topic	Confluence Administrator, Documentation Architect, Documentation Gardener
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.	topic	Author, Documentation Gardener, Documentation Architect
Deep Links in Queries	Deep links can be used on both sides of predicates in a Where Clause.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
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.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
Document Property Controls	Lists valid controls for properties to be used in document properties tables.	topic	Author, Documentation Architect, Documentation Gardener
Dynamic Property Value Handling	Configuration to control how the projectdoc Toolbox handles property values with dynamic content.	topic	Confluence Administrator, Documentation Architect, Documentation Gardener
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'.	topic	Author, Documentation Gardener, Documentation Architect
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.	topic	Documentation Architect, Documentation Gardener
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.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
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.	topic	Documentation Architect, Documentation Gardener
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.	topic	Documentation Architect, Documentation Gardener, Author, Template Author, Sponsor
Linking to Glossary Terms	Show how to use the Name List Macro to render links to glossary terms.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Modularization	Using sections and modules to organize and reference content.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
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.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
projectdoc System Properties	Lists recognized system properties specified on the command line for starting the Confluence server.	topic	Author, Documentation Architect, Documentation Gardener
Query Configuration	Controls the parameter to use for running queries with the projectdoc Toolbox.	topic	Confluence Administrator, Documentation Architect, Documentation Gardener
Remote Controls for Transclusion	Alter the rendering of macros of transcluded content with remote controls.	topic	Author, Documentation Architect, Documentation Gardener, Template Author
Rescue Confluence Pages	Rescue and restore data of a Confluence page that does not render anymore.	topic	Documentation Gardener, Confluence Administrator, Author
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.	topic	Author, Documentation Architect, Documentation Gardener
Search Space for Index Spaces	Define the default search space for index spaces.	topic	Author, Documentation Architect, Documentation Gardener
Selection Boxes on ad-hoc Doctypes	Define a doctype on document instances to select from its set of values.	topic	Author, Documentation Architect, Documentation Gardener
Space Properties	Lists the configuration options at space level.	topic	Author, Documentation Architect, Documentation Gardener
Space Property Controls	Lists valid controls for properties to be used as space properties.	topic	Author, Documentation Architect, Documentation Gardener
Supply Documents	Show how to import properties from other projectdoc documents into a projectdoc document.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Support Browsing	Tools from the projectdoc Toolbox to allow users to browse for information.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Think Repositories	To organize your documentation place documents in a typed repository and add additional views on demand.	topic	Author, Documentation Architect, Documentation Gardener
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.	topic	Confluence Administrator, Documentation Gardener
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.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
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.	topic	Documentation Architect, Confluence Administrator, Documentation Gardener
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.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Views on Topics	projectdoc makes it easy to create a modular documentation and provide multiple views on topics.	topic	Documentation Architect, Documentation Gardener, Author

Documentation Gardener

Resources