README.adoc in metanorma-plugin-lutaml-0.7.12 vs README.adoc in metanorma-plugin-lutaml-0.7.13

- old
+ new

@@ -392,10 +392,33 @@ the liquid template. (Optional) By default, it will look for the template `_klass_table.liquid` defined in `lib/metanorma/plugin/lutaml/templates`. This template can be customized by changing the template path in the `template` option. +* `guidance="/path/to/my_guidance.yml"`specifies the path of + the yaml file of the guidance. (Optional) + +The guidance file should be in the following format: + +[source,yaml] +---- +--- +classes: + - name: Name Of Class + attributes: + - name: Name Of Attribute (e.g. gml:boundedBy) + used: false + guidance: | + Drop guidance message here. +... +---- + +If you want to define the guidance, you can define the `name` of the class +under `classes`. Then define which `attributes` you want to add guidance by the +`name`. Set `used` to show the attribute is used or not. Drop the message of +guidance in `guidance`. + === Generating UML class and attributes: `lutaml_uml_class` This command allows rendering a definition clause for a UML class. Given `example.lutaml` with this content: @@ -850,9 +873,22 @@ [source,adoc] ----- [lutaml_ea_xmi, path/to/example.xmi] ... ----- + +You can define guidance in the configuration file as well. The configuration +file will looks like: + +[source,yaml] +----- +packages: + - my_package +guidance: "path/to/guidance.yaml" +----- + +Please refer to `lutaml_klass_table` section for how to configure the guidance +yaml file. == Documentation Please refer to https://www.metanorma.org.