Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionIt is often required Sometimes you need to add properties to a set of documents of in a given typecontext. This can be handled in two ways: add the property to each document or use the Tour Macro. 
Doctypetopichide
Relevance
HML Rating
valuemedium
 
NameAdditional Properties 
Parent
Parent Property
propertyParent
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
namesAuthor
propertyAudience
 
Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesNovice
propertyLevel of Experience
empty-as-nonefalse
 
Expected Duration5 min 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Iteration
Iteration
valuefinished
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType
 
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors
 
Sort Keyhide
Column
width300px

 

 

Panel
titleContents

Table of Contents
maxLevel2
outlinetrue
indent10px
excludeAdditional Properties
stylenone

...

Section
titleAdd Property to Document

While doctypes define the standard properties for a document, projectdoc allows to add any additional properties required for your use case.

For instance you may have a number of documents of type Topic. Now you want to attach a weight of relevance of these topics. You do not want to bother to create a new doctype just to introduce this new property. Therefore you add a property with name 'Relevance' and the HML Rating Macro as value.

The downside of this approach is that you

    (minus) You need to open every document and add this new line to each of your properties table inside the Document Properties Marker Macro

.The upside is that you

    (plus) You can access the relevance in every query using for instance the Display Table Macro or the Tour Macro

.

Section
titleUsing the Tour Macro

The Tour Macro allows to specify a list of document references and select properties by adding columns with the selected property name as heading.

You can override the value for a given document by adding a value to the cell in the column. You may even add a column with a heading that matches no property. So if you specify a column 'Relevance' you simply add values to it and they are displayed, even if there is no property with that name in the documents.

So this is the result in the view.

The short descriptions are fetched from the referenced documents, the relevance values are simply rendered from the table column.

The downside of this approach is that

    (minus) 'Relevance' is not a property of the documents and is therefore not accessible from other contexts

.The upside is that since

    (plus) Since the values are added to the table in their own column, they can be edited much more easily

.

Section
titlePrerequisites

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto