Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleAutocomplete 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.

TypeDescription
singleA single value (or none) is expected.
multiple

Any amount of values are allowed.

This approach is called prepared taxononmy 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

Documents need to be in iteration Released, Production, or Deprecated to be selected. Records may be in any Iteration state. This selection can be configured via a space property.

Caution Box
titleIteration 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 will not be rendered as a selection option.



Section
titleSupported Parameters

The following parameters support Autocomplete.


Section
titleNames 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)


Section
titleDoctypes Parameter

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


Section
titleDocuments 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
titleDocument 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.


...