Introduction to the autoconvert feature for URIs to external systems.
Configuration
The configuration of the autoconverters is conducted in two steps:
- Define the information system(s)
- Map information system(s) to autoconverters
Define Information Systems
Define your information systems by binding an identifier to an URI. This binding may either be defined as a space property, a shortcut, or an application link.
If the information system macro defines a default system identifier, it is recommended to use this identifier for the binding. Users then do not need to type the identifier to the macros explicitly.
In situations where this system default identifier is already in use in a space with a different meaning, use the following syntax to specify the system with a space property:
url-{system-id}
The key with the url-Prefix is always checked first.
Space Properties
The following examples shows the definition of three information systems as space properties.
Map Information Systems
Use the space property Autoconvert Hint to bind autoconverters to information systems.
Check if the default configuration (as specified in Autoconvert Hint) will work for you. This is especially the case if you do not use the generic information systems to link to images or text resources.
If you can go with that configuration is much simpler - since nothing has to be done.
Note that if you specify one system, default systems are no longer defined.
Specify the Hint
The following examples shows how to bind information systems by their identifier to autoconverters.
Whenever a user pastes in the given space an URI with the prefix https://build.example.com/images/xmi an instance of the Enterprise Architect Image Link Macro is created. URIs with the prefix https://scs.example.com/images are stored in a System Image Link Macro.
Since 1.4
Since version 1.4 the link type is per default 'link', if not specified.
The old version, where the type matches the name can still be used if the hint ends with ':'. This will just save some typing since my-id: is the same as my-id:my-id.
Whitelist
Since the Confluence Whitelist restricts access to remote servers. URLs that are not listed in the Whitelist cannot be accessed from the Autoconvert code. Therefore all URLs configured for the projectdoc Autoconvert need also be added to the Whitelist.
Configuring the Whitelist, as part of the Confluence documentation by Atlassian, shows how to allow access to remote servers.
For the projectdoc Autoconvert only access to the remote system is required. The remote system does not access the Confluence server for this feature.
When pasting an URL to a Wikipedia article, the autoconverter will create a macro for the link.
The rendered macro will show the title of the article as its label instead of the URL.
Limitations on Autoconverters
The following limitations apply for uses of the autoconverters.
No Spaces
If the URI pasted to the editor contains a space, the macro will not get the whole URI.
This is because of the base library provided to integrate autoconverters.
If the space is replaced by a '+' sign or is encoded ('%20'), everything works as expected. But the quickest workaround would be to copy the parameter list into the body until the issue
PDEXINFOSY-6
-
Getting issue details...
STATUS
is resolved.
