lutaml 0.11.4 → 0.11.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/docs.yml +28 -5
  3. data/.github/workflows/links.yml +14 -0
  4. data/README.adoc +6 -43
  5. data/docs/_config.yml +1 -1
  6. data/docs/_guides/cli-usage.adoc +43 -0
  7. data/docs/_guides/diagram-generation.adoc +3 -3
  8. data/docs/_guides/index.adoc +21 -20
  9. data/docs/_guides/parsing/index.adoc +9 -8
  10. data/docs/_guides/parsing/qea-parsing.adoc +47 -0
  11. data/docs/_guides/repository-management.adoc +44 -0
  12. data/docs/_guides/sysml-modeling.adoc +2 -2
  13. data/docs/_guides/uml-modeling.adoc +3 -5
  14. data/docs/_pages/concepts/diagram-generation.adoc +4 -4
  15. data/docs/_pages/concepts/lur-format.adoc +4 -4
  16. data/docs/_pages/concepts/qea-parsing.adoc +4 -4
  17. data/docs/_pages/concepts/uml-models.adoc +43 -0
  18. data/docs/_pages/core/architecture.adoc +4 -4
  19. data/docs/_pages/core/installation.adoc +7 -7
  20. data/docs/_pages/core/overview.adoc +10 -10
  21. data/docs/_pages/index.adoc +11 -10
  22. data/docs/_pages/uml-syntax.adoc +41 -25
  23. data/docs/_references/api/parsers.adoc +61 -0
  24. data/docs/_references/api/presenters.adoc +43 -0
  25. data/docs/_references/api/repository.adoc +67 -0
  26. data/docs/_references/cli/commands.adoc +72 -0
  27. data/docs/_references/configuration/diagram-styles.adoc +3 -3
  28. data/docs/_references/configuration/index.adoc +5 -4
  29. data/docs/_references/configuration/package-metadata.adoc +4 -4
  30. data/docs/_references/formats/index.adoc +5 -4
  31. data/docs/_references/formats/lur-format.adoc +39 -0
  32. data/docs/_references/formats/qea-structure.adoc +4 -4
  33. data/docs/_references/index.adoc +26 -25
  34. data/docs/_tutorials/documentation-site.adoc +47 -0
  35. data/docs/_tutorials/first-lur-package.adoc +45 -0
  36. data/docs/_tutorials/generating-diagrams.adoc +42 -0
  37. data/docs/_tutorials/getting-started.adoc +45 -0
  38. data/docs/_tutorials/index.adoc +28 -37
  39. data/docs/_tutorials/querying-models.adoc +44 -0
  40. data/docs/examples/build_package.rb +12 -0
  41. data/docs/examples/build_site.rb +12 -0
  42. data/docs/examples/city_model.rb +21 -0
  43. data/docs/examples/present_class.rb +10 -0
  44. data/docs/examples/query_model.rb +12 -0
  45. data/docs/examples/render_diagram.rb +11 -0
  46. data/docs/index.adoc +12 -12
  47. data/docs/lychee.toml +24 -57
  48. data/lib/lutaml/version.rb +1 -1
  49. data/lutaml.gemspec +1 -1
  50. data/scripts/check-site-urls.rb +54 -0
  51. data/scripts/check-vendor-link.py +64 -0
  52. metadata +26 -4
@@ -169,29 +169,29 @@ This design ensures:
169
169
  * **Type safety** and validation
170
170
  * **Performance** through optimized transformations
171
171
 
172
- See link:architecture[System Architecture] for details.
172
+ See link:{site-baseurl}/core/architecture/[System Architecture] for details.
173
173
 
174
174
  == Getting Started
175
175
 
176
176
  Ready to start using LutaML?
177
177
 
