Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extend user guide's domain model overview #1221

Merged
merged 5 commits into from
Apr 10, 2024
Merged

Extend user guide's domain model overview #1221

merged 5 commits into from
Apr 10, 2024

Commits on Apr 10, 2024

  1. extend domain model overview diagram 

    Signed-off-by: Manfred Hanke <[email protected]>
    @hankem @codecholeric
    hankem authored and codecholeric committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    7873bd1 View commit details
    Browse the repository at this point in the history

  2. remove AccessTarget hierarchy from domain model overview diagram 

    as the same information is already present in the JavaAccess hierarchy

Signed-off-by: Manfred Hanke <[email protected]>
    @hankem @codecholeric
    hankem authored and codecholeric committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    3a1d857 View commit details
    Browse the repository at this point in the history

  3. render PlantUML diagrams as (interactive) SVGs 

    included as
```
<object type="image/svg+xml"
```
to support hyperlinks.

The options for SVG images are documented at https://docs.asciidoctor.org/asciidoc/latest/macros/image-svg/.

Signed-off-by: Manfred Hanke <[email protected]>
    @hankem @codecholeric
    hankem authored and codecholeric committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    3489966 View commit details
    Browse the repository at this point in the history

  4. hide empty fields & methods of class diagrams 

    Signed-off-by: Manfred Hanke <[email protected]>
    @hankem @codecholeric
    hankem authored and codecholeric committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    8da60d5 View commit details
    Browse the repository at this point in the history

  5. upgrade asciidoctor dependencies 

    https://github.com/asciidoctor/asciidoctor-diagram/releases/tag/v2.2.6
updates PlantUML from 1.2022.14 to 1.2023.4.

Since plantuml-1.2023.2,
```
package com.myapp.application
```
produces 3 boxes instead of one by default.

cf. https://plantuml.com/news:
* 2 Feb, 2023: Important change about package and namespace
>
> Starting with version 1.2023.2 (which is online as a beta),
> PlantUML handles differently namespaces and packages.
>
> There won't be any difference between namespaces and packages anymore:
> both keywords are now synonymous.
>
> The drawing is slightly different, because we now also draw intermediate packages.
> Note that this is not a final choice, it depends on the feedback from users.
>
> Packages now involve the definition of a namespace, as in any ordinary programming language.
> The default separator is the dot (.) but can be changed using the `set separator X` directive.
> You can also disable namespace management using `set separator none`,
> in which case you get back a behavior similar to older versions of PlantUML.

Signed-off-by: Manfred Hanke <[email protected]>
    @hankem @codecholeric
    hankem authored and codecholeric committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    fe1ef05 View commit details
    Browse the repository at this point in the history