Skip to content

Commit e8acbb7

Browse files
mbatsAxelRICHARD
authored andcommitted
[doc] Add before you start section to all the features
Contribute a new partial "before you start" which specify features status and usage which is used by all the sections describing a feature. Fix a reference in the troubleshooting page. Signed-off-by: Mélanie Bats <melanie.bats@obeo.fr>
1 parent 0ce2c05 commit e8acbb7

17 files changed

+44
-35
lines changed

doc/content/modules/installation-guide/pages/troubleshooting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Make sure you have included the correct argument to your `java` command accordin
2828

2929
TIP: Check that you are consulting the documentation version that matches the JAR version you are trying to run.
3030

31-
Refer to the xref:installation-guide:install.adoc#start-app[] section for detailed instructions according to your version.
31+
Refer to the xref:installation-guide:how-tos/install.adoc#start-app[] section for detailed instructions according to your version.

doc/content/modules/user-manual/pages/features/action-flow-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {afv}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {afv} describes input and output flows between different actions within a system.
66
This type of diagram is useful for understanding and analyzing the dynamic behavior of a system, focusing on action sequences and interaction between system elements.

doc/content/modules/user-manual/pages/features/details.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {details}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {details} view provides a comprehensive overview of the selected element, presenting distinct _Property_ sections for each _characteristic_ of the semantic object.
66

doc/content/modules/user-manual/pages/features/editor.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {editor}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
== What's the {editor}?
66

doc/content/modules/user-manual/pages/features/explorer.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {explorer}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {explorer} presents a hierarchical view of all models and their contents within the project, displayed as a tree structure with expandable and collapsible items.
66

doc/content/modules/user-manual/pages/features/general-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {gv}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {gv} is employed to display any members of exposed model elements.
66
it's the most general view, enabling presentation of any model element.

doc/content/modules/user-manual/pages/features/homepage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:homepage: Projects browser
22
= {homepage}
33

4-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
4+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
55

66
== What's the {homepage}?
77

doc/content/modules/user-manual/pages/features/interconnection-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {iv}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {iv} is used to show encapsulated structural contents of _Usage- element: Parts, Properties, Connectors, Ports, and Interfaces.
66

doc/content/modules/user-manual/pages/features/keyboard-shortcuts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Keyboard shortcuts
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
== General
66

doc/content/modules/user-manual/pages/features/related-elements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {related-elements}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
For a more focused exploration, delve into the {related-elements} view.
66

doc/content/modules/user-manual/pages/features/representations-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {representations-view}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
Explore the {representations-view} view to gain insights into the available representations associated with the selected element.
66

doc/content/modules/user-manual/pages/features/state-transition-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= State transition view
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {stv} is describes the logical transition of a system through various states of a system and the transitions between those states.
66
This view shows the behavior of complex system, for example how it evolves over time in response to specific events/stimuli.

doc/content/modules/user-manual/pages/features/validation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {validation}
22

3-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
3+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
44

55
The {validation} view displays diagnostics for the entire project, organized by their kind such as `ERROR`, `WARNING`, or `INFO`.
66
Users can conveniently toggle the visibility of diagnostics by using an accordion widget.

doc/content/modules/user-manual/pages/hands-on/how-tos/explorer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[#sync-editor]
44
== Synchronize {explorer} / {editor}
55

6-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
6+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
77

88
It's possible to turn-off and turn-on the synchronization between the {explorer} and the current selection in the {editor}.
99

@@ -23,7 +23,7 @@ When synchronization is disabled, tree items that are already expanded in the {e
2323
[#expand-all]
2424
== Expand all
2525

26-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
26+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
2727

2828
[WARNING]
2929
====
@@ -43,7 +43,7 @@ This action expands the selected element and all its children recursively, offer
4343
[#explorer-filter]
4444
== Filter elements in the {explorer}
4545

46-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
46+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
4747

4848
=== Filter from name
4949

doc/content/modules/user-manual/pages/hands-on/how-tos/model-management.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[#create-model]
44
== Create a new model
55

6-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
6+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
77

88
To create a model, follow these steps from the explorer toolbar:
99

@@ -22,7 +22,7 @@ image::hands-on-new-model-result.png[New Model result]
2222
[#upload-model]
2323
== Upload a model
2424

25-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
25+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
2626

2727
[NOTE]
2828
====
@@ -45,7 +45,7 @@ image::hands-on-upload-model.png[Upload model]
4545
[#rename-model]
4646
== Rename a model
4747

48-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
48+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
4949

5050
You can update the model name from the {explorer}:
5151

@@ -57,7 +57,7 @@ You can update the model name from the {explorer}:
5757
[#delete-model]
5858
== Delete a model
5959

60-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
60+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
6161

6262
[WARNING]
6363
====
@@ -93,7 +93,7 @@ You can reset it by deleting the {product} data in cache of your browser.
9393
[#download-model]
9494
== Download a model
9595

96-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
96+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
9797

9898
You can download a model from the {explorer}:
9999

@@ -111,7 +111,7 @@ The JSON format used by {product} is specific to the tool.
111111
[#create-element]
112112
== Create a new element
113113

114-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
114+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
115115

116116
The process to create a new element in a model involves the following steps:
117117

@@ -126,7 +126,7 @@ Upon completion, the newly created element is automatically selected in the {exp
126126

127127
== Read an element
128128

129-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
129+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
130130

131131
. To navigate through the details of a semantic element, use the {explorer} to navigate through the model and locate the needed element.
132132
. Select the element in the {explorer}.
@@ -138,7 +138,7 @@ image::hands-on-read-element.png[Read element]
138138
[#rename-element]
139139
== Rename an element
140140

141-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
141+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
142142

143143
It's possible to rename an element either from the {explorer}, the {details} view or a representation.
144144

@@ -185,7 +185,7 @@ Instead of using the tool in the toolbar, you can press `F2` key or start typing
185185
[#update-element]
186186
== Update an element
187187

188-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
188+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
189189

190190
It's possible to update element properties either from the {details} view or a representation.
191191

@@ -220,7 +220,7 @@ A powerful syntax exists for editing element properties directly through the dir
220220
[#delete-element]
221221
== Delete an element
222222

223-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
223+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
224224

225225
[WARNING]
226226
====
@@ -265,7 +265,7 @@ You can reset it by deleting the {product} data in cache of your browser.
265265
[#direct-edit]
266266
== Direct edit tool and shortcuts
267267

268-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
268+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
269269

270270
The {product} supports a subset of the {sysmlv2} textual syntax, which allows you to update several elements simultaneously.
271271
This makes it more efficient to edit models.

doc/content/modules/user-manual/pages/hands-on/how-tos/project-management.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[#create-blank-project]
44
== Create a blank project
55

6-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
6+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
77

88
To create a new Blank project, user has to click on _Blank project_ card at the top of the homepage.
99

@@ -22,7 +22,7 @@ Refer to the xref:features/editor.adoc[{editor} page] to understand how to use i
2222
[#create-template-project]
2323
== Create a project based on a template
2424

25-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
25+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
2626

2727
To create a new project from a `Template`:
2828

@@ -57,7 +57,7 @@ Refer to the xref:features/editor.adoc[{editor} page] to understand how to use i
5757
[#upload-project]
5858
== Upload a Project
5959

60-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
60+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
6161

6262
[NOTE]
6363
====
@@ -84,7 +84,7 @@ Refer to the xref:features/editor.adoc[{editor} page] to understand how to use i
8484
[#delete-project]
8585
== Delete a project
8686

87-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
87+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
8888

8989
It's possible to delete a project either from the {homepage} or the {editor}.
9090

@@ -121,7 +121,7 @@ image::hands-on-delete-project-editor.png[Delete Project from editor]
121121
[#rename-project]
122122
== Rename a project
123123

124-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
124+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
125125

126126
It's possible to rename a project either from the {homepage} or the {editor}.
127127

@@ -162,7 +162,7 @@ image::hands-on-rename-project-editor.png[Rename Project from editor]
162162
[#download-project]
163163
== Download a project
164164

165-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
165+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
166166

167167
It's possible to download a project either from the {homepage} or the {editor}.
168168

@@ -193,7 +193,7 @@ image::hands-on-download-project-editor.png[Download Project from editor]
193193
[#share-project]
194194
== Share a project
195195

196-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
196+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
197197

198198
Sharing a project is as straightforward as providing the project URL to someone because everything within {product} is public.
199199
Once the project URL is shared, the recipient can access and view the project directly.
@@ -202,7 +202,7 @@ This simplicity in sharing allows for seamless collaboration and communication o
202202
[#project-settings]
203203
== Manage project settings
204204

205-
include::user-manual:partial$before-you-start-os-experimental-all.adoc[]
205+
include::user-manual:partial$before-you-start-experimental-all.adoc[]
206206

207207
The purpose of this page is to present the various settings manageable by the administrator of a project.
208208
Currently, capabilities are limited to functions such as uploading images, but additional features for project management will be introduced in future updates.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.Before you Start
2+
[caption=]
3+
====
4+
// Status
5+
include::user-manual:partial$feature-status-experimental.adoc[]
6+
7+
// Usage
8+
include::user-manual:partial$feature-usage-all.adoc[]
9+
====

0 commit comments

Comments
 (0)