Skip to content

Commit f98c0ca

Browse files
authored
Update doc to new version and change import export page (#22)
* Update doc to new version and change import export page
1 parent 091b5d5 commit f98c0ca

File tree

8 files changed

+27
-22
lines changed

8 files changed

+27
-22
lines changed

core/libs/editor/src/lib/editor-toolbar/components/help/document.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {MatDialogRef} from '@angular/material/dialog';
2121
styleUrls: ['./document.component.scss'],
2222
})
2323
export class DocumentComponent {
24-
AMEDocumentationLink = 'https://openmanufacturingplatform.github.io/sds-documentation/ame-guide/4.2.0/introduction.html';
24+
AMEDocumentationLink = 'https://openmanufacturingplatform.github.io/sds-documentation/ame-guide/4.2.1/introduction.html';
2525
BAMMDocumentationLink = 'https://openmanufacturingplatform.github.io/sds-documentation/bamm-specification/2.0.0/index.html';
2626

2727
constructor(private dialogRef: MatDialogRef<DocumentComponent>, @Inject(APP_CONFIG) public config: AppConfig) {

documentation/ame-guide/antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: ame-guide
22
title: Aspect Model Editor
3-
version: "4.2.0"
3+
version: "4.2.1"
44
start_page: ROOT:introduction.adoc
55
nav:
66
- modules/ROOT/nav.adoc
81.4 KB
Loading
117 KB
Loading

documentation/ame-guide/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* xref:validation-and-notifications.adoc[Validation and notifications]
1414
* xref:model-versions.adoc[Aspect Model versions]
1515
* xref:namespaces-references.adoc[Namespaces and external references]
16-
* xref:import-and-export-namespaces.adoc[Import and export namespaces]
16+
* xref:import-and-export-namespaces.adoc[Import and export a namespace]
1717
* xref:use-external-references.adoc[Use external references]
1818
* xref:generate-json.adoc[Generate JSON]
1919
* xref:support.adoc[Support]

documentation/ame-guide/modules/ROOT/pages/import-and-export-namespaces.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
:page-partial:
22

3-
[[import-export-namespaces]]
4-
= Import and export namespaces
3+
[[import-export-namespace]]
4+
= Import and export a namespace
55

66
For general information on external references, see xref:namespaces-references.adoc#namespaces-external-references[Namespaces and external references].
77

8-
[[import-namespaces]]
9-
== Import namespaces
8+
[[import-namespace]]
9+
== Import namespace
1010

11-
To import a package with namespaces, proceed as follows:
11+
To import a package with one single namespace, proceed as follows:
1212

1313
. Click *New/Load* in the xref:ui-overview.adoc#toolbar[toolbar].
1414
. Click *Import Package*.
@@ -34,9 +34,8 @@ image::replace-import.png[width=80%]
3434

3535
→ Now your namespaces are added to the recent model.
3636

37-
3837
[[export-namespace]]
39-
== Export namespaces
38+
== Export namespace
4039

4140
To export a namespace, proceed as follows:
4241

@@ -49,7 +48,8 @@ To export a namespace, proceed as follows:
4948
image::select-namespace-export.png[width=100%]
5049
. Click *Validate*.
5150
+
52-
→ After validation is done, a summary dialog similar to the one for xref:import-and-export-namespaces.adoc#import-namespaces[namespace import] will be displayed. If the validation has files with errors, the namespace cannot be exported.
51+
→ After validation is done, a summary dialog similar to the one for xref:import-and-export-namespaces.adoc#import-namespace[namespace import] will be displayed.
52+
If the validation has files with errors, the namespace cannot be exported.
5353
+
5454
image::export-window.png[width=100%]
5555
. Click *Export*.

documentation/ame-guide/modules/ROOT/pages/namespaces-references.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@
33
[[namespaces-external-references]]
44
= Namespaces and external references
55

6-
The Aspect Model Editor supports external references and custom namespaces. The namespaces from which the external elements can be referenced are defined by the folder structure of the Aspect Model Editor file directory.
6+
The Aspect Model Editor supports external references and custom namespaces.
7+
The namespaces from which the external elements can be referenced are defined by the folder structure of the Aspect Model Editor file directory.
78

89
[[file-directory-folder-structure]]
910
== File directory and folder structure on your local machine
1011

11-
By default, the Aspect Model Editor file directory is located at:
12+
By default, the Aspect Model Editor file directory is located at:
1213

1314
* `+C:\Users\<YOUR-USER-NAME>\aspect-model-editor+` (on Windows)
14-
* `+/Users/<YOUR-USER-NAME>/aspect-model-editor+` (on Mac or Linux)
15+
* `+/Users/<YOUR-USER-NAME>/aspect-model-editor+` (on Mac)
16+
* `/home/<YOUR-USER-NAME>/aspect-model-editor+` (on Linux)
1517

16-
Here you can add the folder structure for your external references which will then show up in the xref:ui-overview.adoc#workspace-sidebar[Workspace sidebar].
18+
Here you can add the folder structure for your external references which will then show up in the xref:ui-overview.adoc#workspace-sidebar[Workspace sidebar].
1719

1820
image::namespace-file-structure.png[width=100%]
1921

@@ -32,7 +34,7 @@ image::file-elements.png[width=100%]
3234

3335
For more information, see also:
3436

35-
* xref:import-and-export-namespaces.adoc[Import and export namespaces]
37+
* xref:import-and-export-namespaces.adoc[Import and export a namespace]
3638
* xref:use-external-references.adoc[Use external references]
3739

3840
++++

documentation/ame-guide/modules/ROOT/pages/use-external-references.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For general information on external references, see xref:namespaces-references.a
1010

1111
To add external references, proceed as follows:
1212

13-
1. xref::import-and-export-namespaces.adoc#import-namespaces[Import the namespace] you want to use.
13+
1. xref::import-and-export-namespaces.adoc#import-namespace[Import the namespace] you want to use.
1414
2. Open the Workspace sidebar.
1515
3. Double-click the TTL file from which you want to use elements from.
1616
4. Drag the specific element and drop it to the graph area canvas.
@@ -19,19 +19,22 @@ image::external-reference-drag-and-drop.png[width=100%]
1919
+
2020
[NOTE]
2121
====
22-
External references can only be dragged once into the current Aspect Model. These elements are marked with a lock sign signifying that they cannot be edited. You can only edit an external reference by editing the file it is defined in.
22+
External references can only be dragged once into the current Aspect Model.
23+
These elements are marked with a lock sign signifying that they cannot be edited.
24+
You can only edit an external reference by editing the file it is defined in.
2325
2426
image::external-reference.png[width=100%]
2527
====
2628
+
2729
[NOTE]
2830
====
29-
When you drag and drop an external reference, it will also include all the lower connections (dependencies) of the element. Same goes for deleting the element &ndash; all dependencies will be deleted as well.
31+
When you drag and drop an external reference, it will also include all the lower connections (dependencies) of the element.
32+
Same goes for deleting the element &ndash; all dependencies will be deleted as well.
3033
3134
image::external-reference-delete.png[width=100%]
3235
====
33-
→ An external reference has now been added to your model.
3436

37+
→ An external reference has now been added to your model.
3538

3639
[[refer-to-another-element]]
3740
== Refer from one element to another one
@@ -43,9 +46,9 @@ To refer from one element to another one, proceed as follows:
4346
. Click *Save*.
4447
. Click *Save to namespace*.
4548
+
46-
Now the reference can be found in the xref:ui-overview.adoc#workspace-sidebar[Workspace sidebar].
49+
→ Now the reference can be found in the xref:ui-overview.adoc#workspace-sidebar[Workspace sidebar].
4750
. xref::load-and-save-models.adoc#load-start-new-models[Load or start] a new model.
48-
. xref::import-and-export-namespaces.adoc#import-export-namespaces[Open] the Workspace sidebar.
51+
. xref::import-and-export-namespaces.adoc#import-export-namespace[Open] the Workspace sidebar.
4952
. Double-click the TTL file of which you want to use elements from.
5053
. Drag the specific element and drop it on the graph area canvas.
5154

0 commit comments

Comments
 (0)