Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypetopic
overridefalse
Doctypetopichide
NameName and Title
 

Short DescriptionThe purpose and the differences between the name and title property of a doctype.
 

Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesNovice
propertyLevel of Experience
 

Expected Duration
 

Tags
Tag List
 

Iteration
Iteration
valuefinished
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType
 

Sort Key0000100hide
Section
titleDescription
 
Section
titlePrerequisites

...

Section
idContent

There are two type of identifiers on each projectdoc document that identify the document in two different contexts uniquely. These are Title and Name.

Title

The title is the same as the title of a Confluence page. As you well know, a title has to be unique within a space (unless you have deployed some fancy plugins that help you to get rid of this constraint).

Name

The name on the other side should be unique within the document type. That is there must exist no two documents within a search space with the same name and doctype. Whereas the unique constraint of the title within its space is tightly enforced, there is no checking for the uniqueness of the name. This is due to the fact that the search space is defined at search time, while the name is specified at writing time.

Why do I need a Name?

The name allows you to have documents of different types with the same name. It might happen that you want to have your resources and your topics in the same space. If you have a resource, a book, called "Continuous Delivery" and also you want to collect resources on the topic "Continuous Delivery", your are free to do so. All you have to decide is how to name the title of the document. In case of resources we usually take the last name of the first author and add the publication date of the resource (e.g. Humble2010).

If you have two documents with the same name, you simply won't have a single match on a name query. If a particular macro expects exactly one match, it will arbitrarily choose one.

Section
titleUser Templates

For user templates it may be quite cumbersome to track two different concepts of naming a document. Using blueprints this could be easily handled by the wizard that generates a meaningful title based on the name provided by the user.

Since version 2.1 of the projectdoc Toolbox it is also possible to derive a name from a given title. The following space properties configure this behavior.

Tour
render-as-definition-listtrue
replace-title-with-nametrue
Section
titleSubtopics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...