projectdoc Toolbox

Overview over the different categories of macros that are part of the Information Systems Extension.

Contents

 

Categories of Macros

There are three kinds of macros in this extension. Macros that

  1. help to integrate by identifying domain information
  2. reference or transclude image and text information
  3. reference or transclude text information with explicit URL

The first two versions have in common that the base link is configured at space level (or at site level using the Delegate Space feature). The third category provide tools to access remote information at an individual basis with explicitly specifying the URL.

Domain References

The macros make it easier to link to resources on remote servers. The link is specified in form of a domain specific value, not as a plain URL.

  • The Javadoc Link Macro allows to create a link to information in the API documentation by specifying the class or method.

    Java Elements in Javadoc

     

    To reference the a class, specify the name of the class like this:

    com.example.something.MyClass

    The following example references a method aMethod():

    com.example.something.MyClass.aMethod()

    Here an example referencing a method aMethod(String, Class<?>) with generics:

    com.example.something.MyClass.aMethod(java.lang.String, java.lang.Class)

    Note to specify the parameters fully qualified and that generic type parameters or wildcards are not part of the reference.

  • Reference to a view on the model create by the Enterprise Architect are created via the Image ID with the Enterprise Architect Image Link Macro.
  • The Nexus Link Macro renders links to artifacts with group, artifact, and version information.

     

    The macro body contains the reference to the artifact.

    This is the rendered short link:

    The rendered XML code looks like this:

    In this example the title is a link to the artifact on the Nexus server.

Generic Macros

Specify references to images and text based on systems specified at space level.

Use the placeholder feature to create reusable and maintainable space properties.

Explicit URL

 Macros allow to transclude by specifying the URL explicitly.

Macros

The extension provides the following macros to specify links or transclusions to remote resources.

#NameIterationShort Description
1Production
Renders an image generated from an Enterprise Architect diagram, transcluded from a server.
2HTML Snippet MacroProduction
Transclude HTML content from a remote server.
3Deprecated
4Production
5Production
6Deprecated
7Deprecated
8Deprecated
9Subversion Transclusion MacroDeprecated
Transcludes a snippet from a project on a Subversion (SVN) server.
10Production
Renders an image transcluded from a remote server.
11Production
12System Transclusion MacroProduction
Transclude content from a resource from a remote system.
13Text Snippet MacroProduction
Transclude text content from a remote server.