Go to start of metadata
- Created by Robert Reiner on 31. Jul 2017
projectdoc Toolbox
All Sections
List of all sections added to the wiki.
| Name | Short Description | Parent |
|---|---|---|
| Deleting Properties | Delete properties for a set of documents specified by their IDs. | Documents Service / PATCH |
| Description | Describes the content and the intention of the document instance. This is a longer form of the short description document property. | |
| Doctype | Identifies the type of the document. | |
| Download 5.0 Artifacts | Beta artifacts are not supported. Use at your own risk! Only for development environments. Upgrades or downgrades to other versions may not be supported. | projectdoc Toolbox 5.0 Release Notes |
| Fetching Document IDs | Specify a query to fetch document IDs. Pass this list of IDs to other service calls (e.g. to patch properties or sections). | Documents Service / GET |
| Site refresh required | After import of a space, a reindex and in some cases a refresh page tree is required. | projectdoc Toolbox 2.5 Release Notes |
| Summary | An informative summary about the content of the document instance. This section is not meaningful to every document type. | |
| Documents | Section that lists documents associated by a name reference with this document instance. | |
| Children | Organizing documents in a hierarchical manner is sometimes very helpful to help readers to orientate in the documentation. The children section automatically lists the child documents, usually with the name and short description. | |
| Name | Every document instance requires a name that should uniquely identify it within its doctype. | |
| Short Name | A shorter or abbreviated name of the document. | |
| Notes | These are internal notes that are usually not exported and only visible to team members with write access. | |
| Short Description | The short description describes the content of the document. This information is typically displayed in document lists, where the name is rendered side by side with the short description. | |
| Parent | The property references the higher ranked document, typically of the same type as the child document. Usually the parent is a more general form of the child or is in some other ways a structuring instance. | |
| References | For a document the references section contains pointers to resources that prove the statements of the document. | |
| Audience | The audience is the group of readers the document defines as it target. | |
| Resources | Provides references to further information to the topic of the document. | |
| Categories | Categories help to organize document instances in hierarchies. | |
| Subject | Subject properties allow to set document instance of different doctypes in a common context. | |
| Flags | Like Tags the document property Flags also supports labelling documents, but without the need to document them. | |
| Tags | Tags allow to add arbitrary character sequences to group document instances, even of different document types. On searches tags allow to select specific instances. | |
| Iteration | The Iteration property is a tool for the author to communicate the status of the document within its creation process. Readers get aware, how to interpret the information in the document. | |
| Sort Key | The sort key is the primary tool for sorting documents displayed in a list or on a table. Usually the documents are sorted by name, but sometimes you want to impose a semantic order on the documents. | |
| Type | The type property is a doctype specific category. | |
| Sponsors | References stakeholders who take interest in creating and optionally maintaining a document. | |
| Adding Properties | Add properties for a set of documents specified by their IDs. | Documents Service / PATCH |
| Space cannot be deleted | Some spaces resist to be deleted. | projectdoc Toolbox 2.5 Release Notes |
| Create From Template Macro fails | Instead of creating a new document instance for a doctype, the template button macro only logs an error to the browser's console. | projectdoc Toolbox 2.5 Release Notes |
| Transclusion of Hidden Sections | The handling of the transclusion of hidden sections has changed. As of this version, the section will no longer be transcluded. In a future version of the projectdoc toolbox, we will provide an option that allows transcluding hidden sections. In this version, it is necessary not to hide the section itself, but to surround it with a Content Marker Makro which itself is hidden. |
Need more Info?
More information on doctype:
Related Information
Related information in your wiki:
- Space Index Index
- Generic Index
- Excerpt Index
- No labels
