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.

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

Extend user guide's domain model overview #1221

Merged
merged 5 commits into from
Apr 10, 2024
Merged

Conversation

hankem
Copy link
Member

@hankem hankem commented Dec 30, 2023

This PR extends the user guide's domain model overview.

Old domain model overview

Old domain-overview

New domain model overview

New domain-overview

To support links to javadoc.io, the PlantUML diagrams are rendered as SVGs, embedded as

<object type="image/svg+xml" data="domain-overview.svg" width="1989" height="982">
    <span class="alt">domain overview</span>
</object>

– which may not be supported by outdated browsers.

@hankem hankem changed the title Extend domain model overview in Userguide Extend user guide's domain model overview Dec 30, 2023
as the same information is already present in the JavaAccess hierarchy

Signed-off-by: Manfred Hanke <[email protected]>
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]>
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]>
@codecholeric codecholeric force-pushed the domain-model-overview-userguide branch from e77b971 to fe1ef05 Compare April 10, 2024 22:08
Copy link
Collaborator

@codecholeric codecholeric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks a lot for the improvements!! 😃 I have to admit that I had to go through each commit one by one and regenerate the user guide to understand exactly what changed there, but it all made sense to me then 🙂

@hankem hankem merged commit 6e20006 into main Apr 10, 2024
21 checks passed
@hankem hankem deleted the domain-model-overview-userguide branch April 10, 2024 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants