Versions Compared

Key

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

...

Section


Column


Document Properties Marker
overridefalse


Short DescriptionIntroduction to the autoconvert feature for URIs to external systems.
Doctypetopichide
NameAutoconvert Information System URIs
Parent
Parent Property
propertyParent
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
namesAuthor, Documentation Architect, Documentation Gardener
propertyAudience
empty-as-nonefalse

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience

Expected Duration
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
names/ projectdoc / Extension / Information Systems Extension
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
value

filled

released

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesArticle
propertyType
empty-as-nonefalse

Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

ExtensionInformation Systems Extension
Since1.0
Sort Keyhide




Column


Panel
titleContents

Table of Contents
indent10px
excludeAutoconvert Information System URLs
stylenone
 



...

Section
titleConfiguration
tagscontent

The configuration of the autoconverters is conducted in two steps:

  1. Define the information system(s)
  2. Map information system(s) to autoconverters
Section
titleDefine 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.

Tip Box

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:

Code Block
languagetext
url-{system-id}

The key with the url-Prefix is always checked first.


Example Box
titleSpace Properties

The following examples shows the definition of three information systems as space properties.



Section
titleMap Information Systems

Use the space property information-system-autoconvert-hint Autoconvert Hint to bind autoconverters to information systems.

Tip Box

Check if the default configuration (as specified in information-system-autoconvert-hint 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.


Example Box
titleSpecify 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.

Version Box
since1.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.




Section
titleWhitelist

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.

Image Added

Image Added

When pasting an URL to a Wikipedia article, the autoconverter will create a macro for the link.

Image Added

The rendered macro will show the title of the article as its label instead of the URL.

Image Added



Section
titleAuthentication


Transclusion
documentAuthentication with Information Systems Extension
idsAuthentication


...

Section
titleResources

More information related to autoconverting URIs and information systems.

Tour
render-as-definition-listtrue
replace-title-with-nametrue




...