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

Using lutaml_ea_diagram to show diagrams #277

Open
kwkwan opened this issue Dec 19, 2024 · 4 comments · May be fixed by #278
Open

Using lutaml_ea_diagram to show diagrams #277

kwkwan opened this issue Dec 19, 2024 · 4 comments · May be fixed by #278
Labels
enhancement New feature or request

Comments

@kwkwan
Copy link
Contributor

kwkwan commented Dec 19, 2024

To show a diagram, you may specify the diagram by xmi:id like:

image::images/XXX.png[]

You may also use the macro lutaml_ea_diagram to specify the diagram by name like:

lutaml_ea_diagram::[name="DiagramName",base_path="./images",format="png"]
@kwkwan kwkwan linked a pull request Dec 19, 2024 that will close this issue
4 tasks
@kwkwan kwkwan added the enhancement New feature or request label Dec 19, 2024
@kwkwan
Copy link
Contributor Author

kwkwan commented Dec 19, 2024

To demonstrate how to show diagrams by lutaml_ea_diagram, I have created the PR #278 to show the changes you need to apply.

First of all, you need to add a line in sources/001-v5/document.adoc under :data-uri-image::

...
:mn-output-extensions: xml,html,pdf,rxl
:local-cache-only:
:data-uri-image:

[lutaml_ea_xmi,../xmi/plateau_all_packages_export.xmi]
...

For example, you can replace the Bridge diagram:

image::images/EAID_30D62231_110F_44e8_9C06_6FCDCBA53A09.png[]

by:

lutaml_ea_diagram::[name="Bridge",base_path="./images",format="png"]

where

  • name is the name of the diagram
  • base_path is the path of the diagrams located
  • format is the output format of the diagram

I have no idea which way is more convenient for you to show diagrams. I created this issue is just for your reference.

Ping @ReesePlews @AIS-RyoMukai @ronaldtse

@ReesePlews
Copy link
Contributor

ReesePlews commented Dec 19, 2024

thank you @kwkwan, @AIS-RyoMukai and the team have been replacing the static UML tables with the lutaml-klass autogenerated tables these past couple of weeks. i will discuss with the team in a meeting later today. thank you.

@ronaldtse
Copy link
Contributor

@ReesePlews we would much prefer using the approach shown in #278 for consistency instead of using EA UUIDs for referring to diagrams. It is not entirely ready (as mentioned in #278 to @kwkwan) but just a heads-up.

@ReesePlews
Copy link
Contributor

hello @ronaldtse, i am sorry i have not really followed this enhancement because the UML figures used in the Plateau project are placed in groups (using simple image placement) before the UML autogenerated tables, and i do not think this functionality is being used at this time. do you think this functionality is useful for the Plateau project and does it work better than simple image placement, without changing the structure of the document? if so, perhaps it can be examined during the M1: Community review (discussion 40) as there is very little time before M1 to make those changes. please let me know and i will discuss with the Plateau team. thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants