Skip to content

Commit

Permalink
Update README of lutaml_klass_table
Browse files Browse the repository at this point in the history
  • Loading branch information
kwkwan committed Nov 14, 2024
1 parent 0c74903 commit 3550351
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -389,22 +389,25 @@ The command accepts the options listed below:
* `name` option only, `name` option with `package` option or `path` option.
One of 3 forms of options can be used to specify the name of the class.

** `name="NameOfClass"` specifies the name of the Class. (e.g. `name="Building"`)
** `name="NameOfClass"` specifies the name of the `class`.
(e.g. `name="Building"`)
If there are multiple classes with the same name, other form of options
are recommended to specify the class.

** `package="NameOfPackage"name="NameOfClass"` specifies the name of the
`class` (specified by `name` option) inside the `package`
(specified by `package` option).
The `package` option must be used with the `name` option.
(e.g. `package="uro",name="_BoundarySurface"`)

** `path="PathOfClass"` specifies the `absolute` path of the Class
** `path="PathOfClass"` specifies the `absolute` path of the `class`
which is started with `::`
(e.g. `path="::EA_Model::Conceptual Models::i-UR::Urban Planning ADE 3.
1::uro::_BoundarySurface"`)
or `relative` path of the Class which is not started with `::`
or `relative` path of the `class` which is not started with `::`
(e.g. `path="uro::_BoundarySurface"`).
The last part of the path separated by `::` is the name of the Class.
The other parts of the path are the names of the Packages.
The last part of the path separated by `::` is the name of the `class`.
The other parts of the path are the names of the `packages`.

* `template="/path/to/templates/_my_klass_table.liquid"` specifies the path of
the liquid template. (Optional)
Expand Down

0 comments on commit 3550351

Please sign in to comment.