Support reference of document elements generated by LutaML (other than lutaml_figure and lutaml_table)

[ronaldtse]

lutaml-figure:[...] has been implemented for the referencing of included figures, but we also need macros to refer to other elements generated by LutaML in the document, they include:

• definition tables
• packages
• classes
• enums

Anything else?

Proposed syntax:

lutaml-figure:[name="Fig: Primitives of Zonal Identifier"]

Eg: use diagram name as a lookup id and transform it into <<figure-{{ diagram.xmi_id}}>>(EA names diagram images by this pattern)

Originally posted by @w00lf in #34 (comment)

[w00lf]

definition tables
packages
classes
enums

That won't be a problem to implement, although currently, we need to decide the union naming of all entries. I used templates from citygml and ogc-dggs, both of them have their own ids structure, for example, the class table uses [[tab-P-{{ package_name }}-C-{{ klass_name }}]] naming when citygml uses this naming [[{{ klass.name }}-section]]. So the question here, can we unify naming?

[w00lf]

Proposed macro names:

lutaml_table_class[package="name", name="name"]
lutaml_table_enum[package="name", name="name"]
lutaml_table_data_type[package="name", name="name"]

[ronaldtse]

@w00lf agree with the new macro names.

[ronaldtse]

We need to unify all the anchor naming, currently we have these patterns:

• rc_{{package name}}-model_section
• section-{{xmi_id}}
• table-{{xmi_id}}
• figure-{{xmi_id}}
• {{enum/package/datatype/class name}}-section

[ronaldtse]

We also have to keep in mind the different 2 kinds of templates and their components:

• entity_list and its components:
  • section ({{equalsigns}} {{ package.name }}, now anchored as [[rc_{{ package_name }}-model_section]])
  • diagrams
  • class definitions (=== Class definitions)
    • class definition table
    • data type definition table
    • primitive data type definition table
    • enumerated classes definition table
    • code list definition table
  • inner packages (include "packages_entity_list")
• data_dictionary and its components:
  • section open ({{equalsigns}} {{ package.name }})
  • metadata table (.Metadata of {{ package.name }} ({{ package.stereotype }}))
  • basic types table ({{equalsigns}}= Basic types)
  • union tables ({{equalsigns}}= Unions)
  • code list tables ({{equalsigns}}= Code lists)
  • data types tables ({{equalsigns}}= Data types, now anchored as [[{{ data_type.name }}-section]])
• each data_dictionary_class:
  • section title ({{equalsigns}} {{ klass.name }}, anchored as [[{{ klass.name }}-section]])
  • metadata table (.Metadata of {{ klass.name }} ({{klass.stereotype}}))
  • associations table (.Associations of {{ klass.name }} ({{ klass.stereotype }}))
  • attributes table (.Attributes of {{ klass.name }} ({{klass.stereotype}}))

[w00lf]

@ronaldtse changed citygml section ids to be the same as with ogc - section-{{ xmi_id }} - https://github.com/metanorma/metanorma-plugin-lutaml/pull/74/files
Applied new naming in citygml - metanorma/ogc-citygml-xmi@039df43

[w00lf]

@ronaldtse can we close this one?

[ronaldtse]

We need the functionality in Ruby, not encoded in the template as conventions.