178
- 1. link:/core/installation[Install LutaML] - Get set up
179
- 2. link:/tutorials/getting-started[Quick Start Tutorial] - Your first steps
180
- 3. link:/guides[Guides] - Task-oriented documentation
181
- 4. link:/references[Reference] - Complete API documentation
178
+ 1. link:{site-baseurl}/core/installation/[Install LutaML] - Get set up
179
+ 2. link:{site-baseurl}/tutorials/getting-started/[Quick Start Tutorial] - Your first steps
180
+ 3. link:{site-baseurl}/guides/[Guides] - Task-oriented documentation
181
+ 4. link:{site-baseurl}/references/[Reference] - Complete API documentation
182
182
 
183
183
  == License and Community
184
184
 
185
185
  LutaML is open source and maintained by https://www.ribose.com[Ribose].
186
186
 
187
- * **License**: https://github.com/lutaml/lutaml/blob/main/LICENSE[BSD-3-Clause]
187
+ * **License**: https://opensource.org/licenses/MIT[MIT]
188
188
  * **Source**: https://github.com/lutaml/lutaml[GitHub Repository]
189
189
  * **Package**: https://rubygems.org/gems/lutaml[RubyGems]
190
190
  * **Issues**: https://github.com/lutaml/lutaml/issues[Issue Tracker]
191
191
 
192
192
  == See Also
193
193
 
194
- * link:installation[Installation Guide]
195
- * link:architecture[System Architecture]
196
- * link:concepts/qea-parsing[QEA Parsing Concept]
197
- * link:concepts/lur-format[LUR Package Format]
194
+ * link:{site-baseurl}/core/installation/[Installation Guide]
195
+ * link:{site-baseurl}/core/architecture/[System Architecture]
196
+ * link:{site-baseurl}/concepts/qea-parsing/[QEA Parsing Concept]
197
+ * link:{site-baseurl}/concepts/lur-format/[LUR Package Format]
@@ -1,4 +1,5 @@
1
1
  ---
2
+ permalink: /core/
2
3
  title: Core Topics
3
4
  nav_order: 1
4
5
  has_children: true
@@ -11,38 +12,38 @@ This section covers fundamental concepts and essential information about LutaML'
11
12
 
12
13
  == What You'll Find Here
13
14
 
14
- === link:/overview[What is LutaML?]
15
+ === link:{site-baseurl}/core/overview/[What is LutaML?]
15
16
 
16
17
  Introduction to LutaML, its purpose, and the problems it solves. Learn about the unified interface for accessing multiple modeling languages.
17
18
 
18
- === link:/installation[Installation]
19
+ === link:{site-baseurl}/core/installation/[Installation]
19
20
 
20
21
  Get LutaML installed and configured on your system. Covers installation via RubyGems, bundler, and from source.
21
22
 
22
- === link:/architecture[System Architecture]
23
+ === link:{site-baseurl}/core/architecture/[System Architecture]
23
24
 
24
25
  Understanding LutaML's two-layer architecture: the QEA parse layer and the UML domain layer. Learn how data flows through the system.
25
26
 
26
27
  === Core Concepts
27
28
 
28
- ==== link:/concepts/qea-parsing[QEA Direct Parsing]
29
+ ==== link:{site-baseurl}/concepts/qea-parsing/[QEA Direct Parsing]
29
30
 
30
31
  Learn about Enterprise Architect's QEA format and why direct SQLite parsing is 10-20x faster than XMI export.
31
32
 
32
- ==== link:/concepts/lur-format[LUR Package Format]
33
+ ==== link:{site-baseurl}/concepts/lur-format/[LUR Package Format]
33
34
 
34
35
  Understanding LutaML's compressed binary format for fast loading and efficient querying of UML models.
35
36
 
36
- ==== link:/concepts/uml-models[UML Model Structure]
37
+ ==== link:{site-baseurl}/concepts/uml-models/[UML Model Structure]
37
38
 
38
39
  How LutaML represents UML models internally, including packages, classes, attributes, and relationships.
39
40
 
40
- ==== link:/concepts/diagram-generation[Diagram Generation]
41
+ ==== link:{site-baseurl}/concepts/diagram-generation/[Diagram Generation]
41
42
 
42
43
  Overview of LutaML's production-ready diagram generation system with EA-style rendering.
43
44
 
44
45
  == Related Sections
45
46
 
