Go to start of metadata
- Created by Robert Reiner on 06. Oct 2017
projectdoc Toolbox
All Properties
List of all properties to configure the product.
| Name | Short Description | Parent |
|---|---|---|
| adjust-title-on-any-parent | Controls the generation of the document title by adding the parent document's title in any case. | |
| adjust-title-on-parent | Controls the generation of the document title by adding the parent document's title if the parent matches the doctypes listed by the Parent property. | |
| AncestorIds | The list of document IDs, starting from the root page, excluding the ID of this page. | |
| AncestorNames | The list of document names, starting from the root page, excluding the name of this page. | |
| AncestorTypeIds | The list of parent document IDs, starting from the hierarchy's root document. | |
| AncestorTypeNames | The list of parent document names, starting from the hierarchy's root document. | |
| Auto ID | The automatically generated identifier for a document. The services needs to be configured per doctype with a space property. | |
| Auto Identifier | A template variable for an auto-generated identifier. | |
| Autocomplete Active Constraint | Controls an additional constraint to filter on the names returned by the Autocomplete Service. The constraint selects on the documents that provide names, not on the names itself. | |
| Autoconvert Hint | List of space property names that refer to a remote information system URL. Elements of the list may be specifier with a system ID and a system type. | |
| Box Title | The title of a box defined with a box macro by the Title Parameter. | |
| cache.requestCacheSize | Control the size of the projectdoc request cache. | |
| Caching Fragments | Activates the page fragment cache for a space. | |
| check | Toggles checking the existence of resources. | |
| Code Language | Specifies the default language to be passed to the Code Block Macro. | |
| Counter Column Header | Controls the label for all counter columns of a space. | |
| Creation Date | The date the document has been created. The value is created by Confluence. | |
| Creation Time | The hour of day of the date the document has been created. The value is created by Confluence. | |
| Creator | The name of the user who created the document. This value is generated by Confluence. | |
| Debug Access Mode | Controls constraints on when debug rendering is conducted. | |
| Debug Mode | Controls the rendering of documentation debug information. | |
| Default Group Name Pattern | Specifies for the name pattern the default group to select. | |
| Default Space Closure | List of spaces to delegate documents on creation to. Also works as a search space for upstream spaces. | |
| default-only | The property is only used as a default if there is no value set in a less prominent place. This property control applies only to space properties and especially to the user space. | Space Property Controls |
| delegate | Signals that the property should be transcluded from the delegate document. | Document Property Controls |
| Delegate Document Doctype | The type of the document this document delegates to. | |
| Delegate Document Name | The name of the document this document delegates to. | |
| Delegate Document Page Link | The page link to the document this document delegates to. | |
| Delegate Document Page Reference | The page reference (space-key.page-title) of the document this document delegates to. | |
| Delegate Document Suppress Error Message Section | Controls if missing sections should render an error message ( false) or just display nothing (true). | |
| Delegate Space | List of spaces to delegate documents on creation to. Also works as a search space for upstream spaces. | |
| DirectAncestorId | The internal Confluence page identifier of the page's parent. | |
| DirectAncestorTitle | The title of the parent document. | |
| Disable Document Name as Scroll Office Title | Controls whether or not the name of the document should be set as the title for Scroll Office. | |
| Doctype Auto ID Pattern | Specifies the pattern for auto increments for a given doctype. | |
| Doctype Common Team | Controls the name of a team to replace the name of a team member for certain use cases. | |
| Doctype Document Name Pattern | Specifies a doctype-specific pattern to match against the title property to derive the name property of a projectdoc document. | |
| Doctype Document Name Pattern | Specifies a pattern to match against the title property to derive the name property of a projectdoc document. | |
| Doctype Document Name Pattern Group | Specifies for the name pattern the doctype-specific group to select. | |
| Doctype Home | Controls the location of the homepage of a given document type. Use the identifier of the doctype. | |
| Doctype Homepage | Provides a link to the document's type homepage. | |
| Document Name | The name of the document as specified by the user in the wizard. | |
| Document Short Description | The short description for the document as specified by the user in the wizard. | |
| document-only | The property is only used as a document property and must not be used as a space property. | Space Property Controls |
| Documentation JSON URI | The URI to a JSON document containing the URLs to the documentation for the blueprints. | |
| DocumentPropertyRefs | Tracks direct property references a document is defining. | |
| Enable Heading Numbers | Controls whether or not section headings should be numbered. The numbers are added via CSS, therefore they won't work for export formats that do not take CSS into account. | |
| eventing.threads.skipList | Disable event processing in threads running bulk updates. | |
| export | Exports the property as metadata. | Document Property Controls |
| export-schema | Exports the property as schema information. | Document Property Controls |
| Extract Short Description From Metadata Table | The property to control how short description from the document properties tables within a space should be rendered. | |
| force-property | Enforces to treat a property with dynamic value as property. | |
| Graph Type | Specifies the type used for rendering graphs. | |
| Heading Max Numbered | Controls the max depth to which headings are numbered. | |
| Heading Number Start | Controls the start number of the first heading on a page. | |
| Heading Starting Level | Controls the top heading level for a document. | |
| hide | Prevents the property from being displayed. This allows to add properties to use for selection in queries, but hide them when displaying the document. | Document Property Controls |
| Hide Document Type Box | The property to set the document type box displayed on each page to be hidden or not. | |
| Hide Metadata | The property to set metadata in document properties tables to be hidden or not by default. May only be overridden if document properties macro specifies "override" to true or if the property is not set for the space. | |
| Hide Metadata For Printing | The property to set metadata in document properties tables to be hidden or not for printing. Printing includes PDF, Word and HTML-Export. | |
| Index Key | The key to the lookup the document within its context. The index key is typically the first character of the name. It may be defined by the author as a document property to override the default. | |
| is-block | Prevents the property value from being disblocked. | Document Property Controls |
| is-no-template | Marks the value of a property as not being a template despite it may contrain a placeholder reference. | Document Property Controls |
| is-single-value | Prevents the property value from being split into a list of values. | Document Property Controls |
| Last Modification Date | The date the document had been modified lately. The date is generated by Confluence. | |
| Last Modification Time | The time of day of the date the document had been modified lately. The date is generated by Confluence. | |
| Last Modifier | The name of the user who added the last modifications to the document. The value is generated by Confluence. | |
| Last Version Comment | The last comment added by the last modifier for the Confluence page. | |
| Last Version Number with Comment | The last version Number that actually has a comment. | |
| Links Aside Panel Intro | Controls the standard intro text for aside panels. | |
| Links Hide Related Information Intro | Controls whether or not standard introductional texts should be shown in related information aside panels on home and index pages. | |
| mandatory | Tags a property to be mandatory. | Document Property Controls |
| mat | Materialize the controlled property by an artificial property with the given path. | |
| Metadata Sets | Controls to render sets of metadata based on document properties. | |
| Name List Default Box Style | Controls, the default whether or not the Name List Macro renders a small box around each entry. Its possible to overwrite this default for each doctype using the name-list-<doctype>-boxstyle space property. | |
| Name List-Doctype Box Style | Controls, the default whether or not the Name List Macro renders a small box around each entry for a specific doctype. The default behavior is false and can be set to true by using the space property name-list-default-boxstyle. | |
| Nexus Default Repo ID | The property points to the default Nexus repository. The identifier is used by the Nexus Macro to set a space-wide default. | |
| Nexus Service | Contains the URL to the nexus service to download artifacts. | |
| no-property | Controls whether a line in a document properties marker macro is actually a property. | |
| no-render-cache | Controls whether or not a rendered property value can be cached. | |
| noindex | Prevents the property from being indexed with Lucene. A property marked with this control will neither be added with a keyword nor added to the body of the document as text. | Document Property Controls |
| Page ID | The unique identifier of the page. This is the page ID provided by Confluence. | |
| Page Key | Unique reference of a page within a Confluence site. | |
| preserve | Prevents cleanup services from applying their changes to name, value, and controls of a property. | Document Property Controls |
| Pretend Being A | A switch to control the assumed role of the logged in user. The property is set as a property of the user's private space. | |
| prevent-disblocking-property-values | Switch off disblocking property values per default. | |
| Print Quirk Modes | Controls which quirk modes are to be applied to adjust the output for a range of formats. | |
| Project Artifact ID | The artifact identifier of the project. The value is used as a default value by macros referencing information systems. | |
| Project Classifier | The classifier of the main artifact created by the project. The value is used as a default value by macros referencing information systems. | |
| Project Group ID | The group identifier of the project. The value is used as a default value by macros referencing information systems. | |
| Project Type | The type of the main artifact created by this project. The value is used as a default value by macros referencing information systems. | |
| Project Version | The version of the project. The value is used as a default value by macros referencing information systems. | |
| projectdoc-adjustVarValues-toDatePicker | Requests to transform a plain date value to a date picker element. | |
| projectdoc-adjustVarValues-toXhtml | Requests to normalize the referenced values to allow inserting as raw XHTML. | |
| projectdoc-alternating | Use the CSS class projectdoc-alternating for a HTML table to get alternating colored table rows. | |
| projectdoc-compact | Renders a compact representation where applicable. | |
| projectdoc-counter-column | Marks column cells that contain a row counter. | |
| projectdoc-doctype-{doctype} | CSS class to format elements on a document of a given type. | |
| projectdoc-fullwidth | Use the CSS class projectdoc-fullwidth for a HTML table to get a table using 100% of the available width. | |
| projectdoc-halfwidth | Use the CSS class projectdoc-halfwidth for a HTML table to get a table using 50% of the available width. | |
| projectdoc-hide | CSS class to remove the tagged element from the view. | |
| projectdoc-hide-on-startup | Collapses an element on a page when this page is shown. | |
| projectdoc-instances-view | Tags links that refer to views on document instances instead of the storing page (central home page of the doctype). | |
| projectdoc-intra-document-link | A class added to links to indicate visually that the link point to a target in the same document. | |
| projectdoc-intra-site-link | A class added to links to indicate visually that the link point to a document on the same site. | |
| projectdoc-no-docs | Tags links that refer to a home page without having an index page attached. This is a quick check if at least one document has been created since this launches the creation of the index page for this document type. | |
| projectdoc-quarterwidth | Use the CSS classprojectdoc-quarterwidth for a HTML table to get a table using 25% of the available width. | |
| projectdoc-render-counter-element | Marks the counter element rendered by the Content Marker Macro. | |
| projectdoc-replace-fields-request | Requests to transform replace placeholders in the referenced wizard form fields. | |
| projectdoc-resource-exists | Tags links that point to a resource that actually does exist. The test is run via checking the response code of a HEAD request. | |
| projectdoc-resource-not-exists | Tags links that point to a resource that actually does not exist. The test is run via checking the response code of a HEAD request. | |
| projectdoc-section-without-title | Marks sections where the title is suppressed. | |
| projectdoc-selected-document-properties | Rendered with a properties table in front of transcluded content. | |
| projectdoc-short-description | Marks a block element to contain a short description of a document. | |
| projectdoc-space-key-{spaceKey} | CSS class to format elements on a page of a given space. | |
| projectdoc-space-reference | Tags links that refer to a page moved to another space. | |
| projectdoc-steps | CSS class to mark an enumeration of steps. | |
| projectdoc-table-merger-root | Tags list containing elements for the Table Merger Macro. | |
| projectdoc-thirdwidth | Use the CSS class projectdoc-thirdwidth for a HTML table to get a table using 33% of the available width. | |
| projectdoc-tiny | Renders a compact representation of property representations. | |
| projectdoc-tiny-iteration | Renders a compact representation of iteration property representations. | |
| Quirk Breadcrumb Root Node Fix | Allows to render an additional node using the CSS class 'first'. | |
| Quote Macro Render Date with Brackets | Controls the rendering of brackets around the date. | |
| Quote Page Prefix | Specifies the prefix for specifying page locations for quotes and cites. | |
| Quote Page Prefix Separate | Signals to insert a non-breaking space between the page location prefix and the actual page location information. | |
| Quote Page Prefix Suppress on Letter | Signals to suppress the adding of the prefix, if the first character of the page location is already a letter. This is useful if the format of citing depends on a language, but there is a default language for the space. | |
| Reference Space | List of spaces to include in downstream references. Use @all to refer to all spaces. | |
| Relative URL | Provides a relative URL to the projectdoc document. | |
| Render Counter Template | Provides a template to render the counter tracking elements of the Content Marker Macro. | |
| Render Metadata as | The property to control how the document properties tables within a space should be rendered. | |
| Render Transclusion Box | Controls the rendering of transclusion boxes. | |
| request-projectdoc.xml.delegate-document.parent | Requests the generation of an XML fragment to refer to the parent as a delegate document. | |
| Safe Mode | Prevents the execution of projectoc Tools at system level. | |
| Search Space | List of spaces to include in downstream searches. Use @all to refer to all spaces. | |
| Search Space Local | List of spaces to include in downstream searches to be used for the defining space only. Use @all to refer to all spaces. | |
| Section Extro Text | The text provided by the Section Macro by the Extro Parameter. | |
| Section Intro Text | The text provided by the Section Macro by the Intro Parameter. | |
| Section Title | The title of a section defined with the Section Macro by the Title Parameter. | |
| Server Root Based | Toggles g/a/v path generation for the Site Link Macro. | |
| show | Renders a property even if the value is blank. | Document Property Controls |
| Skip rendering Counter Element | If counter elements are rendered purely by CSS styles, setting this flag to true prevents the rendering of the counter within its own HTML element. | |
| Space Key | The key of the space the document is part of. | |
| Space Properties Extension | Links to documents that contain additional space properties. The order of the references to documents is important. The first location a value for a property is found, defines the value to the property. Later reference cannot override that value. | |
| Space Properties Extension Doctypes | The property that stores the names of doctypes to take as space properties extensions into account, if found as children if the document this property is defined in. | |
| Space Properties Extension Pattern | Stores the regular expression pattern to create a reference to a space properties extension. | |
| Space Title | The title of the space the document is part of. | |
| space-local | The property must not be seen outside the space. This is typically used for properties defined in the personal space that should not be used outside this space. Note that specifying this control will hide the property imported from delegate spaces. | |
| Subject Home | A space property to control the location of the homepage of a given subject. Use the name of the subject to define the space property name. The value is a link to the page to store documents associated with the specified subject. Only available for versions prior to 2.0. | |
| supplied | Marks a property as being imported from another projectdoc document. | Document Property Controls |
| supply | Marks a property as importable by other projectdoc documents. | Document Property Controls |
| Suppress Heading Numbers on Doctypes | Controls the suppression of heading numbers dependent on the doctype. | |
| Suppress Transclusion | Suppresses transclusions when set to 'true' on a space. | |
| Suppress Transclusion Mode | Sets the mode for rendering transcluded content in transclusion suppression mode. | |
| Table Merger Macro Param Discard | Allows to discard list items. | |
| Tiny URL | Provides a short URL to the projectdoc document. | |
| Title | The title of the Confluence page. | |
| TranscludedDocumentTitles | Tracks direct transclusions a document is defining. | |
| Transclusion Box Date Format | Controls the format of the date rendered on the transclusion box. | |
| Transclusion Box Suppress Date | Controls the rendering of dates on the transclusion box. | |
| unsupplied | Marks a property as being imported from another projectdoc document, but its supplied status overridden by a local configuration. | Document Property Controls |
| updatePagesReferencedByProperties | Requests that after the page created with the wizard has been saved, some documents are invalidated in the cache. The value of the parameter specifies the name of properties whose values reference documents. These documents are invalidated. | |
| URL | Provides the absolute URL to the projectdoc document. | |
| Use Confluence Macro Style | Configuration to switch between our projectoc macro style in edit mode and back to the confluence default macro style. | |
| Use Default Space | Controls, if the the default space (IDX) should be used as index space, in case no space is explicitly specified. | |
| Use Delegate Space as Search Space | Controls, if the delegate space should be used as a search space in case that no search space is explicitly specified. | |
| Use Document Heading Number | Controls whether or not the title of the document should have a heading number. | |
| value-separator | Allows to specify an alternative value separator. | Document Property Controls |
| Version Comment | The comment added by the last modifier for the last version of the Confluence page. If there is no comment, the property is not set. | |
| Version Number | The last version number of the Confluence page. | |
| VersionHistory | The list of document names, starting from the root page, including the name of this page. | |
| Wiki Type | The type of the confluence entity. This is usually 'page'. |
Properties
- No labels
