Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
extract-short-desctrue
render-asdefinition-list
Short Descriptionprojectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections. 
Doctypetopichide
Nameprojectdoc Document 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
propertyAudience
 
Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesNovice
propertyLevel of Experience
empty-as-nonefalse
 
Expected Duration5 minutes 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
namesIntro
propertyTags
 
Iteration
Iteration
valuefocused
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType
 
Sort Key000100hide
Section
titleDescription
 
Column
width30%
Panel
bgColorlightyellow
titleContents

Table of Contents
maxLevel2
indent10px
excludeprojectdoc Document|Description|Resources
stylenone
 

Section
Column
Section
titleCreate Documents

projectdoc is about document properties and document sections.

To define a document add document properties with the Document Properties Marker Macro and document sections with the Section Macro.

There are properties and sections that are available for all document types created by smartics.

Note Box

projectdoc documents are usually defined as page blueprints by the Template Author.

Page Authors select the type of document that suits their requirements and simply add content. If they add new sections they are encouraged to use the Section Macro. But if the content is not meant to be transcluded, authors may decide to use simple HTML headers.

The document type supports authors in writing documents of a given kind. Due to the nature of the templates, readers only see those properties and sections which have meaningful information.

Image AddedThis we call "Guided Writing & clutter-free Reading".

Column

 

 

Panel
borderColorgreen
titleWhat is Transclusion?
Quote External
source-urihttp://en.wikipedia.org/wiki/Transclusion
render-anonymousfalse
sourceWikipedia

Transclusion is the inclusion of a document or part of a document into another document by reference.

B is transcluded in the document A.

Panel
borderColorgreen
titleWhat is Single Sourcing?
Quote External
source-urihttp://en.wikipedia.org/wiki/Single_source_%28disambiguation%29
render-anonymousfalse
sourceWikipedia
To single source is to allow the same content to be used in different documents or in various formats.

...

Section
titleResources

The following resources provide information to get started with projectdoc.

Section
titleRelated Intros

Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
where$<Tags> = [Intro]
exclude-selftrue

Section
titleRelated Tours
Tour
render-as-definition-listtrue
replace-title-with-nametrue
TitleShort Description
Tour for Document Authors 
Section
titleBlog Articles