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 #278

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kwkwan
Copy link
Contributor

@kwkwan kwkwan commented Dec 19, 2024

Metanorma PR checklist

@kwkwan kwkwan linked an issue Dec 19, 2024 that may be closed by this pull request
@@ -20,6 +20,8 @@
:local-cache-only:
:data-uri-image:

[lutaml_ea_xmi,../xmi/plateau_all_packages_export.xmi]
Copy link
Contributor

Choose a reason for hiding this comment

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

While this is sufficient for the current use case, what if we want to render two or more XMI files in a document? Then we need to name them just like in lutaml-express (as document attributes).

If we do that, in declaration we define the "short name" of the XMI, location of XMI and also the base path for images. Then when we want an image, we just say for example, "image 1 in XMI 1".

Copy link
Contributor

Choose a reason for hiding this comment

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

Ping @kwkwan for an enhancement issue to move the definition into the header. We do not want to specify the XMI file for every single image we refer to, the line becomes too long. The XMI only needs to be loaded once.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While this is sufficient for the current use case, what if we want to render two or more XMI files in a document? Then we need to name them just like in lutaml-express (as document attributes).

If we do that, in declaration we define the "short name" of the XMI, location of XMI and also the base path for images. Then when we want an image, we just say for example, "image 1 in XMI 1".

An issue (metanorma/metanorma-plugin-lutaml#170) has been created for this enhancement.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ping @kwkwan for an enhancement issue to move the definition into the header. We do not want to specify the XMI file for every single image we refer to, the line becomes too long. The XMI only needs to be loaded once.

The macro lutaml_ea_diagram will refer to the XMI file loaded by lutaml_ea_xmi. Thus, the XMI document is loaded once.

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.

Using lutaml_ea_diagram to show diagrams
2 participants