Go to start of metadata
- Created by Robert Reiner, last modified on 28. Jun 2018
The default homepage for documents of a given type.
- Short Name
- Homepage
- Relation
Organizing pages in a wiki is not easy. As a rule of thumb you should try to build flat hierarchies. The physical location of a page should not depend on information that may change. One property that typically never changes is the type of the document. So the homepage of a doctype is the natural place, or default location, to store a document instance.
Related Terms
Click here to expand...
- Aspect
- An aspect is a document attached to another document to supply properties and sections. Aspects support modular documentation while the information can be still accessed in one document.
- Attachment Space
- Attachment spaces are delegate spaces for entity doctypes.
- Context Controlled Macros
- A context controlled macro uses properties from its context to control the content being rendered. This includes document and space properties.
- Deep Link
- Deep links reference properties in referenced documents.
- Delegate Document
- A delegate document references one document to inherit properties and sections.
- Delegate Space
- Delegate spaces help to organize information that is used by more than one space. Resources may be delegated to other spaces. This includes the definition of space properties and providing homepages for documents of a given type.
- Doctype Add-on
- Doctype add-ons provide blueprints for the projectdoc Toolbox. All doctype add-ons are available in source code on Bitbucket. This way teams may download them and adapt them to their specific requirements.
- Document Instance
- A projectdoc document instance is based on a document type. Documents are created using page wizards provided by blueprints.
- Document Property
- A property is metadata for a document. It has name, a value, and a control (such as hide).
- Document Section
- A document type defines property and sections. A section is part of a document with a title and a body. Sections may be nested.
- Document Type
- A document type (doctype) defines the properties and section for document instances. It also provides home and index pages. In Confluence these doctypes are implemented as page blueprints, usually with one template. This template is used to create new pages in Confluence.
- Document Type Index Page
- Index pages provide views on document instances of a given type.
- Entity Document Type
- Instances of this type provide information on an entity of the domain.
- Index Space
- Delegate space that provides space properties and organizing doctype homepages for other spaces.
- Nameless Documents
- Feature to derive a document's name from its title.
- Organizing Document Type
- Instances of this type organize documents by providing metadata.
- Phantom Reference
- A reference to a document or fragment of an existing document that does not exist.
- projectdoc Extension
- Features we assume are not relevant to all users of the projectdoc Toolbox are available as extensions. Extensions are add-ons for Confluence that require the projectdoc Toolbox Add-on to be installed, but can be installed separately on demand.
- Prototype
- A member of a set of document instances of a common doctype. Used to be imported into wiki instances since they provided information to be used in different projects. Examples are topic types, resource types, and module types.
- Remote Controlled Document
- A remote controlled document uses macros that enable to control the content being rendered by request parameters.
- Remote Controls
- Remote controls are sequences that allow to configure macros in transcluded content. This reconfiguration alters the rendering result of the macro. Only macros supporting the remote control feature can be remote controlled.
- Search Space
- Search spaces extend the search with projectdoc macros for a space per default on a number of other spaces.
- Space Hierarchy
- A relation of spaces based on delegation or search.
- Space Property
- A property defined on the space homepage that takes effect on the space and delegating spaces.
- Topic Space
- Designed to keep information that is relevant for a given domain and is mandated to be up-to-date.
- Type Doctypes
- Document types that define types for documents.
- Workspace
- Designed to aggregate information that is relevant for a given spike or iteration.
Resources
- Default Locations
- Document types have their default location within a documentation space. These default locations are called 'homepages'. If authors create new documents they can send them to these default locations within a given space. Delegate spaces expand this feature to find the default location in associated spaces.
- Physical Location
- Store information physically only by properties that are invariant.
- Document Type
- A document type (doctype) defines the properties and section for document instances. It also provides home and index pages. In Confluence these doctypes are implemented as page blueprints, usually with one template. This template is used to create new pages in Confluence.
- Document Types and Templates
- Document types (or doctypes for short) define a set of properties and sections. Each doctype matches at least one Confluence Page Blueprint. Confluence Page Blueprints are a collection of templates, but often the collection contains only one element.
- Home and Index Pages
- Home and index pages help to organize documents by type. For each doctype there is a homepage and and index page. The homepage shows the central documents that are added to it (immediate children). Index pages list all documents of the space, regardless of their location.