projectdoc Toolbox

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.

Identifier
information-system-autoconvert-hint
Component
Data Type
list of strings
Default Value
javadoc, url-javadoc, nexus, url-nexus, ea, url-ea

The information-system-autoconvert-hint allows authors and documentation architects to associate URIs to Autoconverters.

URIs are defined either as space properties, shortcuts, or application links (see System Identifier to URI Resolution Algorithm for details). This way an identifier is bound to an URI which defines an information system. This binding is used by the Information System Macros to decouple the URI from the macro.

Autoconverters register themselves with their default identifier to the URI Autoconverter Service. The individual default system identifier suggested by the macros is one of such an identifier. So users who stick to the defaults do not need to add any configuration. In case the default identifiers cannot be used, some of the URIs are so specific so that the URI Autoconverter Service can determine which on to use for a given URI. So in this case nothing needs to configured either.

In case users want to limit the autoconversion to a list of autoconverters, the information-system-autoconvert-hint defines this list. If a value is specified this way, all defaults are overridden.

 

Note that specific URLs are always replaced and there is currently no option to disable it separately

It is recommended to bind an information system to a system type defined by the autoconverter. This is done by binding a system identifier to a system type.

Here is the list of autoconverters that bind to a type.

AutoconverterTypeMacro
JavadocjavadocJavadoc Link Macro
NexusnexusNexus Link Macro
Enterprise Architect (EA)eaEnterprise Architect Image Link Macro
Generic ImageimageSystem Image Link Macro
Generics LinklinkSystem Link Macro

System Specifier Example

 

Suppose there are two information systems defined

System IDURL
eahttps://build.example.com/images/xmi
picshttps://scs.example.com/images

The specifier list to autoconvert links to Diagram images exported from the Enterprise Architect with the EA Autoconverter and ordinary images with the Generic Image Autoconverter, specify information-system-autoconvert-hint as follows:

ea:ea, pics:image