Lists the configuration options at space level.
Placeholders
Since version 1.11 space property values may reference other space properties. Use the placeholder syntax to create these references. Note that these references are only enforced within the Document Properties Marker Macro of the space homepage (that is: only available for space properties). If you need to refer to a space property value within a page then use the Display Space Property Macro.
version=1.42.73
url=https://example.com/myservice/${version}/apidocs
Note that templates are resolved on request time, while the use of display macros are resolved at document save time. That also includes that documents cannot be queried by resolved template values. So if you need to query documents per property value, you need to use tools to resolve values at save time, not request time.
| Name | Short Description | Type |
|---|---|---|
| Apply Properties to Content | Controls the replacement of placeholders with the Content Marker Macro and the Section Macro. projectdoc.macro.content-marker.apply-document-properties | Boolean |
| 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. projectdoc.autocomplete.activeConstraint | string |
| Autoconvert Check Resources | Set the default value for macro parameters controlling the checking of the referenced resource. projectdoc.extension.information-systems.autoconvert.check-resources | boolean |
| 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. information-system-autoconvert-hint | list of strings |
| Caching Fragments | Activates the page fragment cache for a space. de.smartics.projectdoc.admin.caching.fragments | boolean |
| check | Toggles checking the existence of resources. check | boolean |
| Code Attachment Title Strategy | Controls the title shown in code boxes rendered by macros in the Information Systems Extension. projectdoc.extension.information-systems.code.attachment.title-strategy | enum |
| Code Language | Specifies the default language to be passed to the Code Block Macro. code-language | string |
| Counter Column Header | Controls the label for all counter columns of a space. counter-column-header | string |
| Debug Access Mode | Controls constraints on when debug rendering is conducted. projectdoc.debug-mode-access | enum |
| Debug Mode | Controls the rendering of documentation debug information. projectdoc.debug-mode | boolean |
| Default Group Name Pattern | Specifies for the name pattern the default group to select. projectdoc.doctype.*.document.name-pattern.group | int |
| Default Space Closure | List of spaces to delegate documents on creation to. Also works as a search space for upstream spaces. default-space-closure | string |
Controls if missing sections should render an error message ( false) or just display nothing (true).delegate-document.suppress-error-message.section | boolean | |
| Delegate Space | List of spaces to delegate documents on creation to. Also works as a search space for upstream spaces. delegate-space | list of space keys |
| 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. disable-document-name-as-scroll-office-title | boolean |
| Doctype Auto ID Pattern | Specifies the pattern for auto increments for a given doctype. projectdoc.doctype.(doctype).auto-id-pattern | JSON, string |
| Doctype Common Team | Controls the name of a team to replace the name of a team member for certain use cases. projectdoc.doctype.common.team | string |
| Doctype Document Name Pattern | Specifies a doctype-specific pattern to match against the title property to derive the name property of a projectdoc document. projectdoc.doctype.(doctype).document.name-pattern | Java RegEx |
| Doctype Document Name Pattern | Specifies a pattern to match against the title property to derive the name property of a projectdoc document. projectdoc.doctype.*.document.name-pattern | Java RegEx |
| Doctype Document Name Pattern Group | Specifies for the name pattern the doctype-specific group to select. projectdoc.doctype.(doctype).document.name-pattern.group | int |
| Doctype Home | Controls the location of the homepage of a given document type. Use the identifier of the doctype. projectdoc.doctype.(doctype).home | link |
| Doctype Instances Localization Mode | Controls how document instances are located in a space. projectdoc.links.doctype-instances-localization-mode | enumeration |
| Document Creation for Name List | Allows to configure the rendering of creation links for the Name List Macro (and its cousins). projectdoc.allowDocumentCreation.nameList | boolean |
| Document Property Default Values | Specified default values are not rendered in the document properties table. projectdoc-property-default-values-{document property name} | list of strings |
| Documentation JSON URI | The URI to a JSON document containing the URLs to the documentation for the blueprints. documentation-json-uri | string |
| 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. enable-heading-numbers | boolean |
| Ensure Unique Element Ids | Transclusion macros ensure per default that the HTML element IDs are unique. This space property allows to override the default behavior. projectdoc.html.ensureUniqueElementIds | boolean |
| Exclude Labels | Allows to control the parameter value of the Exclude Labels Parameter of the Tag List Macro. projectdoc.projectdoc-tag-list-macro.param.exclude-labels | Boolean |
| Extract Short Description From Metadata Table | The property to control how short description from the document properties tables within a space should be rendered. extract-short-description-from-metadata-table | boolean |
| Graph Type | string | |
| Heading Max Numbered | Controls the max depth to which headings are numbered. heading-max-numbered | int |
| Heading Starting Level | Controls the top heading level for a document. heading-starting-level | int |
The property to set the document type box displayed on each page to be hidden or not. hide-document-type-box | boolean | |
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 | boolean | |
The property to set metadata in document properties tables to be hidden or not for printing. Printing includes PDF, Word and HTML-Export. hide-metadata-for-printing | boolean | |
| Links Aside Panel Intro | Controls the standard intro text for aside panels. projectdoc.links.aside-panel-intro.{id} | string |
Controls whether or not standard introductional texts should be shown in related information aside panels on home and index pages. projectdoc.links.hide-related-information-intro | boolean | |
| Materialize by Doctype | Specify which properties to materialize as artificial properties by doctype. projectdoc-materialize-(doctype) | list of property paths |
| Max Initial Page for the Tasks Report Macro | Allows to specify the maximum number of pages matching the Where Constraint of the Tasks Report Macro. projectdoc.tasks-report-macro.maxInitialPages | int |
| Metadata Sets | Controls to render sets of metadata based on document properties. metadata-sets | list |
| 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-default-box-style | boolean |
| Name List Macro Defaults-to Configuration | Configure the Defaults-to parameter of the Name List Macro. projectdoc.name-list-macro.param.defaults-to.{Document Property Name} | enumeration |
| 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.name-list-(doctype)-box-style | boolean |
| 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-default-repo-id | string |
| Nexus Service | Contains the URL to the nexus service to download artifacts. nexus-service | string |
| 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. pretend-being-a | string |
| Print Quirk Modes | Controls which quirk modes are to be applied to adjust the output for a range of formats. print-quirk-modes | list |
| Project Artifact ID | The artifact identifier of the project. The value is used as a default value by macros referencing information systems. project-artifact-id | string |
| 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-classifier | string |
| Project Group ID | The group identifier of the project. The value is used as a default value by macros referencing information systems. project-group-id | string |
| 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-type | string |
| Project Version | The version of the project. The value is used as a default value by macros referencing information systems. project-version | string |
| Queries Allow Execution of unconstraint Queries | Controls whether or not the execution of queries without constraints are allowed or not. projectdoc.queries.allow-execution-of-unconstraint-queries | |
| Quirk Breadcrumb Root Node Fix | Allows to render an additional node using the CSS class 'first'. projectdoc.quirk.breadcrumb.rootNodeFix | boolean |
| Quote Macro Render Date with Brackets | Controls the rendering of brackets around the date. quote-macro-render-date-with-brackets | boolean |
| Quote Page Prefix | Specifies the prefix for specifying page locations for quotes and cites. quote-page-prefix | string |
| 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-separate | boolean |
| 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. quote-page-prefix-suppress-on-letter | boolean |
| Reference Space | List of spaces to include in downstream references. Use @all to refer to all spaces.reference-space | list of space keys |
| Render Counter Template | Provides a template to render the counter tracking elements of the Content Marker Macro. projectdoc.renderCounterElement.template.{render counter} | HTML fragment |
| Render Metadata as | The property to control how the document properties tables within a space should be rendered. render-metadata-as | enum |
| Render Properties Map | Controls whether a JSON fragment should be rendered as attribute to a Confluence Page with all Document Properties. projectdoc.render-properties-map | |
| Render Transclusion Box | Controls the rendering of transclusion boxes. render-transclusion-box | enum |
| Search Space | list of space keys | |
| 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.search-space-local | list of space keys |
| Server Root Based | Toggles g/a/v path generation for the Site Link Macro. server-root-based | boolean |
| 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. projectdoc.renderCounterElement.skip | boolean |
| 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 | list of links to documents |
| 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-doctypes | list of links to documents |
| Space Properties Extension Pattern | Stores the regular expression pattern to create a reference to a space properties extension. space-properties-extension-pattern | regular expression as a string |
| Strict HTML Encoding | Controls to employ strict HTML encoding. de.smartics.projectdoc.security.strictHtmlEncoding | Boolean |
| 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. projectdoc.subject.(subject-name).home | link |
| Suppress Heading Numbers on Doctypes | Controls the suppression of heading numbers dependent on the doctype. suppress-heading-numbers-on-doctypes | list of strings |
| Suppress Transclusion | Suppresses transclusions when set to 'true' on a space. suppress-transclusion | boolean |
| Suppress Transclusion Mode | Sets the mode for rendering transcluded content in transclusion suppression mode. suppress-transclusion-mode | enum |
| Table Merger Macro Param Discard | Allows to discard list items.
projectdoc.projectdoc-table-merger-macro.param.discard
| enumeration |
| Table Merger override empty Items | Allows to override the hide empty lines configuration of the Table Merger Macro. projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items | Boolean |
| Transclusion Box Date Format | Controls the format of the date rendered on the transclusion box. transclusion-box.date-format | Date Format |
| Transclusion Box Suppress Date | Controls the rendering of dates on the transclusion box. transclusion-box.suppress-date | boolean |
| Transclusion Lines | Set the default value for selecting on line numbers. projectdoc.extension.information-systems.transclusion.lines | string |
| Use Confluence Macro Style | Configuration to switch between our projectoc macro style in edit mode and back to the confluence default macro style. use-confluence-macro-style | boolean |
| Use Default Space | Controls, if the the default space (IDX) should be used as index space, in case no space is explicitly specified. use-default-space | boolean |
| 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-delegate-space-as-search-space | boolean |
| Use Document Heading Number | Controls whether or not the title of the document should have a heading number. use-document-heading-number | boolean |
User Space Properties
Users may override space properties with their personal preferences. This is useful to override rendering options.
Add a document properties table to the user's homepage.
The example overrides one property: hide-metadata.