46
- * link:../tutorials[Tutorials] - Step-by-step learning paths
47
- * link:../guides[Guides] - Task-oriented how-to documentation
48
- * link:../references[Reference] - Detailed technical specifications
47
+ * link:{site-baseurl}/tutorials/[Tutorials] - Step-by-step learning paths
48
+ * link:{site-baseurl}/guides/[Guides] - Task-oriented how-to documentation
49
+ * link:{site-baseurl}/references/[Reference] - Detailed technical specifications
@@ -152,7 +152,7 @@ If this syntax is used inside a `class`/`enum`/`association` block, it will be c
152
152
  This is a
153
153
  multi-line
154
154
  document comment.
155
- *|
155
+ |*
156
156
 
157
157
  class A
158
158
  enum B {
@@ -162,7 +162,7 @@ enum B {
162
162
  This is a
163
163
  multi-line
164
164
  class comment.
165
- *|
165
+ |*
166
166
  bar
167
167
  }
168
168
  ----
@@ -279,15 +279,22 @@ following:
279
279
 
280
280
  The name of the element and its visibility are optional.
281
281
 
282
+ [NOTE]
283
+ --
284
+ Visibility on package contents (classes, enums, packages) is not yet
285
+ implemented; only attribute visibility (`+`, `-`, `#`, `~`) is parsed
286
+ today. Element-level visibility is a candidate for adoption into the
287
+ LML specification (RS 3001) pending an audit of UML round-trip
288
+ requirements.
289
+ --
290
+
282
291
  [example]
283
- .Declaring a package named "Ceramic" with a public visibility modifier
292
+ .Declaring a package named "CeramicInformationModel"
284
293
  ====
285
294
  [source]
286
295
  ----
287
296
  package CeramicInformationModel {
288
297
  class Ceramic {}
289
- - class PrivateCeramic {}
290
- # class ProtectedCeramic {}
291
298
  }
292
299
  ----
293
300
  ====
@@ -584,7 +591,7 @@ Explicit syntax (`attribute` keyword included):
584
591
  [source]
585
592
  ----
586
593
  class A {
587
- attribute my_attribute
594
+ attribute my_attribute, String
588
595
  }
589
596
 
590
597
  enum A {
@@ -670,6 +677,14 @@ class Figure {
670
677
 
671
678
  === Methods
672
679
 
680
+ [NOTE]
681
+ --
682
+ Methods are not yet implemented by the LML parser. This section
683
+ documents the planned surface; adoption into the LML specification
684
+ (RS 3001) is pending an audit of downstream UML round-trip
685
+ requirements (Enterprise Architect, XMI).
686
+ --
687
+
673
688
  ==== General
674
689
 
675
690
  A method is a function that is defined inside a class and can be called to
@@ -881,8 +896,14 @@ association {
881
896
  ====
882
897
  [source]
883
898
  ----
899
+ class Ceramic {}
900
+ class Glaze {}
901
+
884
902
  association {
885
- Ceramic -> Glaze
903
+ owner_type association
904
+ owner Ceramic
905
+ member_type association
906
+ member Glaze
886
907
  }
887
908
  ----
888
909
  ====
@@ -893,37 +914,32 @@ Syntax:
893
914
 
894
915
  [source]
895
916
  ----
896
- association name {
897
- owned_type association|composition|aggregation|generalization|uses
917
+ association [name] {
918
+ owner_type association|composition|aggregation|generalization|uses
919
+ owner class_name[#attribute_name]
898
920
  member_type association|composition|aggregation|generalization|uses
899
- owned association_name[#attribute_name] [{property_string}][cardinality]
900
- member association_name[#attribute_name] [{property_string}][cardinality]
921
+ member class_name[#attribute_name]
901
922
  }
902
923
  ----
903
924
 
904
925
  where:
905
926
 
906
- * `owned_type` - optional, use to define a bidirectional association (`association`|`composition`|`aggregation`|`generalization`|`uses`)
927
+ * `owner_type` - optional, use to define a bidirectional association (`association`|`composition`|`aggregation`|`generalization`|`uses`)
907
928
  * `member_type` - association type (`association`|`composition`|`aggregation`|`generalization`|`uses`)
908
- * `owned|member` - end of association, use `\#attribute_name` to set a role name
909
- * `property_string` - property string for attributes associations
910
- * `cardinality` - examples: `1..*`, `*`
929
+ * `owner`/`member` - end of association, use `#attribute_name` to set a role name
911
930
 
912
931
  Example:
913
932
 
914
933
  [source]
915
934
  ----
916
- class Association {
917
- +association:
918
- }
919
- class Type {
920
- +endType:
921
- }
935
+ class Address {}
936
+ class AddressComponent {}
922
937
 
923
- association AssociatingTypeAndAssociation {
924
- type uses
925
- from Association#+association {subsets relationship}[*]
926
- to Type#+/endType {readOnly, subsets relatedElement} [1..*]
938
+ association AddressesAssociation {
939
+ owner_type aggregation
940
+ owner Address
941
+ member_type association
942
+ member AddressComponent
927
943
  }
928
944
  ----
929
945
 
@@ -0,0 +1,61 @@
1
+ ---
2
+ permalink: /references/api/parsers/
3
+ title: Parser APIs
4
+ parent: Reference
5
+ ---
6
+ = Parser APIs
7
+
8
+ Select the parser for the input language and check its result type before
9
+ passing the result to another component. The split gems do not share a
10
+ universal `Lutaml::Parser.parse` entry point.
11
+
12
+ [cols="1,2,2",options="header"]
13
+ |===
14
+ |Input |Entry point |Result
15
+ |LML text |`Lutaml::Lml.parse_document(input)` |`Lutaml::Lml::Document`, without view resolution.
16
+ |LML diagram/view |`Lutaml::Lml.parse(input)` |An LML document with view imports and filtering resolved.
17
+ |EXPRESS |`Lutaml::Express::Parsers::Exp.parse(io)` |The EXPRESS repository returned by Expressir.
18
+ |LUR package |`Lutaml::UmlRepository::Repository.from_package(path)` |A UML repository.
19
+ |QEA or XMI |A separately installed format provider |A provider-specific result; convert it to a UML document before repository construction.
20
+ |===
21
+
22
+ == LML input
23
+
24
+ [source,ruby]
25
+ ----
26
+ require "lutaml"
27
+
28
+ document = Lutaml::Lml.parse_document("diagram City { class Building {} }")
29
+ puts document.classes.first.name
30
+ ----
31
+
32
+ This prints `Building`. For files, open the input and pass the IO object.
33
+ `parse` performs the additional view-resolution stage needed by diagram views.
34
+ Parsing failures raise LML errors such as `Lutaml::Lml::ParsingError`.
35
+ Do not treat an LML document as a `Lutaml::Uml::Document` merely because both
36
+ have a `classes` collection.
37
+
38
+ == EXPRESS input
39
+
40
+ Pass an open IO to the umbrella's EXPRESS adapter:
41
+
42
+ [source,ruby]
43
+ ----
44
+ require "lutaml"
45
+
46
+ repository = File.open("schema.exp") do |input|
47
+ Lutaml::Express::Parsers::Exp.parse(input)
48
+ end
49
+ ----
50
+
51
+ The result belongs to Expressir's model family. Use Expressir's repository
52
+ operations rather than the UML query API on that result.
53
+
54
+ == QEA and XMI integration
55
+
56
+ `lutaml-uml` 1.0.3's repository layer does not import QEA or XMI itself.
57
+ Its `from_file` method raises `ArgumentError` for those extensions.
58
+ An importer must supply a `Lutaml::Uml::Document`; then use
59
+ `Repository.from_document(document)`.
60
+ See link:{site-baseurl}/guides/parsing/qea-parsing/[Integrating QEA Parsing]
61
+ for the integration boundary and validation steps.
@@ -0,0 +1,43 @@
1
+ ---
2
+ permalink: /references/api/presenters/
3
+ title: Presenter APIs
4
+ parent: Reference
5
+ ---
6
+ = Presenter APIs
7
+
8
+ Presenters turn UML elements into text, table rows, and hashes without changing
9
+ the model. They live under `Lutaml::UmlRepository::Presenters`.
10
+
11
+ == Present a class
12
+
13
+ Save this beside `city_model.rb` from
14
+ link:{site-baseurl}/tutorials/getting-started/[Getting Started]:
15
+
16
+ [source,ruby]
17
+ ----
18
+ include::../../examples/present_class.rb[]
19
+ ----
20
+
21
+ Run it with `bundle exec ruby present_class.rb`. The output starts with
22
+ `Class: Building`. Requiring the concrete class presenter registers it with
23
+ the factory before the factory selects it.
24
+
25
+ == Factory and output contract
26
+
27
+ `PresenterFactory.create(element, repository = nil, context = nil)` chooses
28
+ a registered presenter by the element's class, then by its ancestors.
29
+ It raises `ArgumentError` if no presenter is registered for the type.
30
+
31
+ Concrete presenters implement:
32
+
33
+ * `to_text`: a text description.
34
+ * `to_table_row`: a hash suitable for a table row.
35
+ * `to_hash`: structured output for callers to serialize as JSON or YAML.
36
+
37
+ The base `ElementPresenter` provides shared helpers; it does not implement
38
+ those output methods. Instantiate a concrete presenter instead.
39
+
40
+ For an application-specific type, subclass the base, implement all three
41
+ outputs as public methods, then call
42
+ `PresenterFactory.register(element_class, presenter_class)`.
43
+ Keep the repository argument when output needs qualified names or relationships.
@@ -0,0 +1,67 @@
1
+ ---
2
+ permalink: /references/api/repository/
3
+ title: Repository API
4
+ parent: Reference
5
+ ---
6
+ = Repository API
7
+
8
+ `Lutaml::UmlRepository::Repository`, supplied by `lutaml-uml`, wraps a
9
+ `Lutaml::Uml::Document` with indexes, queries, statistics, and package I/O.
10
+ Load it with `require "lutaml"` when using the umbrella gem.
11
+
12
+ == Construction and package I/O
13
+
14
+ [cols="2,3",options="header"]
15
+ |===
16
+ |Method |Contract
17
+ |`.from_document(document, options = {})` |Build indexes for a typed UML document.
18
+ |`.from_package(path)` |Load a LUR ZIP package, including its stored indexes.
19
+ |`.from_file(path, options = {})` |Accept `.lur` files; reject other extensions with `ArgumentError`.
20
+ |`.from_package_lazy(path)` |Load the document and defer index construction.
21
+ |`#export_to_package(path, options = {})` |Write a LUR package from the repository.
22
+ |===
23
+
24
+ For export with `lutaml-uml` 1.0.3, also require `lutaml/uml/version` to load the
25
+ component version used in package metadata. See the executable
26
+ link:{site-baseurl}/tutorials/first-lur-package/[LUR package tutorial].
27
+
28
+ `.from_file_cached(source_path, lur_path: nil) { |path| ... }` uses an existing
29
+ cache when it is at least as new as the source. Otherwise, the block must
30
+ return a UML document to index and save. The method does not choose an external
31
+ QEA or XMI parser for you.
32
+
33
+ == Lookups
34
+
35
+ * `find_package(path, raise_on_error: false)` and
36
+ `find_class(qualified_name, raise_on_error: false)` return an element or `nil`.
37
+ * `list_packages(path = "ModelRoot", recursive: false)` returns package objects.
38
+ * `classes_in_package(path, recursive: false)` returns matching classifiers.
39
+ * `find_classes_by_stereotype(name)` uses the stereotype index.
40
+ * `package_tree(path = "ModelRoot", max_depth: nil)` returns the package hierarchy.
41
+ * `find_diagram(name)`, `diagrams_in_package(path)`, and `all_diagrams` access
42
+ diagram objects already present in the document; they do not render SVG.
43
+
44
+ Qualified paths use `::`, for example `ModelRoot::City::Building`.
45
+ Use the actual package hierarchy rather than a source filename as the path.
46
+
47
+ == Search, queries, and statistics
48
+
49
+ `search(text, types: [:class, :attribute, :association], fields: [:name])`
50
+ returns grouped results under `:classes`, `:attributes`, and `:associations`,
51
+ plus `:total`. Structured queries return model objects:
52
+
53
+ [source,ruby]
54
+ ----
55
+ classes = repository.query do |query|
56
+ query.classes.where(name: /Building/).order_by(:name).limit(10)
57
+ end.all
58
+ ----
59
+
60
+ In `lutaml-uml` 1.0.3, the DSL's `in_package` condition raises `NameError` for
61
+ an unresolved `PackagePath` constant. Use `classes_in_package(path)` for that
62
+ operation rather than adding `in_package` to a query chain.
63
+
64
+ `statistics` returns a hash of counts and model metrics.
65
+ The synthetic `ModelRoot` contributes to package counts.
66
+ See link:{site-baseurl}/tutorials/querying-models/[Searching and Querying Models]
67
+ for a complete runnable example.
@@ -0,0 +1,72 @@
1
+ ---
2
+ permalink: /references/cli/commands/
3
+ title: Command-Line Compatibility
4
+ parent: Reference
5
+ ---
6
+ = Command-Line Compatibility
7
+
8
+ The LutaML family has been split into separate gems. Historical examples using
9
+ `lutaml uml ...` are not a command reference for the current umbrella package.
10
+ In `lutaml-uml` 1.0.3, the packaged `lutaml` executable requires
11
+ `lutaml/cli`, but that implementation is absent from the gem. The umbrella
12
+ checkout does not supply it either. Use the Ruby APIs below for these workflows.
13
+
14
+ Do not interpret a command name in an older tutorial as evidence that the
15
+ corresponding executable is available in your installed version.
16
+
17
+ [[build]]
18
+ == Build a package
19
+
20
+ Use `repository.export_to_package("model.lur")` after constructing a UML
21
+ repository. The link:{site-baseurl}/tutorials/first-lur-package/[package tutorial]
22
+ has a complete runnable script, including current component initialization.
23
+
24
+ [[search]]
25
+ == Search
26
+
27
+ Use `repository.search("Building", types: [:class])`. Read the grouped results
28
+ and `:total` from the returned hash. For object filtering, use the
29
+ link:{site-baseurl}/tutorials/querying-models/[query DSL].
30
+
31
+ [[export]]
32
+ == Export model data
33
+
34
+ `repository.document.to_yaml` serializes the typed UML document to YAML.
35
+ Write that string with `File.write("model.yaml", ...)` when you need a plain
36
+ model file. Use `export_to_package` when you also need repository metadata
37
+ and indexes in a LUR archive.
38
+
39
+ [[ls]]
40
+ == List elements
41
+
42
+ Use `repository.list_packages("ModelRoot", recursive: true)` for package objects
43
+ or `repository.classes_in_package(path, recursive: true)` for classifiers.
44
+ These are Ruby return values; callers choose the text or table format.
45
+
46
+ [[tree]]
47
+ == Inspect the hierarchy
48
+
49
+ `repository.package_tree("ModelRoot", max_depth: 3)` returns a nested hierarchy.
50
+ It does not print a terminal tree by itself. Use the returned structure in your
51
+ own presentation, or generate a model browser.
52
+
53
+ [[stats]]
54
+ == Read statistics
55
+
56
+ `repository.statistics` returns a hash, including `:total_packages`,
57
+ `:total_classes`, and `:total_diagrams`. Counts include the synthetic root
58
+ package. Rebuild the repository if you change its underlying document.
59
+
60
+ [[docs]]
61
+ == Generate documentation
62
+
63
+ Use `Lutaml::UmlRepository::StaticSite.generate(repository, output: "browser.html")`.
64
+ See link:{site-baseurl}/tutorials/documentation-site/[Creating a Documentation Site]
65
+ for output modes and local inspection.
66
+
67
+ [[serve]]
68
+ == Serve generated files
69
+
70
+ The static output can be served by an ordinary HTTP server. For example,
71
+ `python3 -m http.server 8000` serves the current directory when Python 3 is
72
+ available. Publishing and server configuration are separate from model generation.
@@ -711,6 +711,6 @@ conn_style = resolver.resolve_connector_style(connector, diagram_link)
711
711
 
712
712
  == See Also
713
713
 
714
- * link:diagram-generation[Diagram Generation Guide]
715
- * link:../README[LutaML README]
716
- * link:../config/diagram_styles.yml[Default Configuration File]
714
+ * link:{site-baseurl}/guides/diagram-generation/[Diagram Generation Guide]
715
+ * link:https://github.com/lutaml/lutaml/blob/main/README.md[LutaML README]
716
+ * link:{site-baseurl}/references/configuration/diagram-styles/#configuration-file-format[Configuration File Format]
@@ -1,4 +1,5 @@
1
1
  ---
2
+ permalink: /references/configuration/
2
3
  title: Configuration
3
4
  parent: Reference
4
5
  nav_order: 4
@@ -11,7 +12,7 @@ Complete configuration schemas and reference documentation for LutaML's various
11
12
 
12
13
  == Available Configuration References
13
14
 
14
- === link:diagram-styles[Diagram Styling Configuration]
15
+ === link:{site-baseurl}/references/configuration/diagram-styles/[Diagram Styling Configuration]
15
16
 
16
17
  Complete YAML schema reference for configuring diagram generation with EA-style rendering.
17
18
 
@@ -24,7 +25,7 @@ Complete YAML schema reference for configuring diagram generation with EA-style
24
25
  * Font and color configuration
25
26
  * Box styling options
26
27
 
27
- === link:package-metadata[Package Metadata Configuration]
28
+ === link:{site-baseurl}/references/configuration/package-metadata/[Package Metadata Configuration]
28
29
 
29
30
  YAML configuration for package metadata including XML namespaces and schema locations.
30
31
 
@@ -48,5 +49,5 @@ LutaML searches for configuration files in these locations:
48
49
 
49
50
  == Related Documentation
50
51
 
51
- * link:../../guides[Guides] - How to use these configurations
52
- * link:../../tutorials[Tutorials] - Step-by-step configuration examples
52
+ * link:{site-baseurl}/guides/[Guides] - How to use these configurations
53
+ * link:{site-baseurl}/tutorials/[Tutorials] - Step-by-step configuration examples
@@ -407,10 +407,10 @@ bundle exec rspec spec/lutaml/uml_repository/package_metadata_spec.rb
407
407
 
408
408
  == Example Configuration
409
409
 
410
- See link:../config/package_metadata.example.yml[config/package_metadata.example.yml] for a complete example configuration file with detailed comments.
410
+ See link:https://github.com/lutaml/lutaml-uml/blob/main/config/package_metadata.example.yml[config/package_metadata.example.yml] for a complete example configuration file with detailed comments.
411
411
 
412
412
  == See Also
413
413
 
414
- * link:README[LutaML README] - Main documentation
415
- * link:diagram_generation[Diagram Generation] - Diagram styling integration
416
- * link:../lib/lutaml/uml_repository/package_metadata.rb[PackageMetadata source] - Implementation
414
+ * link:https://github.com/lutaml/lutaml/blob/main/README.md[LutaML README] - Main documentation
415
+ * link:{site-baseurl}/guides/diagram-generation/[Diagram Generation] - Diagram styling integration
416
+ * link:https://github.com/lutaml/lutaml-uml/blob/main/lib/lutaml/uml_repository/package_metadata.rb[PackageMetadata source] - Implementation
@@ -1,4 +1,5 @@
1
1
  ---
2
+ permalink: /references/formats/
2
3
  title: File Formats
3
4
  parent: Reference
4
5
  nav_order: 3
@@ -11,7 +12,7 @@ Complete specifications for all file formats supported by LutaML.
11
12
 
12
13
  == Available Format Specifications
13
14
 
14
- === link:qea-structure[QEA File Format]
15
+ === link:{site-baseurl}/references/formats/qea-structure/[QEA File Format]
15
16
 
16
17
  Enterprise Architect's native SQLite database format specification.
17
18
 
@@ -23,7 +24,7 @@ Enterprise Architect's native SQLite database format specification.
23
24
  * Performance characteristics
24
25
  * Configuration and usage
25
26
 
26
- === link:lutaml-syntax[LutaML Syntax Reference]
27
+ === link:{site-baseurl}/references/formats/lutaml-syntax/[LutaML Syntax Reference]
27
28
 
28
29
  Complete syntax reference for LutaML's native modeling DSL.
29
30
 
@@ -38,5 +39,5 @@ Complete syntax reference for LutaML's native modeling DSL.
38
39
 
39
40
  == Related Documentation
40
41
 
41
- * link:../../guides/parsing[Parsing Guides] - How to parse these formats
42
- * link:../../pages[Core Topics] - Understanding model structures
42
+ * link:{site-baseurl}/guides/parsing/[Parsing Guides] - How to parse these formats
43
+ * link:{site-baseurl}/core/[Core Topics] - Understanding model structures
@@ -0,0 +1,39 @@
1
+ ---
2
+ permalink: /references/formats/lur-format/
3
+ title: LUR Package Format
4
+ parent: Reference
5
+ ---
6
+ = LUR Package Format
7
+
8
+ A `.lur` file is a ZIP archive produced by the UML repository exporter.
9
+ It packages a typed UML document, lookup indexes, and descriptive metadata.
10
+ Use the repository loader and exporter instead of constructing an archive by hand.
11
+
12
+ == Archive entries
13
+
14
+ [cols="1,2",options="header"]
15
+ |===
16
+ |Entry |Contents
17
+ |`metadata.yaml` |Package metadata, serialization format, timestamps, component version, and statistics.
18
+ |`repository.yaml` |The serialized `Lutaml::Uml::Document`.
19
+ |`indexes/all.yaml` |The repository's lookup indexes.
20
+ |`index_tree.yaml` |A searchable package/class summary.
21
+ |`statistics.yaml` |Repository statistics.
22
+ |===
23
+
24
+ These names describe the YAML package writer in `lutaml-uml` 1.0.3.
25
+ Do not assume that an arbitrary ZIP or renamed XMI file is a valid LUR package.
26
+
27
+ == Read and write
28
+
29
+ Call `Repository.from_package(path)` to load a package and
30
+ `repository.export_to_package(path)` to export it.
31
+ The exporter defaults to YAML document serialization and compression level 6.
32
+ It accepts package metadata through its options; see
33
+ link:{site-baseurl}/references/configuration/package-metadata/[Package Metadata].
34
+ The link:{site-baseurl}/tutorials/first-lur-package/[package tutorial] includes
35
+ the version require needed by the current exporter and verifies a full round trip.
36
+
37
+ The loader reports absent files with `ArgumentError` and reports invalid ZIP
38
+ or deserialization failures as load errors. Keep your source model and lockfile
39
+ so that you can regenerate the package when its model or dependency versions change.
@@ -1344,10 +1344,10 @@ Connection pooling:: Reuses database connections
1344
1344
 
1345
1345
  === Documentation
1346
1346
 
1347
- * link:QEA_DATABASE_TABLE_ANALYSIS.md[Detailed table analysis]
1348
- * link:../README[LutaML main documentation]
1349
- * link:DIAGRAM_SUPPORT_IMPLEMENTATION.md[Diagram implementation details]
1350
- * link:OBJECT_PROPERTIES_IMPLEMENTATION.md[Object properties implementation]
1347
+ * <<implemented-tables,Detailed table analysis>>
1348
+ * link:https://github.com/lutaml/lutaml/blob/main/README.md[LutaML main documentation]
1349
+ * <<diagram-tables,Diagram table details>>
1350
+ * <<t_objectproperties-object-properties,Object property fields>>
1351
1351
 
1352
1352
  === Source code
1353
1353