Autocomplete

...

Section

Column

Document Properties Marker

override	false

Short Description

Support for users of projectdoc macros to select from a range of valid values.

Doctype

topic

hide

Name

Autocomplete

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

Since

4.0

Section

show-title	false
title	Description

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.

Column

width	40%

Table of Contents

indent	15px
style	none

...

Section

title	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.

Tip Box

title	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 projectdoc.autocomplete.activeConstraint Autocomplete Active Constraint.

Section

title	Supported Parameters

The following parameters support Autocomplete.

Section

title	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.

Image RemovedImage Added

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:

Image RemovedImage Added

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

Section

title	Doctypes Parameter

Many macros that allow to select doctypes are supporting a selection from a drop down menu.

Image RemovedImage Added

Caution Box

title	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.

Section

title	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)

Section

title	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.

...

Section

title	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.

Image RemovedImage Added

Section

title	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.

Note Box
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.

Section

title	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.

Section

title	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 shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 11

New Version Current

Key

About

Keep up-to-date!

Powered by