This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new b154c74f28 ISIS-2965: updates docs
b154c74f28 is described below
commit b154c74f28bd5a658f2eca9663c14d4cc1031795
Author: Dan Haywood <[email protected]>
AuthorDate: Sun Aug 21 07:16:59 2022 +0100
ISIS-2965: updates docs
---
.../modules/ROOT/pages/building-apache-isis.adoc | 21 +-
.../conguide/modules/ROOT/pages/contributing.adoc | 19 +-
.../documentation/pages/asciidoc-syntax.adoc | 35 +-
.../components/docs/modules/ROOT/pages/about.adoc | 11 +-
.../ROOT/partials/module-nav/components.adoc | 4 -
.../modules/ROOT/partials/module-nav/guides.adoc | 8 +-
.../docs/modules/resources/partials/C4.puml | 1210 --------------------
.../modules/resources/partials/C4_Container.puml | 111 --
.../modules/resources/partials/C4_Context.puml | 292 -----
.../setupguide/modules/eclipse/pages/about.adoc | 1 -
.../setupguide/modules/intellij/pages/about.adoc | 16 +-
core/adoc/modules/ROOT/partials/component-nav.adoc | 2 +-
.../internaltestsupport/partials/module-nav.adoc | 4 +-
.../main/adoc/modules/metamodel/pages/about.adoc | 106 --
regressiontests/adoc/modules/ROOT/pages/about.adoc | 7 +-
15 files changed, 48 insertions(+), 1799 deletions(-)
diff --git
a/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
b/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
index f2367673fa..a7a6fba533 100644
--- a/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
+++ b/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
@@ -9,7 +9,7 @@
From the root project root run:
[source,bash]
-----gacyy
+----
mvn clean install
----
@@ -298,23 +298,4 @@ The first time this runs can take 10~20 minutes to
download the NVD data feeds.
To disable, either run in offline mode (add `-o` or `--offline`) or omit the
`owasp` property.
-== Checking for use of internal JDK APIs
-
-Apache Isis configures the
link:https://maven.apache.org/plugins-archives/maven-jdeps-plugin-3.0.0/[jdeps
maven plugin] to check for any usage of internal JDK APIs.
-This is in preparation for Java 9 module system (Jigsaw) which will prevent
such usage of APIs.
-
-To check, run:
-
-[source,bash]
-----
-mvn clean install -Djdeps
-----
-
-This will fail the build on any module that currently uses an internal JDK API.
-
-[WARNING]
-====
-At the time of writing the `isis-core-schema` module fails the build.
-====
-
diff --git a/antora/components/conguide/modules/ROOT/pages/contributing.adoc
b/antora/components/conguide/modules/ROOT/pages/contributing.adoc
index f4a0b6acc5..92b941fe47 100644
--- a/antora/components/conguide/modules/ROOT/pages/contributing.adoc
+++ b/antora/components/conguide/modules/ROOT/pages/contributing.adoc
@@ -84,9 +84,9 @@ We therefore recommend that your commit messages are as
follows:footnote:[Inspir
[source,other]
----
-ISIS-999: Make the example in CONTRIBUTING imperative and concrete
+ISIS-999: Makes the example in CONTRIBUTING imperative and concrete
-Without this patch applied the example commit message in the CONTRIBUTING
+Without this patch applied, the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
@@ -97,23 +97,10 @@ from our issue tracker. The body describes the behavior
without the patch,
why this is a problem, and how the patch fixes the problem when applied.
----
-== Creating the patch file
-
-If you are working without a GitHub fork of Apache Isis, then you can create
the patches from your own local git repository.
-
-As per
http://stackoverflow.com/questions/6658313/generate-a-git-patch-for-a-specific-commit[this
stackoverflow question], create the patch using `git format-patch`:
-
-[source,bash]
-----
-git format-patch -10 HEAD --stdout > 0001-last-10-commits.patch
-----
-
-Here `-10` is the last 10 commits you have done.
-You need to change that integer according to the commits you need to apply
into the patch.
== Sample Contribution Workflow
-Assuming you're development environment is all setup, let's walk through how
you might make contribute a patch.
+Assuming your development environment is all setup, let's walk through how you
might make contribute a patch.
In this example, suppose that you've decided to work on JIRA ticket #123, an
enhancement to support Blob/Clob datatypes.
=== Update your master branch
diff --git
a/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc
b/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc
index d4f7afd72b..4bd63a930a 100644
---
a/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc
+++
b/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc
@@ -757,7 +757,17 @@ For example, the `setting-up/concepts/concepts.adoc` file
starts:
-== UML diagrams
+== Diagrams
+
+Asciidoctor supports numerous diagram types through the
link:https://github.com/Mogztter/asciidoctor-kroki[asciidoctor-kroki] plugin.
+
+This calls the link:https://kroki.io/[kroki] online service (it can also be
link:https://kroki.io/#install[installed] to run on-prem) which generates
diagrams from textual markup.
+
+PlantUml, PlantUML + C4, ditaa, graphviz and numerous other formats are
supported.
+The sections below provide examples of some of these.
+
+
+=== UML diagrams
Asciidoctor includes support for the link:http://plantuml.com/[plantuml],
allowing simple UML diagrams to be easily sketched.
@@ -791,7 +801,7 @@ Car -- Person : < owns
----
-== C4 diagrams
+=== C4 diagrams
Asciidoctor includes support for the link:https://c4model.com//[c4 model].
@@ -801,9 +811,7 @@ For example:
[c4plantuml,c4-demo,svg]
----
@startuml
-include::docs:resources:partial$C4.puml[]
-include::docs:resources:partial$C4_Context.puml[]
-include::docs:resources:partial$C4_Container.puml[]
+!includeurl
https://raw.githubusercontent.com/RicardoNiepel/C4-PlantUML/master/C4_Container.puml
title System Context diagram for Internet Banking System
@@ -844,7 +852,7 @@ Rel(banking_system, mainframe, "Uses")
----
-== Ditaa diagrams
+=== Ditaa diagrams
Asciidoctor includes support for the
link:http://ditaa.sourceforge.net/[ditaa], allowing boxes-and-lines diagrams to
be easily sketched.
@@ -881,7 +889,7 @@ renders as:
----
-== Graphviz diagrams
+=== Graphviz diagrams
Asciidoctor includes support for the
link:http://ditaa.sourceforge.net/[ditaa], allowing boxes-and-lines diagrams to
be easily sketched.
@@ -937,10 +945,13 @@ Alternatively, specify the location, eg using:
====
-== Kroki
+=== diagrams.net (draw.io) diagrams
+
+Rather than describing diagrams in text format, an alternative is to just draw
the diagrams using the link:https://www.diagrams.net/[diagrams.net] editor
+(previously called draw.io).
+
+You can find an example of a class diagram drawn this way in the
xref:core:metamodel:class-diagram.adoc[internal design docs] for
`core/metamodel` module.
-An alternative to using plantuml etc is link:https://kroki.io/[kroki].
-This is an online service (can also be
link:https://kroki.io/#install[installed] to run on-prem) which generates
textual markup for any of a number of different formats (including all of
plantuml, ditaa and graphviz).
+If using IntelliJ, the
link:https://plugins.jetbrains.com/plugin/15635-diagrams-net-integration[diagrams.net]
plugin embeds this within the IDE, and works seamlessly with the Asciidoctor
plugin.
-Getting Kroki to work with Antora is possible, but not (at the time of
writing) completely smooth.
-But this should become seamless in the future.
+Diagrams can be saved in either `.svg` or `.png` format.
diff --git a/antora/components/docs/modules/ROOT/pages/about.adoc
b/antora/components/docs/modules/ROOT/pages/about.adoc
index 337ebc97bc..802f97176d 100644
--- a/antora/components/docs/modules/ROOT/pages/about.adoc
+++ b/antora/components/docs/modules/ROOT/pages/about.adoc
@@ -53,18 +53,16 @@ _POMs_
[discrete]
== Guides
-_Development_
-
-* xref:setupguide:ROOT:about.adoc[Setup Guide]
-
_Core_
* *xref:userguide:ROOT:about.adoc[User Guide]*
* *xref:refguide:ROOT:about.adoc[Reference Guide]*
* *xref:testing:ROOT:about.adoc[Testing Guide]*
+* *xref:security:ROOT:about.adoc[Security Guide]*
-_Process_
+_Development_
+* xref:setupguide:ROOT:about.adoc[Setup Guide]
* xref:conguide:ROOT:about.adoc[Contributors' Guide]
|
@@ -81,9 +79,6 @@ _Persistence_
* xref:pjpa:ROOT:about.adoc[JPA (EclipseLink)]
* xref:pjdo:ROOT:about.adoc[JDO (DataNucleus)]
-_Security_
-
-* *xref:security:ROOT:about.adoc[Security Guide]*
|
diff --git
a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc
b/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc
index 7801cfe299..e0cb77b980 100644
--- a/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc
+++ b/antora/components/docs/modules/ROOT/partials/module-nav/components.adoc
@@ -13,7 +13,3 @@
*** xref:pjpa:ROOT:about.adoc[JPA (EclipseLink)]
*** xref:pjdo:ROOT:about.adoc[JDO (DataNucleus)]
-** Security
-
-*** xref:security:ROOT:about.adoc[Security Guide]
-
diff --git
a/antora/components/docs/modules/ROOT/partials/module-nav/guides.adoc
b/antora/components/docs/modules/ROOT/partials/module-nav/guides.adoc
index 2518eea6cd..cbeaa5eb79 100644
--- a/antora/components/docs/modules/ROOT/partials/module-nav/guides.adoc
+++ b/antora/components/docs/modules/ROOT/partials/module-nav/guides.adoc
@@ -3,16 +3,14 @@
* Guides
-** Development
-
-*** xref:setupguide:ROOT:about.adoc[Setup Guide]
-
** Core
*** xref:userguide:ROOT:about.adoc[User Guide]
*** xref:refguide:ROOT:about.adoc[Reference Guide]
*** xref:testing:ROOT:about.adoc[Testing Guide]
+*** xref:security:ROOT:about.adoc[Security Guide]
-** Process
+** Development
+*** xref:setupguide:ROOT:about.adoc[Setup Guide]
*** xref:conguide:ROOT:about.adoc[Contributors' Guide]
diff --git a/antora/components/docs/modules/resources/partials/C4.puml
b/antora/components/docs/modules/resources/partials/C4.puml
deleted file mode 100644
index 5ce387bb77..0000000000
--- a/antora/components/docs/modules/resources/partials/C4.puml
+++ /dev/null
@@ -1,1210 +0,0 @@
-' C4-PlantUML
-
-'Version
-' ##################################
-!function C4Version()
- !return "2.5.0beta1"
-!end function
-
-!procedure C4VersionDetails()
-rectangle C4VersionDetailsArea <<legendArea>> [
-| PlantUML | **%version()** |
-| C4-PlantUML | **C4Version()** |
-]
-!end procedure
-
-' Colors
-' ##################################
-
-!global $ELEMENT_FONT_COLOR = "#FFFFFF"
-
-!global $ARROW_COLOR = "#666666"
-
-!global $BOUNDARY_COLOR = "#444444"
-!global $BOUNDARY_BG_COLOR = "transparent"
-
-!global $LEGEND_FONT_COLOR = "#FFFFFF"
-!global $LEGEND_TITLE_COLOR = "#000000"
-' %darken(darkkhaki,50), #khaki
-!global $LEGEND_DARK_COLOR = "#66622E"
-!global $LEGEND_LIGHT_COLOR = "#khaki"
-
-!global $SKETCH_BG_COLOR = "#EEEBDC"
-!global $SKETCH_FONT_COLOR = ""
-!global $SKETCH_WARNING_COLOR = "red"
-!global $SKETCH_FONT_NAME = "Comic Sans MS"
-
-' Labels
-' ##################################
-
-!global $LEGEND_SHADOW_TEXT = "(shadow) "
-!global $LEGEND_NO_SHADOW_TEXT = "(no shadow) "
-!global $LEGEND_NO_FONT_BG_TEXT = "(no text, no back color) "
-!global $LEGEND_NO_FONT_TEXT = "(no text color) "
-!global $LEGEND_NO_BG_TEXT = "(no back color) "
-!global $LEGEND_NO_LINE_TEXT = "(no line color) "
-!global $LEGEND_ROUNDED_BOX = "(rounded box) "
-!global $LEGEND_EIGHT_SIDED = "(eight sided) "
-!global $LEGEND_DOTTED_LINE = "(dotted) "
-!global $LEGEND_DASHED_LINE = "(dashed) "
-!global $LEGEND_BOLD_LINE = "(bold) "
-
-!global $SKETCH_FOOTER_WARNING = "Warning:"
-!global $SKETCH_FOOTER_TEXT = "Created for discussion, needs to be validated"
-
-' Styling
-' ##################################
-
-!global $TECHN_FONT_SIZE = 12
-!global $ROUNDED_BOX_SIZE = 25
-!global $EIGHT_SIDED_SIZE = 18
-
-!global $ROUNDED_BOX = "roundedBox"
-!global $EIGHT_SIDED = "eightSided"
-
-!global $DOTTED_LINE = "dotted"
-!global $DASHED_LINE = "dashed"
-!global $BOLD_LINE = "bold"
-
-skinparam defaultTextAlignment center
-
-skinparam wrapWidth 200
-skinparam maxMessageSize 150
-
-skinparam LegendBorderColor transparent
-skinparam LegendBackgroundColor transparent
-skinparam LegendFontColor $LEGEND_FONT_COLOR
-
-skinparam shadowing<<legendArea>> false
-' #00000000 is transparent
-skinparam rectangle<<legendArea>> {
- backgroundcolor #00000000
- bordercolor #00000000
-}
-
-skinparam rectangle {
- StereotypeFontSize 12
- shadowing false
-}
-
-skinparam database {
- StereotypeFontSize 12
- shadowing false
-}
-
-skinparam queue {
- StereotypeFontSize 12
- shadowing false
-}
-
-skinparam arrow {
- Color $ARROW_COLOR
- FontColor $ARROW_COLOR
- FontSize 12
-}
-
-skinparam actor {
- StereotypeFontSize 12
- shadowing false
- style awesome
-}
-
-skinparam person {
- StereotypeFontSize 12
- shadowing false
-}
-
-' Some boundary skinparams have to be set as package skinparams too (PlantUML
uses internal packages)
-skinparam package {
- StereotypeFontSize 6
- StereotypeFontColor $BOUNDARY_BG_COLOR
- FontStyle plain
- BackgroundColor $BOUNDARY_BG_COLOR
-}
-
-skinparam rectangle<<boundary>> {
- Shadowing false
- StereotypeFontSize 6
- StereotypeFontColor $BOUNDARY_BG_COLOR
- FontColor $BOUNDARY_COLOR
- BorderColor $BOUNDARY_COLOR
- BackgroundColor $BOUNDARY_BG_COLOR
- BorderStyle dashed
-}
-
-' Legend and Tags
-' ##################################
-!global $tagDefaultLegend = ""
-!global $tagCustomLegend = ""
-
-' rel specific
-!unquoted function $toStereos($tags)
- !if (%strlen($tags) == 0)
- !return ''
- !endif
- !$stereos = ''
- !$brPos = %strpos($tags, "+")
- !while ($brPos >= 0)
- !$tag = %substr($tags, 0, $brPos)
- !$stereos = $stereos + '<<' + $tag + '>>'
-%set_variable_value("$" + $tag + "_LineLegend", %true())
- !$tags = %substr($tags, $brPos+1)
- !$brPos = %strpos($tags, "+")
- !endwhile
- !if (%strlen($tags) > 0)
- !$stereos = $stereos + '<<' + $tags + '>>'
-%set_variable_value("$" + $tags + "_LineLegend", %true())
- !endif
- !return $stereos
-!endfunction
-
-' if $sprite/$techn is an empty argument, try to calculate it via the defined
$tag
-!unquoted function $toRelArg($arg, $tags, $varPostfix)
- !if ($arg > "")
- !return $arg
- !endif
-
- !if (%strlen($tags) == 0)
- !return $arg
- !endif
- !$brPos = %strpos($tags, "+")
- !while ($brPos >= 0)
- !$tag = %substr($tags, 0, $brPos)
- !$newArg = %get_variable_value("$" + $tag + $varPostfix)
- !if ($newArg > "")
- !return $newArg
- !endif
- !$tags = %substr($tags, $brPos+1)
- !$brPos = %strpos($tags, "+")
- !endwhile
- !if (%strlen($tags) > 0)
- !$newArg = %get_variable_value("$" + $tags + $varPostfix)
- !if ($newArg > "")
- !return $newArg
- !endif
- !endif
- !return $arg
-!endfunction
-
-' element specific (unused are hidden based on mask)
-!unquoted function $toStereos($elementType, $tags)
- !if (%strlen($tags) == 0)
- !$stereos = '<<' + $elementType + '>>'
-%set_variable_value("$" + $elementType + "Legend", %true())
- !return $stereos
- !endif
- !$stereos = ''
- !$mask = $resetMask()
- !$brPos = %strpos($tags, "+")
- !while ($brPos >= 0)
- !$tag = %substr($tags, 0, $brPos)
- !$stereos = $stereos + '<<' + $tag + '>>'
- !$mergedMask = $combineMaskWithTag($mask, $tag)
- !if ($mergedMask != $mask)
-%set_variable_value("$" + $tag + "Legend", %true())
- !$mask = $mergedMask
- !endif
- !$tags = %substr($tags, $brPos+1)
- !$brPos = %strpos($tags, "+")
- !endwhile
- !if (%strlen($tags) > 0)
- !$stereos = $stereos + '<<' + $tags + '>>'
- !$mergedMask = $combineMaskWithTag($mask, $tags)
- !if ($mergedMask != $mask)
-%set_variable_value("$" + $tags + "Legend", %true())
- !$mask = $mergedMask
- !endif
- !endif
- ' has to be last, otherwise PlantUML overwrites all tag specific skinparams
- !$stereos = $stereos + '<<' + $elementType + '>>'
- !$mergedMask = $combineMaskWithTag($mask, $elementType)
- !if ($mergedMask != $mask)
-%set_variable_value("$" + $elementType + "Legend", %true())
- !$mask = $mergedMask
- !endif
- !return $stereos
-!endfunction
-
-' if $sprite/$techn is an empty argument, try to calculate it via the defined
$tag
-!unquoted function $toElementArg($arg, $tags, $varPostfix, $elementType)
- !if ($arg > "")
- !return $arg
- !endif
-
- !if (%strlen($tags) == 0)
- !$newArg = %get_variable_value("$" + $elementType + $varPostfix)
- !if ($newArg > "")
- !return $newArg
- !else
- !return $arg
- !endif
- !endif
- !$brPos = %strpos($tags, "+")
- !while ($brPos >= 0)
- !$tag = %substr($tags, 0, $brPos)
- !$newArg = %get_variable_value("$" + $tag + $varPostfix)
- !if ($newArg > "")
- !return $newArg
- !endif
- !$tags = %substr($tags, $brPos+1)
- !$brPos = %strpos($tags, "+")
- !endwhile
- !if (%strlen($tags) > 0)
- !$newArg = %get_variable_value("$" + $tags + $varPostfix)
- !if ($newArg > "")
- !return $newArg
- !endif
- !$newArg = %get_variable_value("$" + $elementType + $varPostfix)
- !if ($newArg > "")
- !return $newArg
- !endif
- !endif
- !return $arg
-!endfunction
-
-!function $elementTagSkinparams($element, $tagStereo, $bgColor, $fontColor,
$borderColor, $shadowing, $shape)
- !$elementSkin = "skinparam " + $element + "<<" + $tagStereo + ">> {" +
%newline()
- !if ($fontColor != "")
- !if ($tagStereo != "boundary")
- !$elementSkin = $elementSkin + " StereotypeFontColor " + $fontColor +
%newline()
- !endif
- !$elementSkin = $elementSkin + " FontColor " + $fontColor + %newline()
- !endif
- !if ($bgColor != "")
- !$elementSkin = $elementSkin + " BackgroundColor " + $bgColor +
%newline()
- !endif
- !if ($borderColor != "")
- !$elementSkin = $elementSkin + " BorderColor " + $borderColor+
%newline()
- !endif
- !if ($shadowing == "true")
- !$elementSkin = $elementSkin + " Shadowing<<" + $tagStereo + ">> " +
"true" + %newline()
- !endif
- !if ($shadowing == "false")
- !$elementSkin = $elementSkin + " Shadowing<<" + $tagStereo + ">> " +
"false" + %newline()
- !endif
- ' only rectangle supports shape(d corners), define both skinparam that
overlays are working
- !if ($shape != "" && $element == "rectangle")
- !if ($shape == $ROUNDED_BOX)
- !$elementSkin = $elementSkin + " RoundCorner " + $ROUNDED_BOX_SIZE+
%newline()
- !$elementSkin = $elementSkin + " DiagonalCorner " + "0" + %newline()
- !elseif ($shape == $EIGHT_SIDED)
- !$elementSkin = $elementSkin + " RoundCorner " + "0" + %newline()
- !$elementSkin = $elementSkin + " DiagonalCorner " +
$EIGHT_SIDED_SIZE+ %newline()
- !endif
- !endif
- !$elementSkin = $elementSkin + "}" + %newline()
- !return $elementSkin
-!endfunction
-
-!unquoted procedure $defineSkinparams($tagStereo, $bgColor, $fontColor,
$borderColor, $shadowing, $shape)
- ' only rectangle supports shape(d corners)
- !$tagSkin = $elementTagSkinparams("rectangle", $tagStereo, $bgColor,
$fontColor, $borderColor, $shadowing, $shape)
- !$tagSkin = $tagSkin + $elementTagSkinparams("database", $tagStereo,
$bgColor, $fontColor, $borderColor, $shadowing, "")
- !$tagSkin = $tagSkin + $elementTagSkinparams("queue", $tagStereo, $bgColor,
$fontColor, $borderColor, $shadowing, "")
- ' actor has style awesome, therefore $fontColor is ignored and text uses
$bgColor too
- !$tagSkin = $tagSkin + $elementTagSkinparams("actor", $tagStereo, $bgColor,
$bgColor, $borderColor, $shadowing, "")
- !$tagSkin = $tagSkin + $elementTagSkinparams("person", $tagStereo, $bgColor,
$fontColor, $borderColor, $shadowing, "")
- !if ($tagStereo == "boundary" && $bgColor != "")
- !$tagSkin = $tagSkin + "skinparam package<<boundary>>StereotypeFontColor "
+ $bgColor + %newline()
- !$tagSkin = $tagSkin + "skinparam rectangle<<boundary>>StereotypeFontColor
" + $bgColor + %newline()
- !endif
-$tagSkin
-!endprocedure
-
-' arrow colors cannot start with # (legend background has to start with #)
-!function $colorWithoutHash($c)
- !if (%substr($c, 0, 1) == "#")
- !$c = %substr($c,1)
- !endif
- !return $c
-!endfunction
-
-!unquoted procedure $defineRelSkinparams($tagStereo, $textColor, $lineColor,
$lineStyle)
- !$elementSkin = "skinparam arrow<<" + $tagStereo + ">> {" + %newline()
- !$elementSkin = $elementSkin + " Color "
- !if ($lineColor != "")
- !$elementSkin = $elementSkin + $colorWithoutHash($lineColor)
- !endif
- !if ($textColor != "")
- !$elementSkin = $elementSkin + ";text:" + $colorWithoutHash($textColor)
- !endif
- !if ($lineStyle != "")
- !$elementSkin = $elementSkin + ";line." + $lineStyle
- !endif
- !$elementSkin = $elementSkin + %newline()
- !$elementSkin = $elementSkin + "}" + %newline()
-$elementSkin
-!endprocedure
-
-' %is_dark() requires PlantUML version >= 1.2021.6
-!if (%function_exists("%is_dark"))
- !$PlantUMLSupportsDynamicLegendColor = %true()
-!else
- !$PlantUMLSupportsDynamicLegendColor = %false()
- !log "dynamic undefined legend colors" requires PlantUML version >=
1.2021.6, therefore only static assigned colors are used
-!endif
-
-!unquoted function $contrastLegend($color)
- !if (%is_dark($color))
- !$value = $LEGEND_LIGHT_COLOR
- !else
- !$value = $LEGEND_DARK_COLOR
- !endif
- !return $value
-!endfunction
-
-!unquoted function $flatLegend($color)
- !if (%is_dark($color))
- !$value = $LEGEND_DARK_COLOR
- !else
- !$value = $LEGEND_LIGHT_COLOR
- !endif
- !return $value
-!endfunction
-
-' legend background has to start with #
-!function $colorWithHash($c)
- !if (%substr($c, 0, 1) != "#")
- !$c = "#" + $c
- !endif
- !return $c
-!endfunction
-
-!function $addMaskFlag($mask, $attr)
- !if ($attr == "")
- !$mask = $mask + "0"
- !else
- !$mask = $mask + "1"
- !endif
- !return $mask
-!endfunction
-
-!function $orFlags($flag1, $flag2)
- !if ($flag1 == "0" && $flag2 == "0")
- !return "0"
- !endif
- !return "1"
-!endfunction
-
-!function $tagLegendMask($bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite)
- !$mask = ""
- !$mask = $addMaskFlag($mask, $bgColor)
- !$mask = $addMaskFlag($mask, $fontColor)
- !$mask = $addMaskFlag($mask, $borderColor)
- !$mask = $addMaskFlag($mask, $shadowing)
- !$mask = $addMaskFlag($mask, $shape)
- !$mask = $addMaskFlag($mask, $sprite)
- !return $mask
-!endfunction
-
-!function $resetMask()
- !return "000000"
-!endfunction
-
-!function $combineMasks($mask1, $mask2)
- !$mask = ""
- !$mask = $mask + $orFlags(%substr($mask1, 0, 1), %substr($mask2, 0, 1))
- !$mask = $mask + $orFlags(%substr($mask1, 1, 1), %substr($mask2, 1, 1))
- !$mask = $mask + $orFlags(%substr($mask1, 2, 1), %substr($mask2, 2, 1))
- !$mask = $mask + $orFlags(%substr($mask1, 3, 1), %substr($mask2, 3, 1))
- !$mask = $mask + $orFlags(%substr($mask1, 4, 1), %substr($mask2, 4, 1))
- !$mask = $mask + $orFlags(%substr($mask1, 5, 1), %substr($mask2, 5, 1))
- !return $mask
-!endfunction
-
-!function $combineMaskWithTag($mask1, $tag)
- !$mask2 = %get_variable_value("$" + $tag+ "LegendMask")
- !if ($mask2 == "")
- ' !log combineMaskWithTag $mask1, $tag, ... only $mask1
- !return $mask1
- !endif
-
- ' !log combineMaskWithTag $mask1, $tag, $mask2 ... $combineMasks($mask1,
$mask2)
- !return $combineMasks($mask1, $mask2)
-!endfunction
-
-' element symbols typically 4 times too big in legend
-!function $smallVersionSprite($sprite)
- ' ,scale= ... has to be first (...,color=black,scale=0.25... is invalid too)
- !if (%strpos($sprite, "=") < 0)
- !if (%substr($sprite, 0, 4) == "img:")
- !$smallSprite = $sprite + "{scale=0.25}"
- !else
- !$smallSprite = $sprite + ",scale=0.25"
- !endif
- !else
- !$smallSprite = $sprite
- !endif
- !return $smallSprite
-!endfunction
-
-' format sprite that it can be used in diagram
-!function $getSprite($sprite)
- ' if it starts with & it's a OpenIconic, details see
https://useiconic.com/open/
- ' if it starts with img: it's an image, details see
https://plantuml.com/creole
- !if (%substr($sprite, 0, 1) != "&" && %substr($sprite, 0, 4) != "img:")
- !$formatted = "<$" + $sprite + ">"
- !else
- !$formatted = "<" + $sprite + ">"
- !endif
- !return $formatted
-!endfunction
-
-!function $tagLegendEntry($tagStereo, $bgColor, $fontColor, $borderColor,
$shadowing, $shape, $legendText, $legendSprite)
- !$bg = $bgColor
- !$fo = $fontColor
- !$bo = $borderColor
-
- !if ($fo == "")
- !if ($bg != "")
-!if ($PlantUMLSupportsDynamicLegendColor)
- !$fo = $contrastLegend($bg)
-!else
- !$fo = $LEGEND_DARK_COLOR
-!endif
- !else
- !if ($bo == "")
- !$fo = $LEGEND_DARK_COLOR
- !$bg = $LEGEND_LIGHT_COLOR
- !else
-!if ($PlantUMLSupportsDynamicLegendColor)
- !$fo = $flatLegend($bo)
- !$bg = $contrastLegend($bo)
-!else
- !$fo = $LEGEND_DARK_COLOR
- !$bg = $LEGEND_LIGHT_COLOR
-!endif
- !endif
- !endif
- !else
- !if ($bg == "")
-!if ($PlantUMLSupportsDynamicLegendColor)
- !$bg = $contrastLegend($fo)
-!else
- !$bg = $LEGEND_LIGHT_COLOR
-!endif
- !endif
- !endif
-
- !if ($bo == "")
- !$bo = $bg
- !endif
-
- !$tagEntry = "|"
- !$tagEntry = $tagEntry + "<" + $colorWithHash($bg) +">"
- ' <U+25AF> ..white rectangle
- !$tagEntry = $tagEntry + "<color:"+$bo+"> <U+25AF></color> "
- !$tagEntry = $tagEntry + "<color:"+$fo+">"
- !if ($legendSprite != "")
- !$tagEntry = $tagEntry + $getSprite($legendSprite) + " "
- !endif
- !if ($legendText == "")
- !$tagEntry = $tagEntry + " " + $tagStereo + " "
- !if ($shadowing == "true")
- !$tagEntry = $tagEntry + $LEGEND_SHADOW_TEXT
- !endif
- !if ($shadowing == "false")
- !$tagEntry = $tagEntry + $LEGEND_NO_SHADOW_TEXT
- !endif
- !if ($shape == $ROUNDED_BOX)
- !$tagEntry = $tagEntry + $LEGEND_ROUNDED_BOX
- !endif
- !if ($shape == $EIGHT_SIDED)
- !$tagEntry = $tagEntry + $LEGEND_EIGHT_SIDED
- !endif
- !if ($fontColor == "" && $bgColor == "")
- !$tagEntry = $tagEntry + $LEGEND_NO_FONT_BG_TEXT
- !else
- !if ($fontColor == "")
- !$tagEntry = $tagEntry + $LEGEND_NO_FONT_TEXT
- !endif
- !if ($bgColor == "")
- !$tagEntry = $tagEntry + $LEGEND_NO_BG_TEXT
- !endif
- !endif
- !else
- !$tagEntry = $tagEntry + " " + $legendText + " "
- !endif
-
- !$tagEntry = $tagEntry + "</color> "
- !$tagEntry = $tagEntry + "|"
- !return $tagEntry
-!endfunction
-
-!function $tagRelLegendEntry($tagStereo, $textColor, $lineColor, $lineStyle,
$legendText, $legendSprite)
- !$tc = $textColor
- !$lc = $lineColor
-
- !if ($tc == "")
- !if ($PlantUMLSupportsDynamicLegendColor)
- !$tc = $flatLegend($ARROW_COLOR)
- !else
- !$tc = $LEGEND_DARK_COLOR
- !endif
- !endif
- !if ($lc == "")
- !if ($PlantUMLSupportsDynamicLegendColor)
- !$lc = $flatLegend($ARROW_COLOR)
- !else
- !$lc = $LEGEND_DARK_COLOR
- !endif
- !endif
-
- !$tagEntry = "|"
- ' <U+2500> ..white line
- !$tagEntry = $tagEntry + "<color:"+$lc+"> <U+2500></color> "
- !$tagEntry = $tagEntry + "<color:"+$tc+">"
- !if ($legendSprite != "")
- !$tagEntry = $tagEntry + $getSprite($legendSprite) + " "
- !endif
- !if ($legendText == "")
- !$tagEntry = $tagEntry + " " + $tagStereo + " "
- !if ($textColor == "")
- !$tagEntry = $tagEntry + $LEGEND_NO_FONT_TEXT
- !endif
- !if ($lineColor == "")
- !$tagEntry = $tagEntry + $LEGEND_NO_LINE_TEXT
- !endif
- !if ($lineStyle != "")
- !if ($lineStyle == $DOTTED_LINE)
- !$tagEntry = $tagEntry + $LEGEND_DOTTED_LINE
- !elseif ($lineStyle == $DASHED_LINE)
- !$tagEntry = $tagEntry + $LEGEND_DASHED_LINE
- !elseif ($lineStyle == $BOLD_LINE)
- !$tagEntry = $tagEntry + $LEGEND_BOLD_LINE
- !else
- !$tagEntry = $tagEntry + "(" + $lineStyle + ") "
- !endif
- !endif
- !else
- !$tagEntry = $tagEntry + " " + $legendText + " "
- !endif
-
- !$tagEntry = $tagEntry + "</color> "
- !$tagEntry = $tagEntry + "|"
- !return $tagEntry
-!endfunction
-
-!global $LEGEND_DOTTED_LINE = "(dotted) "
-!global $LEGEND_DASHED_LINE = "(dashed) "
-!global $LEGEND_BOLD_LINE = "(bold) "
-
-!unquoted procedure $addTagToLegend($tagStereo, $bgColor="", $fontColor="",
$borderColor="", $shadowing="", $shape="", $legendText="", $legendSprite="")
-'' if a combined element tag is defined (e.g. "v1.0&v1.1") then it is
typically a merged color,
-'' like a new $fontColor="#fdae61" therefore it should be added to the legend
-'' and the & combined tags will be not removed
-' !if (%strpos($tagStereo, "&") < 0)
- !$tagEntry = $tagLegendEntry($tagStereo, $bgColor, $fontColor, $borderColor,
$shadowing, $shape, $legendText, $legendSprite)
-%set_variable_value("$" + $tagStereo + "LegendEntry", $tagEntry)
- !$tagCustomLegend = $tagCustomLegend + $tagStereo + "\n"
- !$tagMask = $tagLegendMask( $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite)
-%set_variable_value("$" + $tagStereo + "LegendMask", $tagMask)
-' !endif
-!endprocedure
-
-!unquoted procedure $addRelTagToLegend($tagStereo, $textColor="",
$lineColor="", $lineStyle="", $legendText="", $legendSprite="")
-'' Arrows have a bug with stereotype/skinparams and cannot combine text colors
of one stereotype
-'' and the line color of another stereotype. Therefore the text color of one
tag and the line color
-'' of another tag have to be combined via a "workaround" tag ("v1.0&v1.1").
-'' This workaround tag could be theoretically removed in the legend but after
that there would
-'' be an inconsistency between the element tags and the rel tags and therefore
-'' & combined workaround tags are not removed too (and in unlikely cases the
color itself could be changed)
-' !if (%strpos($tagStereo, "&") < 0)
- !$tagEntry = $tagRelLegendEntry($tagStereo, $textColor, $lineColor,
$lineStyle, $legendText, $legendSprite)
-%set_variable_value("$" + $tagStereo + "_LineLegendEntry", $tagEntry)
- !$tagCustomLegend = $tagCustomLegend + $tagStereo + "_Line\n"
-' !endif
-!endprocedure
-
-!procedure $showActiveLegendEntries($allDefined)
- !$brPos = %strpos($allDefined, "\n")
- !while ($brPos >= 0)
- !$tagStereo = %substr($allDefined, 0, $brPos)
- !$allDefined = %substr($allDefined, $brPos+2)
- !$brPos = %strpos($allDefined, "\n")
- !if (%variable_exists("$" + $tagStereo + "Legend"))
-%get_variable_value("$" + $tagStereo + "LegendEntry")
- !endif
- !endwhile
- !if (%strlen($allDefined) > 0)
- !$tagStereo = $allDefined
- !if (%variable_exists("$" + $tagStereo + "Legend"))
-%get_variable_value("$" + $tagStereo + "LegendEntry")
- !endif
- !endif
-!endprocedure
-
-!function RoundedBoxShape()
-!return $ROUNDED_BOX
-!endfunction
-
-!function EightSidedShape()
-!return $EIGHT_SIDED
-!endfunction
-
-!function DottedLine()
-!return $DOTTED_LINE
-!endfunction
-
-!function DashedLine()
-!return $DASHED_LINE
-!endfunction
-
-!function BoldLine()
-!return $BOLD_LINE
-!endfunction
-
-' used by new defined tags
-!unquoted procedure AddElementTag($tagStereo, $bgColor="", $fontColor="",
$borderColor="", $shadowing="", $shape="", $sprite="", $techn="",
$legendText="", $legendSprite="")
-$defineSkinparams($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape)
- !if ($sprite!="")
-%set_variable_value("$" + $tagStereo + "ElementTagSprite", $sprite)
- !if ($legendSprite == "")
- !$legendSprite = $smallVersionSprite($sprite)
- !endif
- !endif
- !if ($techn != "")
-%set_variable_value("$" + $tagStereo + "ElementTagTechn", $techn)
- !endif
-$addTagToLegend($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $legendText, $legendSprite)
-!endprocedure
-
-' used by new defined rel tags
-!unquoted procedure AddRelTag($tagStereo, $textColor="", $lineColor="",
$lineStyle = "", $sprite="", $techn="", $legendText="", $legendSprite="")
-$defineRelSkinparams($tagStereo, $textColor, $lineColor, $lineStyle)
- !if ($sprite != "")
-%set_variable_value("$" + $tagStereo + "RelTagSprite", $sprite)
- !if ($legendSprite == "")
- ' relation symbols typically 1:1 no additional scale required
- !$legendSprite = $sprite
- !endif
- !endif
- !if ($techn != "")
-%set_variable_value("$" + $tagStereo + "RelTagTechn", $techn)
- !endif
-$addRelTagToLegend($tagStereo, $textColor, $lineColor, $lineStyle,
$legendText, $legendSprite)
-!endprocedure
-
-' update the style of existing elements like person, ...
-!unquoted procedure UpdateElementStyle($elementName, $bgColor="",
$fontColor="", $borderColor="", $shadowing="", $shape="", $sprite="",
$techn="", $legendText="", $legendSprite="")
-$defineSkinparams($elementName, $bgColor, $fontColor, $borderColor,
$shadowing, $shape)
- !if ($sprite != "")
-%set_variable_value("$" + $elementName + "ElementTagSprite", $sprite)
- !if ($legendSprite == "")
- !$legendSprite = $smallVersionSprite($sprite)
- !endif
- !endif
- !if ($techn != "")
-%set_variable_value("$" + $elementName + "ElementTagTechn", $techn)
- !endif
- !$tagEntry = $tagLegendEntry($elementName, $bgColor, $fontColor,
$borderColor, $shadowing, $shape, $legendText, $legendSprite)
-%set_variable_value("$" + $elementName + "LegendEntry", $tagEntry)
- ' default tags sets at least bgColor and fontColor
- !$tagMask = $tagLegendMask("CHANGED", "CHANGED", $borderColor, $shadowing,
$shape, $sprite)
-%set_variable_value("$" + $elementName + "LegendMask", $tagMask)
-!endprocedure
-
-/' @deprecated in favor of UpdateElementStyle '/
-!unquoted procedure UpdateSkinparamsAndLegendEntry($elementName, $bgColor="",
$fontColor="", $borderColor="", $shadowing="")
-UpdateElementStyle($elementName, $bgColor, $fontColor, $borderColor,
$shadowing)
-!endprocedure
-
-' update the style of default relation, it has to set both properties
(combined statement not working)
-!unquoted procedure UpdateRelStyle($textColor, $lineColor)
- !$elementSkin = "skinparam arrow {" + %newline()
- !$elementSkin = $elementSkin + " Color " + $lineColor + %newline()
- !$elementSkin = $elementSkin + " FontColor " + $textColor + %newline()
- !$elementSkin = $elementSkin + "}" + %newline()
-$elementSkin
-!endprocedure
-
-' tags/stereotypes have to be delimited with \n
-!unquoted procedure SetDefaultLegendEntries($tagStereoEntries)
- !$tagDefaultLegend = $tagStereoEntries
-!endprocedure
-
-' Links
-' ##################################
-
-!function $getLink($link)
- !if ($link != "")
- !return "[[" + $link + "]]"
- !else
- !return ""
- !endif
-!endfunction
-
-' Line breaks
-' ##################################
-
-' PlantUML supports no DETERMINISTIC/automatic line breaks of "PlantUML line"
(C4 Relashionships)
-' therefore Rel...() implements an automatic line break based on spaces (like
in all other objects).
-' If a $type contains \n then these are used (and no automatic space based
line breaks are done)
-' $REL_TECHN_MAX_CHAR_WIDTH defines the automatic line break position
-!global $REL_TECHN_MAX_CHAR_WIDTH = 35
-!global $REL_DESCR_MAX_CHAR_WIDTH = 32
-
-!unquoted function $breakDescr($descr, $widthStr)
-!$width = %intval($widthStr)
-!$multiLine = ""
-!if (%strpos($descr, "\n") >= 0)
-!else
- !while (%strlen($descr) > $width)
- !$brPos = $width
- !while ($brPos > 0 && %substr($descr, $brPos, 1) != ' ')
- !$brPos = $brPos - 1
- !endwhile
-
- !if ($brPos < 1)
- !$brPos = %strpos($descr, " ")
- !else
- !endif
-
- !if ($brPos > 0)
- !$multiLine = $multiLine + %substr($descr, 0, $brPos) + "\n"
- !$descr = %substr($descr, $brPos + 1)
- !else
- !$multiLine = $multiLine+ $descr
- !$descr = ""
- !endif
- !endwhile
-!endif
-!if (%strlen($descr) > 0)
- !$multiLine = $multiLine + $descr
-!endif
-!return $multiLine
-!endfunction
-
-' $breakTechn() supports //...//; $breakNode() in C4_Deployment supports no
//....//
-!unquoted function $breakTechn($techn, $widthStr)
-!$width = %intval($widthStr)
-!$multiLine = ""
-!if (%strpos($techn, "\n") >= 0)
- !while (%strpos($techn, "\n") >= 0)
- !$brPos = %strpos($techn, "\n")
- !$multiLine = $multiLine + %substr($techn, 0, $brPos) +
'</size>//\n//<size:'+$TECHN_FONT_SIZE+'>'
- !$techn = %substr($techn, $brPos+2)
- !endwhile
-!else
- !while (%strlen($techn) > $width)
- !$brPos = $width
- !while ($brPos > 0 && %substr($techn, $brPos, 1) != ' ')
- !$brPos = $brPos - 1
- !endwhile
-
- !if ($brPos < 1)
- !$brPos = %strpos($techn, " ")
- !else
- !endif
-
- !if ($brPos > 0)
- !$multiLine = $multiLine + %substr($techn, 0, $brPos) +
'</size>//\n//<size:'+$TECHN_FONT_SIZE+'>'
- !$techn = %substr($techn, $brPos + 1)
- !else
- !$multiLine = $multiLine+ $techn
- !$techn = ""
- !endif
- !endwhile
-!endif
-!if (%strlen($techn) > 0)
- !$multiLine = $multiLine + $techn
-!endif
-!return $multiLine
-!endfunction
-
-' Element properties
-' ##################################
-
-' collect all defined properties as table rows
-!global $propTable = ""
-!global $propTableCaption = ""
-!global $propColCaption = "="
-
-!unquoted function SetPropertyHeader($col1Name, $col2Name, $col3Name = "",
$col4Name = "")
- !$propColCaption = ""
- !$propTableCaption = "|= " + $col1Name + " |= " + $col2Name + " |"
- !if ($col3Name != "")
- !$propTableCaption = $propTableCaption + "= " + $col3Name + " |"
- !endif
- !if ($col4Name != "")
- !$propTableCaption = $propTableCaption + "= " + $col4Name + " |"
- !endif
- !return ""
-!endfunction
-
-!unquoted function WithoutPropertyHeader()
- !$propTableCaption = ""
- !$propColCaption = "="
- !return ""
-!endfunction
-
-!unquoted function AddProperty($col1, $col2, $col3 = "", $col4 = "")
- !if ($propTable == "")
- !if ($propTableCaption != "")
- !$propTable = $propTableCaption + "\n"
- !endif
- !else
- !$propTable = $propTable + "\n"
- !endif
- !$propTable = $propTable + "| " + $col1 + " |" + $propColCaption + " " +
$col2 + " |"
- !if ($col3 != "")
- !$propTable = $propTable + " " + $col3 + " |"
- !endif
- !if ($col4 != "")
- !$propTable = $propTable + " " + $col4 + " |"
- !endif
- !return ""
-!endfunction
-
-!unquoted function $getProps($alignedNL = "\n")
- !if ($propTable != "")
- !$retTable = $alignedNL + $propTable
- !$propTable = ""
- !return $retTable
- !endif
- !return ""
-!endfunction
-
-!unquoted function $getProps_L()
- !return $getProps("\l")
-!endfunction
-
-!unquoted function $getProps_R()
- !return $getProps("\r")
-!endfunction
-
-SetPropertyHeader("Property","Value")
-
-' Layout
-' ##################################
-
-!procedure $getHideStereotype($hideStereotype)
-!if ($hideStereotype == "true")
-hide stereotype
-!endif
-!endprocedure
-
-!procedure $getLegendTable()
-<#00000000,#00000000>|<color:$LEGEND_TITLE_COLOR>**Legend**</color> |
-$showActiveLegendEntries($tagDefaultLegend)
-$showActiveLegendEntries($tagCustomLegend)
-!endprocedure
-
-!procedure $getLegendArea($areaAlias, $hideStereotype)
-$getHideStereotype($hideStereotype)
-rectangle $areaAlias<<legendArea>> [
-$getLegendTable()
-]
-!endprocedure
-
-!procedure HIDE_STEREOTYPE()
-hide stereotype
-!endprocedure
-
-!unquoted procedure SET_SKETCH_STYLE($bgColor="_dont_change_",
$fontColor="_dont_change_", $warningColor="_dont_change_",
$fontName="_dont_change_", $footerWarning="_dont_change_",
$footerText="_dont_change_")
-!if $bgColor != "_dont_change_"
- !global $SKETCH_BG_COLOR = $bgColor
-!endif
-!if $fontColor != "_dont_change_"
- !global $SKETCH_FONT_COLOR = $fontColor
-!endif
-!if $warningColor != "_dont_change_"
- !global $SKETCH_WARNING_COLOR = $warningColor
-!endif
-!if $fontName != "_dont_change_"
- !global $SKETCH_FONT_NAME = $fontName
-!endif
-!if $footerWarning != "_dont_change_"
- !global $SKETCH_FOOTER_WARNING = $footerWarning
-!endif
-!if $footerText != "_dont_change_"
- !global $SKETCH_FOOTER_TEXT = $footerText
-!endif
-!endprocedure
-
-!procedure LAYOUT_AS_SKETCH()
- skinparam handwritten true
-!if $SKETCH_BG_COLOR > ""
- skinparam backgroundColor $SKETCH_BG_COLOR
-!endif
-!if $SKETCH_FONT_COLOR > ""
- skinparam footer {
- FontColor $SKETCH_FONT_COLOR
- }
- !if $ARROW_COLOR == "#666666"
- !global $ARROW_COLOR = $SKETCH_FONT_COLOR
- skinparam arrow {
- Color $ARROW_COLOR
- FontColor $ARROW_COLOR
- }
- !endif
- !if $BOUNDARY_COLOR == "#444444"
- !global $BOUNDARY_COLOR = $SKETCH_FONT_COLOR
- skinparam rectangle<<boundary>> {
- FontColor $BOUNDARY_COLOR
- BorderColor $BOUNDARY_COLOR
- }
- !endif
-!endif
-!if $SKETCH_FONT_NAMES > ""
- skinparam defaultFontName $SKETCH_FONT_NAME
-!endif
-!if $SKETCH_FOOTER_WARNING > "" || $SKETCH_FOOTER_TEXT > ""
- !$line = "footer <font color=" + $SKETCH_WARNING_COLOR + ">"+
$SKETCH_FOOTER_WARNING + "</font> " + $SKETCH_FOOTER_TEXT
- $line
-!endif
-!endprocedure
-
-!global $fix_direction=%false()
-
-!function $down($start,$end)
-!if ($fix_direction)
-!return $start+"RIGHT"+$end
-!else
-!return $start+"DOWN"+$end
-!endif
-!endfunction
-
-!function $up($start,$end)
-!if ($fix_direction)
-!return $start+"LEFT"+$end
-!else
-!return $start+"UP"+$end
-!endif
-!endfunction
-
-!function $left($start,$end)
-!if ($fix_direction)
-!return $start+"UP"+$end
-!else
-!return $start+"LEFT"+$end
-!endif
-!endfunction
-
-!function $right($start,$end)
-!if ($fix_direction)
-!return $start+"DOWN"+$end
-!else
-!return $start+"RIGHT"+$end
-!endif
-!endfunction
-
-!procedure LAYOUT_TOP_DOWN()
-!global $fix_direction=%false()
-top to bottom direction
-!endprocedure
-
-!procedure LAYOUT_LEFT_RIGHT()
-!global $fix_direction = %false()
-left to right direction
-!endprocedure
-
-!procedure LAYOUT_LANDSCAPE()
-!global $fix_direction = %true()
-left to right direction
-!endprocedure
-
-' has to be last call in diagram
-!unquoted procedure SHOW_LEGEND($hideStereotype="true")
-$getHideStereotype($hideStereotype)
-legend right
-$getLegendTable()
-endlegend
-!endprocedure
-
-/' @deprecated in favor of SHOW_LEGEND '/
-!unquoted procedure SHOW_DYNAMIC_LEGEND($hideStereotype="true")
-SHOW_LEGEND($hideStereotype)
-!endprocedure
-
-' legend is reserved and cannot be uses as alias of SHOW_FLOATING_LEGEND()
therefore
-' LEGEND() is introduced. It returns the default name of the floating alias
"floating_legend_alias"
-' and can be used in the Lay_Distance() calls
-!function LEGEND()
-!return "floating_legend_alias"
-!endfunction
-
-' enables that legend can be located in drawing area of the diagram. It has to
be last call in diagram followed by Lay_Distance()
-!unquoted procedure SHOW_FLOATING_LEGEND($alias=LEGEND(),
$hideStereotype="true")
-$getLegendArea($alias, $hideStereotype)
-!endprocedure
-
-' Boundaries
-' ##################################
-
-!function $getBoundary($label, $type)
- !if ($type == "")
- !return '==' + $label
- !endif
- !if (type != "")
- !return '==' + $label + '\n<size:' + $TECHN_FONT_SIZE + '>[' + $type +
']</size>'
- !endif
-!endfunction
-
-!unquoted procedure Boundary($alias, $label, $type="", $tags="", $link="")
-rectangle "$getBoundary($label, $type)" $toStereos("boundary", $tags) as
$alias $getLink($link)
-!endprocedure
-
-' Relationship
-' ##################################
-
-!function $getRel($direction, $alias1, $alias2, $label, $techn, $descr,
$sprite, $tags, $link)
- !$sprite = $toRelArg($sprite, $tags, "RelTagSprite")
- !$techn = $toRelArg($techn, $tags, "RelTagTechn")
- !$rel = $alias1 + ' ' + $direction + ' ' + $alias2
- !if ($tags != "")
- !$rel = $rel + ' ' + $toStereos($tags)
- !endif
- !$rel = $rel + ' : '
- !if ($sprite != "")
- !$rel = $rel + $getSprite($sprite) + ' '
- !endif
- !if ($link != "")
- !$rel = $rel + '**[[' + $link + ' ' + $label + ']]**'
- !else
- !$rel = $rel + '**' + $label + '**'
- !endif
- !if ($techn != "")
- ' line break is not deterministic, calculate it
- !$rel = $rel + '\n//<size:' + $TECHN_FONT_SIZE + '>[' +
$breakTechn($techn, $REL_TECHN_MAX_CHAR_WIDTH) + ']</size>//'
- !endif
- !if ($descr != "")
- ' line break is not deterministic, calculate it
- !$rel = $rel + '\n\n' + $breakDescr($descr, $REL_DESCR_MAX_CHAR_WIDTH)
- !endif
- !$prop = $getProps()
- !if ($prop != "")
- ' reuse table
- !$rel = $rel + $prop
- !endif
- !return $rel
-!endfunction
-
-!unquoted procedure Rel_($alias1, $alias2, $label, $direction)
-$alias1 $direction $alias2 : **$label**
-!endprocedure
-!unquoted procedure Rel_($alias1, $alias2, $label, $techn, $direction)
-$alias1 $direction $alias2 :
**$label**\n//<size:$TECHN_FONT_SIZE>[$techn]</size>//
-!endprocedure
-
-!unquoted procedure Rel($from, $to, $label, $techn="", $descr="", $sprite="",
$tags="", $link="")
-$getRel("-->>", $from, $to, $label, $techn, $descr, $sprite, $tags, $link)
-!endprocedure
-
-!unquoted procedure BiRel($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel("<<-->>", $from, $to, $label, $techn, $descr, $sprite, $tags, $link)
-!endprocedure
-
-!unquoted procedure Rel_Back($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel("<<--", $from, $to, $label, $techn, $descr, $sprite, $tags, $link)
-!endprocedure
-
-!unquoted procedure Rel_Neighbor($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel("->>", $from, $to, $label, $techn, $descr, $sprite, $tags, $link)
-!endprocedure
-
-!unquoted procedure BiRel_Neighbor($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel("<<->>", $from, $to, $label, $techn, $descr, $sprite, $tags, $link)
-!endprocedure
-
-!unquoted procedure Rel_Back_Neighbor($from, $to, $label, $techn="",
$descr="", $sprite="", $tags="", $link="")
-$getRel("<<-", $from, $to, $label, $techn, $descr, $sprite, $tags, $link)
-!endprocedure
-
-!unquoted procedure Rel_D($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($down("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-!unquoted procedure Rel_Down($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($down("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-
-!unquoted procedure BiRel_D($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($down("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite,
$tags, $link)
-!endprocedure
-!unquoted procedure BiRel_Down($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($down("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite,
$tags, $link)
-!endprocedure
-
-!unquoted procedure Rel_U($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($up("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-!unquoted procedure Rel_Up($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($up("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-
-!unquoted procedure BiRel_U($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($up("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-!unquoted procedure BiRel_Up($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($up("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-
-!unquoted procedure Rel_L($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($left("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-!unquoted procedure Rel_Left($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($left("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-
-!unquoted procedure BiRel_L($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($left("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite,
$tags, $link)
-!endprocedure
-!unquoted procedure BiRel_Left($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($left("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite,
$tags, $link)
-!endprocedure
-
-!unquoted procedure Rel_R($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($right("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-!unquoted procedure Rel_Right($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($right("-","->>"), $from, $to, $label, $techn, $descr, $sprite, $tags,
$link)
-!endprocedure
-
-!unquoted procedure BiRel_R($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($right("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite,
$tags, $link)
-!endprocedure
-!unquoted procedure BiRel_Right($from, $to, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-$getRel($right("<<-","->>"), $from, $to, $label, $techn, $descr, $sprite,
$tags, $link)
-!endprocedure
-
-' Layout Helpers
-' ##################################
-
-!function $getHiddenLine($distance)
- !return '-[hidden]' + %substr('------------', 0, %intval($distance) + 1)
-!endfunction
-
-!unquoted procedure Lay_D($from, $to)
-$from -[hidden]D- $to
-!endprocedure
-!unquoted procedure Lay_Down($from, $to)
-$from -[hidden]D- $to
-!endprocedure
-
-!unquoted procedure Lay_U($from, $to)
-$from -[hidden]U- $to
-!endprocedure
-!unquoted procedure Lay_Up($from, $to)
-$from -[hidden]U- $to
-!endprocedure
-
-!unquoted procedure Lay_R($from, $to)
-$from -[hidden]R- $to
-!endprocedure
-!unquoted procedure Lay_Right($from, $to)
-$from -[hidden]R- $to
-!endprocedure
-
-!unquoted procedure Lay_L($from, $to)
-$from -[hidden]L- $to
-!endprocedure
-!unquoted procedure Lay_Left($from, $to)
-$from -[hidden]L- $to
-!endprocedure
-
-' PlantUML bug: lines which does "not match" with the orientation/direction of
the diagram
-' uses the same length therefore the method offers no direction at all.
-' If a direction is required the Lay_...() methods can be used
-!unquoted procedure Lay_Distance($from, $to, $distance="0")
-$from $getHiddenLine($distance) $to
-!endprocedure
diff --git
a/antora/components/docs/modules/resources/partials/C4_Container.puml
b/antora/components/docs/modules/resources/partials/C4_Container.puml
deleted file mode 100644
index 3126fac943..0000000000
--- a/antora/components/docs/modules/resources/partials/C4_Container.puml
+++ /dev/null
@@ -1,111 +0,0 @@
-' convert it with additional command line argument -DRELATIVE_INCLUDE="." to
use locally
-' !if %variable_exists("RELATIVE_INCLUDE")
-' !include %get_variable_value("RELATIVE_INCLUDE")/C4_Context.puml
-' !else
-' !include
https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
-' !endif
-
-' Scope: A single software system.
-' Primary elements: Containers within the software system in scope.
-' Supporting elements: People and software systems directly connected to the
containers.
-' Intended audience: Technical people inside and outside of the software
development team; including software architects, developers and
operations/support staff.
-
-' Colors
-' ##################################
-
-!global $CONTAINER_BG_COLOR = "#438DD5"
-!global $CONTAINER_BORDER_COLOR = "#3C7FC0"
-!global $EXTERNAL_CONTAINER_BG_COLOR = "#B3B3B3"
-!global $EXTERNAL_CONTAINER_BORDER_COLOR = "#A6A6A6"
-
-' Styling
-' ##################################
-UpdateElementStyle("container", $CONTAINER_BG_COLOR, $ELEMENT_FONT_COLOR,
$CONTAINER_BORDER_COLOR)
-UpdateElementStyle("external_container", $EXTERNAL_CONTAINER_BG_COLOR,
$ELEMENT_FONT_COLOR, $EXTERNAL_CONTAINER_BORDER_COLOR)
-
-' shortcuts with default colors
-!unquoted procedure AddContainerTag($tagStereo, $bgColor=$CONTAINER_BG_COLOR,
$fontColor=$ELEMENT_FONT_COLOR, $borderColor=$CONTAINER_BORDER_COLOR,
$shadowing="", $shape="", $sprite="", $techn="", $legendText="",
$legendSprite="")
- AddElementTag($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite, $techn, $legendText, $legendSprite)
-!endprocedure
-!unquoted procedure AddExternalContainerTag($tagStereo,
$bgColor=$EXTERNAL_CONTAINER_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR,
$borderColor=$EXTERNAL_CONTAINER_BORDER_COLOR, $shadowing="", $shape="",
$sprite="", $techn="", $legendText="", $legendSprite="")
- AddElementTag($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite, $techn, $legendText, $legendSprite)
-!endprocedure
-
-' Layout
-' ##################################
-
-SetDefaultLegendEntries("person\nsystem\ncontainer\nexternal_person\nexternal_system\nexternal_container")
-
-!procedure LAYOUT_WITH_LEGEND()
-hide stereotype
-legend right
-|<color:$LEGEND_TITLE_COLOR>**Legend**</color> |
-|<$PERSON_BG_COLOR> person |
-|<$SYSTEM_BG_COLOR> system |
-|<$CONTAINER_BG_COLOR> container |
-|<$EXTERNAL_PERSON_BG_COLOR> external person |
-|<$EXTERNAL_SYSTEM_BG_COLOR> external system |
-|<$EXTERNAL_CONTAINER_BG_COLOR> external container |
-endlegend
-!endprocedure
-
-' Elements
-' ##################################
-
-!function $getContainer($label, $techn, $descr, $sprite)
- !$container = ""
- !if ($sprite != "")
- !$container = $container + $getSprite($sprite) + '\n'
- !endif
- !$container = $container + '==' + $label
- !if ($techn != "")
- !$container = $container + '\n//<size:' + $TECHN_FONT_SIZE + '>[' + $techn
+ ']</size>//'
- !endif
- !if ($descr != "")
- !$container = $container + '\n\n' + $descr
- !endif
- !return $container
-!endfunction
-
-!unquoted procedure Container($alias, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "container")
-!$techn=$toElementArg($techn, $tags, "ElementTagTechn", "container")
-rectangle "$getContainer($label, $techn, $descr, $sprite)$getProps()"
$toStereos("container", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure ContainerDb($alias, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "container")
-!$techn=$toElementArg($techn, $tags, "ElementTagTechn", "container")
-database "$getContainer($label, $techn, $descr, $sprite)$getProps()"
$toStereos("container", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure ContainerQueue($alias, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "container")
-!$techn=$toElementArg($techn, $tags, "ElementTagTechn", "container")
-queue "$getContainer($label, $techn, $descr, $sprite)$getProps()"
$toStereos("container", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure Container_Ext($alias, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite",
"external_container")
-!$techn=$toElementArg($techn, $tags, "ElementTagTechn", "external_container")
-rectangle "$getContainer($label, $techn, $descr, $sprite)$getProps()"
$toStereos("external_container", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure ContainerDb_Ext($alias, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite",
"external_container")
-!$techn=$toElementArg($techn, $tags, "ElementTagTechn", "external_container")
-database "$getContainer($label, $techn, $descr, $sprite)$getProps()"
$toStereos("external_container", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure ContainerQueue_Ext($alias, $label, $techn="", $descr="",
$sprite="", $tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite",
"external_container")
-!$techn=$toElementArg($techn, $tags, "ElementTagTechn", "external_container")
-queue "$getContainer($label, $techn, $descr, $sprite)$getProps()"
$toStereos("external_container", $tags) as $alias $getLink($link)
-!endprocedure
-
-' Boundaries
-' ##################################
-
-!unquoted procedure Container_Boundary($alias, $label, $tags="", $link="")
-Boundary($alias, $label, "Container", $tags, $link)
-!endprocedure
diff --git a/antora/components/docs/modules/resources/partials/C4_Context.puml
b/antora/components/docs/modules/resources/partials/C4_Context.puml
deleted file mode 100644
index 5d3513d3c2..0000000000
--- a/antora/components/docs/modules/resources/partials/C4_Context.puml
+++ /dev/null
@@ -1,292 +0,0 @@
-' convert it with additional command line argument -DRELATIVE_INCLUDE="." to
use locally
-' !if %variable_exists("RELATIVE_INCLUDE")
-' !include %get_variable_value("RELATIVE_INCLUDE")/C4.puml
-' !else
-' !include
https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4.puml
-' !endif
-
-' Scope: A single software system.
-' Primary elements: The software system in scope.
-' Supporting elements: People and software systems directly connected to the
software system in scope.
-' Intended audience: Everybody, both technical and non-technical people,
inside and outside of the software development team.
-
-' Colors
-' ##################################
-
-!global $PERSON_BG_COLOR = "#08427B"
-!global $PERSON_BORDER_COLOR = "#073B6F"
-!global $EXTERNAL_PERSON_BG_COLOR = "#686868"
-!global $EXTERNAL_PERSON_BORDER_COLOR = "#8A8A8A"
-!global $SYSTEM_BG_COLOR = "#1168BD"
-!global $SYSTEM_BORDER_COLOR = "#3C7FC0"
-!global $EXTERNAL_SYSTEM_BG_COLOR = "#999999"
-!global $EXTERNAL_SYSTEM_BORDER_COLOR = "#8A8A8A"
-
-' Styling
-' ##################################
-
-UpdateElementStyle("person", $PERSON_BG_COLOR, $ELEMENT_FONT_COLOR,
$PERSON_BORDER_COLOR)
-UpdateElementStyle("external_person", $EXTERNAL_PERSON_BG_COLOR,
$ELEMENT_FONT_COLOR, $EXTERNAL_PERSON_BORDER_COLOR)
-UpdateElementStyle("system", $SYSTEM_BG_COLOR, $ELEMENT_FONT_COLOR,
$SYSTEM_BORDER_COLOR)
-UpdateElementStyle("external_system", $EXTERNAL_SYSTEM_BG_COLOR,
$ELEMENT_FONT_COLOR, $EXTERNAL_SYSTEM_BORDER_COLOR)
-
-' shortcuts with default colors
-!unquoted procedure AddPersonTag($tagStereo, $bgColor=$PERSON_BG_COLOR,
$fontColor=$ELEMENT_FONT_COLOR, $borderColor=$PERSON_BORDER_COLOR,
$shadowing="", $shape="", $sprite="", $legendText="", $legendSprite="")
- AddElementTag($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite, "", $legendText, $legendSprite)
-!endprocedure
-!unquoted procedure AddExternalPersonTag($tagStereo,
$bgColor=$EXTERNAL_PERSON_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR,
$borderColor=$EXTERNAL_PERSON_BORDER_COLOR, $shadowing="", $shape="",
$sprite="", $legendText="", $legendSprite="")
- AddElementTag($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite, "", $legendText, $legendSprite)
-!endprocedure
-!unquoted procedure AddSystemTag($tagStereo, $bgColor=$SYSTEM_BG_COLOR,
$fontColor=$ELEMENT_FONT_COLOR, $borderColor=$SYSTEM_BORDER_COLOR,
$shadowing="", $shape="", $sprite="", $legendText="", $legendSprite="")
- AddElementTag($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite, "", $legendText, $legendSprite)
-!endprocedure
-!unquoted procedure AddExternalSystemTag($tagStereo,
$bgColor=$EXTERNAL_SYSTEM_BG_COLOR, $fontColor=$ELEMENT_FONT_COLOR,
$borderColor=$EXTERNAL_SYSTEM_BORDER_COLOR, $shadowing="", $shape="",
$sprite="", $legendText="", $legendSprite="")
- AddElementTag($tagStereo, $bgColor, $fontColor, $borderColor, $shadowing,
$shape, $sprite, "", $legendText, $legendSprite)
-!endprocedure
-
-' Sprites
-' ##################################
-
-sprite $person [48x48/16] {
-000000000000000000000000000000000000000000000000
-000000000000000000000000000000000000000000000000
-0000000000000000000049BCCA7200000000000000000000
-0000000000000000006EFFFFFFFFB3000000000000000000
-00000000000000001CFFFFFFFFFFFF700000000000000000
-0000000000000001EFFFFFFFFFFFFFF80000000000000000
-000000000000000CFFFFFFFFFFFFFFFF6000000000000000
-000000000000007FFFFFFFFFFFFFFFFFF100000000000000
-00000000000001FFFFFFFFFFFFFFFFFFF900000000000000
-00000000000006FFFFFFFFFFFFFFFFFFFF00000000000000
-0000000000000BFFFFFFFFFFFFFFFFFFFF40000000000000
-0000000000000EFFFFFFFFFFFFFFFFFFFF70000000000000
-0000000000000FFFFFFFFFFFFFFFFFFFFF80000000000000
-0000000000000FFFFFFFFFFFFFFFFFFFFF80000000000000
-0000000000000DFFFFFFFFFFFFFFFFFFFF60000000000000
-0000000000000AFFFFFFFFFFFFFFFFFFFF40000000000000
-00000000000006FFFFFFFFFFFFFFFFFFFE00000000000000
-00000000000000EFFFFFFFFFFFFFFFFFF800000000000000
-000000000000007FFFFFFFFFFFFFFFFFF100000000000000
-000000000000000BFFFFFFFFFFFFFFFF5000000000000000
-0000000000000001DFFFFFFFFFFFFFF70000000000000000
-00000000000000000BFFFFFFFFFFFF500000000000000000
-0000000000000000005DFFFFFFFFA1000000000000000000
-0000000000000000000037ABB96100000000000000000000
-000000000000000000000000000000000000000000000000
-000000000000000000000000000000000000000000000000
-000000000000025788300000000005886410000000000000
-000000000007DFFFFFFD9643347BFFFFFFFB400000000000
-0000000004EFFFFFFFFFFFFFFFFFFFFFFFFFFB1000000000
-000000007FFFFFFFFFFFFFFFFFFFFFFFFFFFFFD200000000
-00000006FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE10000000
-0000003FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB0000000
-000000BFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5000000
-000003FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD000000
-000009FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF200000
-00000DFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF600000
-00000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF800000
-00001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFA00000
-00001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB00000
-00001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB00000
-00001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB00000
-00001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFA00000
-00000EFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF700000
-000006FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE100000
-0000008FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD3000000
-000000014555555555555555555555555555555300000000
-000000000000000000000000000000000000000000000000
-000000000000000000000000000000000000000000000000
-}
-
-sprite $person2 [48x48/16] {
-0000000000000000000049BCCA7200000000000000000000
-0000000000000000006EFFFFFFFFB3000000000000000000
-00000000000000001CFFFFFFFFFFFF700000000000000000
-0000000000000001EFFFFFFFFFFFFFF80000000000000000
-000000000000000CFFFFFFFFFFFFFFFF6000000000000000
-000000000000007FFFFFFFFFFFFFFFFFF100000000000000
-00000000000001FFFFFFFFFFFFFFFFFFF900000000000000
-00000000000006FFFFFFFFFFFFFFFFFFFF00000000000000
-0000000000000BFFFFFFFFFFFFFFFFFFFF40000000000000
-0000000000000EFFFFFFFFFFFFFFFFFFFF70000000000000
-0000000000000FFFFFFFFFFFFFFFFFFFFF80000000000000
-0000000000000FFFFFFFFFFFFFFFFFFFFF80000000000000
-0000000000000DFFFFFFFFFFFFFFFFFFFF60000000000000
-0000000000000AFFFFFFFFFFFFFFFFFFFF40000000000000
-00000000000006FFFFFFFFFFFFFFFFFFFE00000000000000
-00000000000000EFFFFFFFFFFFFFFFFFF800000000000000
-000000000000007FFFFFFFFFFFFFFFFFF100000000000000
-000000000000000BFFFFFFFFFFFFFFFF5000000000000000
-0000000000000001DFFFFFFFFFFFFFF70000000000000000
-00000000000000000BFFFFFFFFFFFF500000000000000000
-0000000000000000005DFFFFFFFFA1000000000000000000
-0000000000000000000037ABB96100000000000000000000
-000000000002578888300000000005888864100000000000
-0000000007DFFFFFFFFD9643347BFFFFFFFFFB4000000000
-00000004EFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB10000000
-0000007FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD2000000
-000006FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE100000
-00003FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB00000
-0000BFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF50000
-0003FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD0000
-0009FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF2000
-000DFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF6000
-000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF8000
-001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB000
-001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB000
-001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFB000
-001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFA000
-000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF8000
-000DFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF6000
-0009FFFFFFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFFFFFF2000
-0003FFFFFFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFFFFFD0000
-0000BFFFFFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFFFFF50000
-00003FFFFFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFFFFB00000
-000006FFFFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFFFE100000
-0000007FFFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFFD2000000
-00000004EFFF8FFFFFFFFFFFFFFFFFFFFFF8FFFB10000000
-0000000007DF8FFFFFFFFFFFFFFFFFFFFFF8FB4000000000
-000000000002578888888888888888888864100000000000
-}
-
-' Layout
-' ##################################
-
-SetDefaultLegendEntries("person\nsystem\nexternal_person\nexternal_system")
-
-!procedure LAYOUT_WITH_LEGEND()
-hide stereotype
-legend right
-|<color:$LEGEND_TITLE_COLOR>**Legend**</color> |
-|<$PERSON_BG_COLOR> person |
-|<$SYSTEM_BG_COLOR> system|
-|<$EXTERNAL_PERSON_BG_COLOR> external person |
-|<$EXTERNAL_SYSTEM_BG_COLOR> external system |
-endlegend
-!endprocedure
-
-!global $defaultPersonSprite = "person"
-!global $portraitPerson = "false"
-
-!procedure HIDE_PERSON_SPRITE()
- !$defaultPersonSprite = ""
- !$portraitPerson = "false"
-!endprocedure
-
-!unquoted procedure SHOW_PERSON_SPRITE($sprite="")
- !if ($sprite == "")
- !$defaultPersonSprite = "person"
- !else
- !$defaultPersonSprite = $sprite
- !endif
- !$portraitPerson = "false"
-!endprocedure
-
-!unquoted procedure SHOW_PERSON_PORTRAIT()
- !$defaultPersonSprite = ""
- !$portraitPerson = "portrait"
-!endprocedure
-
-!unquoted procedure SHOW_PERSON_OUTLINE()
- !$defaultPersonSprite = ""
- !$portraitPerson = "outline"
-!endprocedure
-
-' Elements
-' ##################################
-
-!function $getPerson($label, $descr, $sprite)
-!if ($sprite == "") && ($defaultPersonSprite != "")
- !$sprite = $defaultPersonSprite
-!endif
-!if ($descr == "") && ($sprite == "")
- !return '=='+$label
-!endif
-!if ($descr == "") && ($sprite != "")
- !return $getSprite($sprite)+'\n=='+$label
-!endif
-!if ($descr != "") && ($sprite == "")
- !return '=='+$label+'\n\n '+$descr
-!endif
-!if ($descr != "") && ($sprite != "")
- !return $getSprite($sprite)+'\n=='+$label+'\n\n '+$descr
-!endif
-!endfunction
-
-!function $getSystem($label, $descr, $sprite)
-!if ($descr == "") && ($sprite == "")
-!return '=='+$label
-!endif
-!if ($descr == "") && ($sprite != "")
-!return $getSprite($sprite)+'\n=='+$label
-!endif
-!if ($descr != "") && ($sprite == "")
-!return '=='+$label+'\n\n '+$descr
-!endif
-!if ($descr != "") && ($sprite != "")
-!return $getSprite($sprite)+'\n=='+$label+'\n\n '+$descr
-!endif
-!endfunction
-
-!unquoted procedure Person($alias, $label, $descr="", $sprite="", $tags="",
$link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "person")
-!if ($portraitPerson == "portrait") && ($sprite == "")
-actor "$getPerson($label, $descr, $sprite)$getProps()" $toStereos("person",
$tags) as $alias $getLink($link)
-!elseif ($portraitPerson == "outline") && ($sprite == "")
-person "$getPerson($label, $descr, $sprite)$getProps()" $toStereos("person",
$tags) as $alias $getLink($link)
-!else
-rectangle "$getPerson($label, $descr, $sprite)$getProps()"
$toStereos("person", $tags) as $alias $getLink($link)
-!endif
-!endprocedure
-
-!unquoted procedure Person_Ext($alias, $label, $descr="", $sprite="",
$tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "external_person")
-!if ($portraitPerson == "portrait") && ($sprite == "")
-actor "$getPerson($label, $descr, $sprite)$getProps()"
$toStereos("external_person", $tags) as $alias $getLink($link)
-!elseif ($portraitPerson == "outline") && ($sprite == "")
-person "$getPerson($label, $descr, $sprite)$getProps()"
$toStereos("external_person", $tags) as $alias $getLink($link)
-!else
-rectangle "$getPerson($label, $descr, $sprite)$getProps()"
$toStereos("external_person", $tags) as $alias $getLink($link)
-!endif
-!endprocedure
-
-!unquoted procedure System($alias, $label, $descr="", $sprite="", $tags="",
$link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "system")
-rectangle "$getSystem($label, $descr, $sprite)$getProps()"
$toStereos("system", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure System_Ext($alias, $label, $descr="", $sprite="",
$tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "external_system")
-rectangle "$getSystem($label, $descr, $sprite)$getProps()"
$toStereos("external_system", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure SystemDb($alias, $label, $descr="", $sprite="", $tags="",
$link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "system")
-database "$getSystem($label, $descr, $sprite)$getProps()" $toStereos("system",
$tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure SystemQueue($alias, $label, $descr="", $sprite="",
$tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "system")
-queue "$getSystem($label, $descr, $sprite)$getProps()" $toStereos("system",
$tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure SystemDb_Ext($alias, $label, $descr="", $sprite="",
$tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "external_system")
-database "$getSystem($label, $descr, $sprite)$getProps()"
$toStereos("external_system", $tags) as $alias $getLink($link)
-!endprocedure
-
-!unquoted procedure SystemQueue_Ext($alias, $label, $descr="", $sprite="",
$tags="", $link="")
-!$sprite=$toElementArg($sprite, $tags, "ElementTagSprite", "external_system")
-queue "$getSystem($label, $descr, $sprite)$getProps()"
$toStereos("external_system", $tags) as $alias $getLink($link)
-!endprocedure
-
-' Boundaries
-' ##################################
-
-!unquoted procedure Enterprise_Boundary($alias, $label, $tags="", $link="")
-Boundary($alias, $label, "Enterprise", $tags, $link)
-!endprocedure
-
-!unquoted procedure System_Boundary($alias, $label, $tags="", $link="")
-Boundary($alias, $label, "System", $tags, $link)
-!endprocedure
diff --git a/antora/components/setupguide/modules/eclipse/pages/about.adoc
b/antora/components/setupguide/modules/eclipse/pages/about.adoc
index caa6b0239a..6dc95b4462 100644
--- a/antora/components/setupguide/modules/eclipse/pages/about.adoc
+++ b/antora/components/setupguide/modules/eclipse/pages/about.adoc
@@ -5,7 +5,6 @@
If you are an http://www.eclipse.org[Eclipse] user, then we recommend you
download the "Eclipse JEE package" configuration.
-NOTE: This material does not constitute an endorsement; Eclipse foundation is
not affiliated to Apache Software Foundation in any way.
//== Editor Templates
diff --git a/antora/components/setupguide/modules/intellij/pages/about.adoc
b/antora/components/setupguide/modules/intellij/pages/about.adoc
index 0ddb2dc46c..439b31d3b7 100644
--- a/antora/components/setupguide/modules/intellij/pages/about.adoc
+++ b/antora/components/setupguide/modules/intellij/pages/about.adoc
@@ -4,9 +4,6 @@
This section describes how to install and setup JetBrains' IntelliJ IDEA, then
how to import an application into IntelliJ and run it.
-NOTE: This material does not constitute an endorsement; JetBrains is not
affiliated to Apache Software Foundation in any way.
-JetBrains does however provide complimentary copies of the IntelliJ IDE to
Apache committers.
-
== Installing and Importing
@@ -38,11 +35,11 @@ image::015-import-project/030-imported.png[width="800px"]
Start off by creating a new project:
-Use menu:File[Project Structure] to confirm that JDK 8 is configured:
+Use menu:File[Project Structure] to confirm that JDK 11 is configured:
image::015-import-project/040-project-structure.png[width="600px"]
-
+*TODO*: this screenshot is out of date; JDK 11 is now the minimum version
required.
== Configuring
@@ -105,15 +102,16 @@ You can do this using `File > Settings > Plugins` (or
equivalently `File > Other
Highly recommended are:
+* Lombok plugin (bundled with the IDE)
++
+If you plan to use link:https://projectlombok.org[Project Lombok] to reduce
boilerplate.
+
* link:https://plugins.jetbrains.com/plugin/7179?pr=idea[Maven Helper] plugin
* link:https://plugins.jetbrains.com/plugin/7391-asciidoc[AsciiDoctor] plugin
+
Extremely useful if you are doing any authoring of documents (plugin's git
repo is link:https://github.com/asciidoctor/asciidoctor-intellij-plugin[here])
-* link:https://plugins.jetbrains.com/plugin/6317-lombok[Lombok] plugin
-+
-If you plan to use link:https://projectlombok.org[Project Lombok] to reduce
boilerplate.
@@ -164,7 +162,7 @@ If on Windows you encounter a "The command line is too
long" error, then set '-D
====
Then, set up the run configuration for the app.
-Note how it runs the enhance configuration first:
+Note how it runs the "enhance" configuration first:
.Run Configuration to run the app
image::110-running-the-app/010-run-configuration.png[width="700px"]
diff --git a/core/adoc/modules/ROOT/partials/component-nav.adoc
b/core/adoc/modules/ROOT/partials/component-nav.adoc
index 3e1e24c4b4..d5b6c3fbfb 100644
--- a/core/adoc/modules/ROOT/partials/component-nav.adoc
+++ b/core/adoc/modules/ROOT/partials/component-nav.adoc
@@ -8,5 +8,5 @@ include::core:runtime:partial$module-nav.adoc[]
include::core:runtimeservices:partial$module-nav.adoc[]
include::core:transaction:partial$module-nav.adoc[]
include::core:webapp:partial$module-nav.adoc[]
-include::core:regressiontests:partial$module-nav.adoc[]
+
diff --git
a/core/internaltestsupport/src/main/adoc/modules/internaltestsupport/partials/module-nav.adoc
b/core/internaltestsupport/src/main/adoc/modules/internaltestsupport/partials/module-nav.adoc
index 60bcdc0c51..1339f10696 100644
---
a/core/internaltestsupport/src/main/adoc/modules/internaltestsupport/partials/module-nav.adoc
+++
b/core/internaltestsupport/src/main/adoc/modules/internaltestsupport/partials/module-nav.adoc
@@ -1,4 +1,2 @@
-
-
-* xref:testing:unittestsupport:about.adoc[Unit Test Support]
+* xref:core:internaltestsupport:about.adoc[]
diff --git a/core/metamodel/src/main/adoc/modules/metamodel/pages/about.adoc
b/core/metamodel/src/main/adoc/modules/metamodel/pages/about.adoc
index 746011899d..2f9fa5766f 100644
--- a/core/metamodel/src/main/adoc/modules/metamodel/pages/about.adoc
+++ b/core/metamodel/src/main/adoc/modules/metamodel/pages/about.adoc
@@ -186,109 +186,3 @@ Their _Actions_ (like _Domain Objects_') will be visible
either _Menu Actions_ i
or an _Action_ to their *_Mixee_* (-type).
-[#class-diagram]
-== Class Diagram
-
-The diagram below shows a simplified version of Apache Isis' internal
metamodel.
-
-
-[plantuml]
-----
-include::docs:resources:partial$plantuml-stereotypes.puml[]
-
-package metamodel {
-
- class Object\nSpecId<<value>> {
- +type
- }
-
- class Object\nSpecification<<desc>> {
- +objectSpecId
- ....
- -fullyQualifiedClassName
- }
-
- class Object\nMember<<desc>> {
-
- }
-
- class Object\nAction<<desc>> {
-
- }
-
- class Object\nAssociation<<desc>> {
-
- }
-
- class OneToOne\nAssociation<<desc>> {
-
- }
-
- class OneToMany\nAssociation<<desc>> {
-
- }
-
- interface FacetHolder<<desc>> {
- }
-
- class Object\nActionParameter<<desc>> {
- }
-
- class OneToOne\nActionParameter<<desc>> {
- }
-
- interface Facet<<desc>> {
- }
-
- class OneToMany\nActionParameter<<desc>> {
- }
-}
-
-package runtime {
- class Object\nAdapter<<ppt>> {
- +getSpecification()
- }
- class Oid<<value>> {
-
- }
-}
-
-
-
-Object\nSpecification -up-> Object\nSpecId
-Object\nSpecification -down-> "*" Object\nMember
-Object\nMember ^-down- Object\nAssociation
-Object\nMember ^-down- Object\nAction
-Object\nAssociation ^-down- OneToOne\nAssociation
-Object\nAssociation ^-down- OneToMany\nAssociation
-Object\nActionParameter ^-down- OneToOne\nActionParameter
-Object\nActionParameter ^-down- OneToMany\nActionParameter
-Object\nAction -left-> "*" Object\nActionParameter
-
-FacetHolder ^-.left- Object\nSpecification
-FacetHolder ^-.down- Object\nMember
-FacetHolder ^-.down- Object\nActionParameter
-FacetHolder -right-> "*" Facet
-
-
-Object\nAdapter -up-> Oid
-
-Oid -right-> Object\nSpecId
-
-----
-
-where in the `metamodel` package:
-
-`ObjectSpecification`:: is equivalent to `java.lang.Class`
-`ObjectSpecId`:: is a value object equivalent to the
`@DomainObject#logicalTypeName` or `@DomainService#logicalTypeName` attribute
-`OneToOneAssociation`:: represents a scalar property
-`OneToManyAssociation`:: represents a collection
-`ObjectAction`:: represents an action (with multiple parameters, either scalar
or list)
-
-and in the `runtime` package:
-
-`Oid`:: is equivalent to the applib `Bookmark`
-+
-and appears in URLs in the Wicket and Restful Objects viewers
-
-`ObjectAdapter`:: is equivalent to `java.lang.Object`
diff --git a/regressiontests/adoc/modules/ROOT/pages/about.adoc
b/regressiontests/adoc/modules/ROOT/pages/about.adoc
index b161eeb1dd..c182d3dafc 100644
--- a/regressiontests/adoc/modules/ROOT/pages/about.adoc
+++ b/regressiontests/adoc/modules/ROOT/pages/about.adoc
@@ -2,4 +2,9 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by
applicable law or ag [...]
-WARNING: TODO
+The framework contains a suite of regression tests, most of which are
integration tests, in other words use Spring Boot to bootstrap the application.
+
+The tests themselves are broken out into multiple Maven modules so that they
can be parallelised.
+
+
+
