projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypedoctype
overridefalse
Short DescriptionA description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents. 
Doctypedoctypehide
NameTopic 
IDtopic 
SuiteCore
SetCorehide
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
 

Documentation Type
Name List
doctypedoctype-type
namesQ1 - Process, Q2 - Project, Q3 - Product, Q4 - System
propertyDocumentation Type
 

Categories
Name List
doctypecategory
names/ Document / Entity
propertyCategories
 
Tags
Tag List
namesCore, Modular Documents, Allrounder
 

Iteration
Iteration
valuefocused
hide
Sort Keyhide

...

Section
titleSections
Section
titleDescription
Transclusion
documentDescription
idsDesignationDescription

Section
titleSummary
Transclusion
documentSummary
idsDesignationDescription

Note Box

This section has formally been called 'Abstract', but has changed for 'Summary' to be used by different doctypes.

Section
titlePrerequisites

Expected knowledge of the user or a list of documents suggested to be read before this one.

Tip Box

The title is not very inviting for readers. You may change the title to something like "Before you start" or "Check this out first", whatever best matches the tone your audience expects. To select this topic with transclusions you may still define an identifier of tag 'Prerequisites' in case you have to show topics for different audiences in an overview, using the Display Table Macro.

Section
titleSubordinate Topics

A larger topic may be broken down into individual subtopics.

Other than Section documents, subtopics may have an independent lifespan and may recognized as relevant standing on their own. If the subtopics do not satisfy this requirement, you may choose to break the topics into sections instead of subtopics.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH