- Created by Robert Reiner, last modified on 02. Oct 2019
projectdoc Toolbox
Support for users of projectdoc macros to select from a range of valid values.
- Tags
- Since
- 4.0
The Autocomplete Feature has been introduced with version 4.0 of the projectdoc Toolbox. Users are supported by providing a range of valid values to select from. Autocomplete is supported by a number of macros for a number of their parameters.
The feature is currently experimental, but activated by default.
Autocomplete in the projectdoc Toolbox
Autocomplete is provided for a selection of macro on a selection of macro parameters.
Autocomplete does allow the user to select a value for a macro parameter from a list of valid values. Some parameter values are required to be a single value, other may allow to specify multiple values. In some cases where multiple values are allowed, there is a add-hoc taxonomy supported, in others this taxonomy needs to be prepared in advance.
Type | Description |
---|---|
single | A single value (or none) is expected. If Restricted to Range is checked in this case, the select widget turns into the multiple selection mode. |
multiple | Any amount of values are allowed. This approach is called prepared taxonomy since only values that are already defined are allowed. Examples: Categories and types. |
tagging | Values are allowed that are not already defined in projectdoc. Can only be used with multiple. This approach is called ad-hoc taxonomy since the taxonomy on the type is expanded by selection a value that is not already defined. Examples: Tags |
Per default all documents are taken into account to derive names.
Iteration Released, Production, or Deprecated
If a document is not in a ready-for-use state, which is Released, Production, or Deprecated, then the name of the document may not be intended to be rendered as a selection option.
This selection can be configured via the space property named Autocomplete Active Constraint.
Supported Parameters
The following parameters support Autocomplete.
Names Parameter
The Name List Macro allows to select names from a range of valid names. The range of valid names is defined by the documents of the referenced doctype.
The following parameter put constraints on the search result:
- Doctype - the value is required
- Space Key / Space Keys - limit the name search to the specified spaces / space groups
- Where - provide a where clause (similar to using the Where parameter of the Display Table Macro)
- Autocomplete Sort - provide a sort order (similar to using the Sort By parameter of the Display Table Macro)
The multiplicity (single/multiple) and the tagging option can be configured by the following macro parameters:
Currently only the Name List Macros allow this configuration for their Names Parameter. There is no option to configure this for e.g. the Doctype Parameter.
Type | Macro Parameter Restrict to one Value | Macro Parameter Restricted to Range |
---|---|---|
single | Checked | Unchecked |
multiple | Unchecked | Unchecked |
tagging | Unchecked | Checked |
Doctypes Parameter
Many macros that allow to select doctypes are supporting a selection from a drop down menu.
Doctypes missing?
In case the list of doctypes is incomplete, the doctype cache may be corrupt. In this case the doctype cache needs to be refreshed.
See Cache Refresh Actions on how to do this.
Documents Parameter
The Display Document Property Macro allows to select one or more documents to display property values.
Other display document property macros also allow to select one or more documents.
Note that the selection can be constraint on macro basis by the following properties:
- Autocomplete Constraints - provide a where clause (similar to using the Where parameter of the Display Table Macro)
- Autocomplete Sort - provide a sort order (similar to using the Sort By parameter of the Display Table Macro)
Document Property Name Parameter
The Display Document Property Macro supports selecting a valid property name from a referenced document. In case there are multiple documents referenced, the user may pick from the merged sets of property names of the referenced documents.
Macro Parameter Panel
Selecting a value when clicking on a macro in the page editor is an experimental feature that is turned off by default.
Feature Configuration
The feature can be configured for the whole site. The user needs admin privileges to access these.
Go to General configuration.
Then click "Experimental Features".
This leads to the Experimental Features page.
In case the Autocomplete Feature is not activated, the subfeatures Use Macro Parameter Panel for Autocomplete and Force ad-hoc Taxonomies are deactivated by default.
Macro Parameter Panel Support
If checked, the macro parameter panel is activated to quickly edit values for a given macro parameter.
For instance names for a name list macro.
Currently the feature is not fully tested for all use cases. Especially the focus handling requires additional work.
The feature can be activated when users want to test how this option would work for their use cases.
Force ad-hoc Taxonomies
Some parameters no longer allow arbitrary values. For instance the type and category parameter values must be selected from a defined set of values.
In case this does not work for your use cases, you may override this restriction and allow arbitrary values (ad-hoc taxonomies) for any parameter. This is the configuration for projectdoc Toolbox versions prior to 4.0.
Space Properties
The following space properties support configuring the Autocomplete Feature:
Name | Short Description | Value Range |
---|---|---|
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. | #none , Query Constraint |
Macros
The following macros support, possibly partially, Autocomplete:
Name | Short Description | Categories | Tags |
---|---|---|---|
Child Documents Macro | Renders the list of child documents, matching the given filter criteria. | Link / Document | |
Display Document Properties Macro | Renders a template with property references. | Display / Property | |
Display Document Property As Image Macro | Renders the value of a document property as an image. The property value is required to an URL that points to an image. | Display / Property | |
Display Document Property As Link Macro | Renders the value of a document property as a link with an alternative label. | Display / Property | |
Display Document Property As List Macro | Renders the list value of a document property. | Display / Property | |
Display Document Property Macro | Renders the value of a property of a document. | Display / Property | |
Display Document Property Ref Concat Macro | Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property. | Display / Property | |
Display Document Property Ref Macro | Displays a document property from a referenced document. | Display / Property | |
Display List Macro | Lists references to projectdoc documents in a list. List contain names and optional short descriptions. | Display / Query | |
Display List Template Macro | Lists references to projectdoc documents in a list. List items are defined by templates referencing properties. | Display / Query | |
Display Table Macro | Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | Display / Query | |
Index Card Macro | Renders transcluded content fetched from documents of a result set. | Display / Query | |
Index Entries Table Macro | Renders a table of index entries. | Display / Query | |
Name List Macro | Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name. | Link / Document | |
Role List Macro | Renders a name list while taking care of special role semantics. Confluence names of groups with view permissions are added to the list of values. | Link / Document | |
Tag List Macro | Renders a name list while taking care of special tag semantics. Confluence labels are added virtually to this list and displayed in the tags table row of the document properties table. | Link / Document | |
Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. | Display / Query |