Go to start of metadata
- Created by Robert Reiner, last modified on 17. Aug 2021
List of Terms
Terms used in and defined for projectdoc.
A
- 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.
- Atlassian REST API Browser
- Interactive API explorer for Atlassian products.
- Attachment Space
- Attachment spaces are delegate spaces for entity doctypes.
- Auto Increment
- A feature of the projectdoc Toolbox to prepend a unique identifier to the title of a page.
B
- Blueprint
- see Page Blueprint
- Blueprint Wizard
- see Page Blueprint Wizard
- Bookmarklet
- A bookmark containing JavaScript commands instead of a URL. It allows to execute actions with one click, usually related to the page currently shown in the browser.
C
- CSS
- see Cascading Style Sheets
- Cascading Style Sheets
- Cascading Style Sheets (CSS) is a simple mechanism for adding style (e.g., fonts, colors, spacing) to Web documents.
- Context Controlled Macros
- A context controlled macro uses properties from its context to control the content being rendered. This includes document and space properties.
- Custom Property
- A property defined by the author or template author on a Confluence page.
D
- 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
- see Document 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
- see Document Instance
- 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 Homepage
- The default homepage for documents of a given type.
- Document Type Index Page
- Index pages provide views on document instances of a given type.
- Document Type Metadata
- Metadata for a document type to be applied to all document instances.
- Dynamic List
- Enhances navigation by showing a list of links to related information that is the result of a query on document properties.
E - G
- Entity Doctype
- see Entity Document Type
- Entity Document Type
- Instances of this type provide information on an entity of the domain.
- Excerpt
- Describes the inclusion of a fragment of one page into another page. The term transclusion is a synonym for excerpt.
- Extension
- see projectdoc Extension
H
- HTML
- see Hypertext Markup Language
- Homepage
- see Document Type Homepage
- Hypertext Markup Language
- The Hypertext Markup Language (HTML) is markup language to create web pages.
I - L
- Index Page
- see Document Type Index Page
- Index Space
- Delegate space that provides space properties and organizing doctype homepages for other spaces.
M
- Macro
- Macros perform certain tasks on a page and are installed as part of a Confluence app.
- Materialize
- see Materialize Document Property
- Materialize Document Property
- Precalculate a property value and store it as an artificial property.
- Maven
- Maven is a software project management and comprehension tool. Based on the concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a central piece of information.
- Multi-excerpt
- The term is used by Confluence to describe the technique to transclude one or more content fragments from one or more documents.
- Multi-transclusion
- Describes the technique to transclude one or more content fragments from one or more documents.
N
- Nameless Documents
- Feature to derive a document's name from its title.
O
- Organizing Doctype
- see Organizing Document Type
- Organizing Document Type
- Instances of this type organize documents by providing metadata.
P - Q
- Page
- The Confluence wiki space contains pages. If the page contains the Document Properties Marker Macro, it is a projectdoc document.
- Page Blueprint
- A page blueprint is a set of page templates with added functionality to help you create, manage and organize content in Confluence more easily.
- Page Blueprint Wizard
- A wizard collects information from the user at page creation time. This information is used to create a document instance based on the page blueprint associated with the wizard.
- Phantom Reference
- A reference to a document or fragment of an existing document that does not exist.
- Property
- see Document Property
S
- Section
- see Document Section
- 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.
- Representational state transfer
- A software architectural style to create services on the Web, based on a collection of constraints.
- Search Space
- Search spaces extend the search with projectdoc macros for a space per default on a number of other spaces.
- Single Sourcing
- Method for systematically re-using information.
- Space
- A tool to organize pages. A space is like a folder that contains Confluence pages.
- Space Blueprint
- A space blueprints is a tool to help users bootstrap the space creation process. From a dialog users select a space blueprint and create a new space with a basic, blueprint-specific set of pages.
- Space Closure
- The collection of spaces that belong to a space group. The closure can be a ordered list or simply a collection of 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.
T
- Template
- A template is part of a Confluence blueprint.
- Topic Space
- Designed to keep information that is relevant for a given domain and is mandated to be up-to-date.
- Transclusion
- The technique to render parts of one document within another document.
- Type Doctypes
- Document types that define types for documents.
U - V
- User Macro
- User macro extend the functionality of Confluence. They can be created without any further development resources directly within the Confluence server.
W - Z
- Web API
- An application programming interface accessible from the web. Used to create scripts to execute actions launched manually or in the context of an automated process.
- Wiki Markup
- Wiki Markup is a special syntax used in Confluence to describe pages. At specific locations this syntax is the only way to add macros. This is the only use case for this kind of markup in the context of the projectdoc Toolbox.
- Workspace
- Designed to aggregate information that is relevant for a given spike or iteration.
Need more Info?
More information on doctype:
This glossary is using the Glossary Item doctype and the Index Entries Table Macro.
The macro is part of the projectdoc Toolbox, the doctype is part of the free Core Doctypes Add-on.
