Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleExample

Suppose you want to provide information about a topic for your team.

Section
titleCreate Page
  1. Move to your team's space
  2. Select the Topic Doctype.
  3. Add information to the wizard and hit "Create"
    Topic Wizard

Note that the checkbox for sending the page to the homepage is checked. The new document will not be stored as a child to the current document, but instead be found as child to the homepage of topic documents (if such a homepage exists).

Note Box
titleHomepage Selection

If no homepage exists in this space, but the delegate space provides one, the document will be stored in a different space. Think of resources like a department's library that is shared by multiple teams.

If no homepage can be found in this or any delegate space, the homepage is the current page.

So creating documents and putting them to their natural repository is pretty straight forward.

Section
titleEdit Page

Here is the top of the new page. For this example only the document properties are relevant, so we do not show the sections (which begin with "Description").

Document in the Editor

To add additional views on your document you may add information for the following properties:

Section
Column
width30%

 

Column
Property NameDoctype
AudienceRole
Level of ExperienceExperience Level
SubjectSubject
CategoriesCategory
TagsTag
TypeTopic Type
SponsorsStakeholder
Column
width30%

 

The property values may reference a document instance document of a given type. In this case the document instance automatically lists this document as a member of this type. This allows to find the document from different angles in your wiki.

Assume that the team has defined a category called "Security", the topic is relevant for the subject "SuperApp" and the type of the topic is "Tutorial". Then the new topic document will be listed on the Security document of type Category, on the SuperApp document of type Subject and on the Tutorial page of type Topic Type.

Note Box
titleLarge Numbers

These views are quite handy as long as the lists do not exceed a certain number of documents. If your documentation grows you may need to create a hierarchy of categories (such as Security / Authentication / Apps) or add additional views by using the Display Table Macro (such as querying for tutorials in the security category - WHERE TopicType=Tutorial AND Categories=Security).

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto