Child pages
  • Reporting

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »


Tag your documents and create reports on your documents in tabular form

Categories

A information architecture defines – besides lots of other stuff – types of documents. Each document provides properties and sections that are typical for its type.

On creating a new document, a wiki page with these properties and sections, an author tags the document with metadata such as categories, tags, and a type.

Reporting allows you to query for documents that match specific constraints. For instance all documents associated with a set of tags and a given type.

The projectdoc Toolbox makes it easy to tag documents and render tabular reports.

Authors may also create reports that fetch multiple sections from existing documents to create a new document with sections from multiple documents (multi-transclusion).

Creating a report includes the following tasks:

Resources

Information Material

The following list of resources provides background information on creating reports with the projectdoc Toolbox for Confluence.

Resource Short Description Type
A short introduction on compiling projectdoc documents in dynamic lists using constraints.
topic
Get started with the projectdoc Toolbox: learning by doing
topic
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
topic
Finding without SearchingHow to organize a wiki to increase the findability of information.Blog Article
Finding without Searching - applied!How to use the projectdoc Toolbox to organize information in a Confluence wiki.Blog Article
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.
topic

Doctypes

Reporting may be based on documents of any type.

Macros

The following macros of the projectdoc Toolbox support creating reports.

Resource Short Description Categories
Renders a template with property references.
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
Renders a section, if the body is not empty. Supports authors to create content, clutter-free rendering without empty sections. Allows to transclude the content.
Renders transcluded content fetched from documents of a result set.
Renders a predefined list of documents in a table.
Transcludes content via a reference from a document marked with the content marker macro.
  • No labels