projectdoc Toolbox



List of tips to use Confluence with projectdoc and fun!

This collection of tips help new and proficient users to learn new aspects of projectdoc. Users may read one tip a week or browse the list of tips occasionally. Therefore learn projectdoc one tip at a time.

The tips provide links to resources to read more about the topics of the tip.

The list of topic is ordered by their date of publishing. The latest tip is the first in this list.

Name Short Description Date
Shows how to transclude transcluded content.
The Display Table Macro provides a quick fix feature to control the width of the table columns.
If you have lots of projectdoc documents then the in-memory properties cache might not perform optimal.
Have you ever experienced performance problems with your Confluence on premise (Server) installation? This tip might help you.
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
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.
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 Information Systems Extension for the projectdoc Toolbox allows to render a link with the HTML title as label via autoconvert of the pasted URL.
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!
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.
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.
Define a doctype on document instances to select from its set of values.
An overview over features employing placeholders to create a modular documentation.
It is easy to define the default homepage for a given doctype in a space.
Listing related pages to a page is quite easy using the projectdoc Toolbox.
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.
Learn how to access projectdoc space properties via REST API with cURL.
Learn how to access projectdoc properties via REST API 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.
Integrate information from different sources into your documentation using Confluence and the projectdoc Toolbox.
projectdoc makes it easy to create a modular documentation and provide multiple views on topics.
To organize your documentation place documents in a typed repository and add additional views on demand.
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.
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.
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.
Use the Section Macro to define sections. This tip introduces the macro by listing its features.
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.
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.
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.
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.
Properties may represent an editable boolean value. Use Confluence tasks to define the value for those properties.
You may want to provide information for specific audiences.
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.
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.
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.
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.
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.
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.
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.

Resources

More information on projectdoc:

Hands-on Tutorial
Get started with the projectdoc Toolbox: learning by doing
Compare with built-in Features
Compare the features provided by the projectdoc Toolbox with features that come with Confluence out-of-the-box.
Introduction for new Users
Provides information to get new users of projectdoc get started with projectdoc documents and spaces.
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.
Basic Concepts and Conventions for projectdoc
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.