Skip to content

Commit

Permalink
#2687 Remove Requirement from documentation
Browse files Browse the repository at this point in the history 
Change-Id: Ibb0552c73d3dc74a43d7d052e2d6d2d66de14afd
Signed-off-by: Erwann Traisnel <erwann.traisnel@obeo.fr>
  • Loading branch information
@etraisnel2 @pdulth
etraisnel2 authored and pdulth committed Oct 2, 2023
1 parent 4b2b3bb commit 693a2c6
Show file tree
Hide file tree
Showing 14 changed files with 0 additions and 172 deletions.
2 changes: 0 additions & 2 deletions doc/plugins/org.polarsys.capella.glossary.doc/.settings/org.eclipse.core.resources.prefs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,6 @@ encoding//html/Glossary/75.\ Reference-toc.xml=utf-8
encoding//html/Glossary/75.\ Reference.html=UTF-8
encoding//html/Glossary/76.\ Region-toc.xml=utf-8
encoding//html/Glossary/76.\ Region.html=UTF-8
encoding//html/Glossary/77.\ Requirement-toc.xml=utf-8
encoding//html/Glossary/77.\ Requirement.html=UTF-8
encoding//html/Glossary/78.\ Role-toc.xml=utf-8
encoding//html/Glossary/78.\ Role.html=UTF-8
encoding//html/Glossary/79.\ Scenario-toc.xml=utf-8
Expand Down
7 changes: 0 additions & 7 deletions doc/plugins/org.polarsys.capella.glossary.doc/html/Glossary/77. Requirement-toc.xml
View file

This file was deleted.

30 changes: 0 additions & 30 deletions doc/plugins/org.polarsys.capella.glossary.doc/html/Glossary/77. Requirement.html
View file

This file was deleted.

22 changes: 0 additions & 22 deletions ...ugins/org.polarsys.capella.glossary.doc/html/Glossary/77. Requirement.mediawiki
View file

This file was deleted.

4 changes: 0 additions & 4 deletions doc/plugins/org.polarsys.capella.glossary.doc/toc.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -310,10 +310,6 @@
<topic href="html/Glossary/76. Region.html#DEFINITION" label="DEFINITION"></topic>
<topic href="html/Glossary/76. Region.html#ICONS" label="ICONS"></topic>
</topic>
<topic href="html/Glossary/77. Requirement.html" label="REQUIREMENT">
<topic href="html/Glossary/77. Requirement.html#DEFINITION" label="DEFINITION"></topic>
<topic href="html/Glossary/77. Requirement.html#ICONS" label="ICONS"></topic>
</topic>
<topic href="html/Glossary/78. Role.html" label="ROLE">
<topic href="html/Glossary/78. Role.html#DEFINITION" label="DEFINITION"></topic>
<topic href="html/Glossary/78. Role.html#ICONS" label="ICONS"></topic>
Expand Down
23 changes: 0 additions & 23 deletions ...sys.capella.ui.doc/html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,6 @@
</head>
<body>
<h1 id="Wizards">Wizards</h1>
<h2 id="Requirement_Manager">Requirement Manager</h2>
<p>
<br/>

<br/>
</p>
<p>
<b>Capella offers lightweight requirement management capabilities</b>. Allocation is performed through matrices or using the dedicated wizard. On any element, using the contextual menu, select the Requirements Manager as shown below to open the requirement allocation dialog.
</p>
<p>
<img height="550" width="600" border="0" src="Images/7.3_Wizard_Requirement_Manager.png"/>
</p>
<p>A double pane dialog appears, proposing all requirements.</p>
<p>
<img height="482" width="715" border="0" src="Images/7.3.%20Modeling%20Wizards_html_m1460320e.png"/>
</p>
<p>In this panel, the user can allocate requirements on selected element of the model. The result of the allocation can be seen in a dedicated matrice matrix or in the Semantic Browser.</p>
<p>
<img height="378" width="1040" border="0" src="Images/7.3.%20Modeling%20Wizards_html_7cc837b4.png"/>
</p>
<p>Note that this requirement allocation capability can be used for requirements in successive engineering phases,
<b>allowing refinement of requirements</b>.
</p>
<h2 id="Generic_Traceability_Wizard">Generic Traceability Wizard</h2>
<p>Capella offers a lot of semantic justification means from one engineering phase to another (realization of Functions, Exchanges, Components, etc.). In addition,
<b>a generic traceability capability is also provided.</b>
Expand Down
26 changes: 0 additions & 26 deletions ...doc/html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.mediawiki
View file
Original file line number Diff line number Diff line change
@@ -1,32 +1,6 @@

= Wizards =

== Requirement Manager ==

<br>
<br>

'''Capella offers lightweight requirement management capabilities'''. Allocation is performed through matrices or using the dedicated wizard. On any element, using the contextual menu, select the Requirements Manager as shown below to open the requirement allocation dialog.


[[Image:Images/7.3_Wizard_Requirement_Manager.png|600x550px]]


A double pane dialog appears, proposing all requirements.


[[Image:Images/7.3.%20Modeling%20Wizards_html_m1460320e.png|715x482px]]


In this panel, the user can allocate requirements on selected element of the model. The result of the allocation can be seen in a dedicated matrice matrix or in the Semantic Browser.


[[Image:Images/7.3.%20Modeling%20Wizards_html_7cc837b4.png|1040x378px]]


Note that this requirement allocation capability can be used for requirements in successive engineering phases, '''allowing refinement of requirements'''.


== Generic Traceability Wizard ==

Capella offers a lot of semantic justification means from one engineering phase to another (realization of Functions, Exchanges, Components, etc.). In addition, '''a generic traceability capability is also provided.''' '''Such traceability links can be used to''' '''link elements with additional relationships that are not available in Capella'''. Such traceability relies on the concept of '''Generic Traces'''. A dedicated wizard helps creating such Traces, although Capella does not further exploit them.
Expand Down
1 change: 0 additions & 1 deletion ...lugins/org.polarsys.capella.ui.doc/html/12. Model Analysis/12.4. Progress Monitoring.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ <h3 id="Propagate_Progress_Status_to_only_Business_Elements">Propagate Progress
<li>PhysicalPath</li>
<li>PhysicalLink</li>
<li>Region</li>
<li>Requirement</li>
<li>Role</li>
<li>Scenario</li>
<li>StateMachine</li>
Expand Down
1 change: 0 additions & 1 deletion ...rsys.capella.ui.doc/html/12. Model Analysis/12.4. Progress Monitoring.mediawiki
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ Only following model elements are taken into account:
* PhysicalPath
* PhysicalLink
* Region
* Requirement
* Role
* Scenario
* StateMachine
Expand Down
21 changes: 0 additions & 21 deletions ...plugins/org.polarsys.capella.ui.doc/html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,27 +186,6 @@ <h2 id="Searching_Strings">Searching Strings</h2>
</td>
</tr>
</table>
<h2 id="Requirements">Requirements</h2>
<table cellpadding="7">
<tr>
<td>
<b>Description</b>
</td>
<td>
<b>Workbench Selection</b>
</td>
<td>
<b>Syntax</b>
</td>
</tr>
<tr>
<td>Query to retrieve the list of non-allocated requirements</td>
<td>Requirement Package</td>
<td>aql:self.
<b>eAllContents()-&gt;select(x &#124; x.getRelatedCapellaElements()-&gt;isEmpty())</b>
</td>
</tr>
</table>
<h2 id="Model_Navigation_Examples">Model Navigation Examples</h2>
<table cellpadding="7">
<tr>
Expand Down
12 changes: 0 additions & 12 deletions ...arsys.capella.ui.doc/html/12. Model Analysis/12.5.2 Acceleo 2 Queries.mediawiki
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,18 +125,6 @@
| aql: self.getAllDAnalysis().ownedViews.ownedRepresentationDescriptors.'''representation->select(x &#124; x.eInverse('element')->filter(notation::Diagram).eAllContents(notation::Node)->select(x &#124; x.type = 'Note' and x.description.contains('TODO')))->size()'''
|}
== Requirements ==
{| cellpadding="7"
|-
| '''Description'''
| '''Workbench Selection'''
| '''Syntax'''
|-
| Query to retrieve the list of non-allocated requirements
| Requirement Package
| aql:self.'''eAllContents()->select(x &#124; x.getRelatedCapellaElements()->isEmpty())'''
|}
== Model Navigation Examples ==
{| cellpadding="7"
|-
Expand Down
2 changes: 0 additions & 2 deletions doc/plugins/org.polarsys.capella.ui.doc/toc.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,6 @@
<topic href="html/07. Modelling Wizards and Accelerators/7.2. Contextual Allocations.html#Example:_Allocation_of_Activities_and_Functions_to_Entities.2C_Actors.2C_Components" label="Example: Allocation of Activities and Functions to Entities, Actors, Components"></topic>
</topic>
<topic href="html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.html" label="Wizards">
<topic href="html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.html#Requirement_Manager" label="Requirement Manager"></topic>
<topic href="html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.html#Generic_Traceability_Wizard" label="Generic Traceability Wizard"></topic>
<topic href="html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.html#Logical_Component_Breakdown_Decomposition_Wizard" label="Logical Component Breakdown Decomposition Wizard">
<topic href="html/07. Modelling Wizards and Accelerators/7.3. Modeling Wizards.html#Use_case" label="Use case"></topic>
Expand Down Expand Up @@ -332,7 +331,6 @@
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Basic_Model_Queries" label="Basic Model Queries"></topic>
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Diagram_Queries" label="Diagram Queries"></topic>
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Searching_Strings" label="Searching Strings"></topic>
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Requirements" label="Requirements"></topic>
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Model_Navigation_Examples" label="Model Navigation Examples"></topic>
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Metrics" label="Metrics"></topic>
<topic href="html/12. Model Analysis/12.5.2 Acceleo 2 Queries.html#Advanced_Queries" label="Advanced Queries"></topic>
Expand Down
14 changes: 0 additions & 14 deletions .../org.polarsys.capella.validation.doc/html/Validation Rules/integrity/ValidationRules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,6 @@ <h1 id="Integrity">Integrity</h1>
<p>
<br/>
</p>
<table class="VALIDATION-RULE">
<tr>
<th>
<img title="ERROR" alt="ERROR" border="0" src="../../Images/error.gif"/>
</th>
<td>I_11 - Requirement ID check </td>
</tr>
<tr>
<td colspan="2">This rule checks that all Requirements have a unique ID attribute.</td>
</tr>
</table>
<p>
<br/>
</p>
<table class="VALIDATION-RULE">
<tr>
<th>
Expand Down
7 changes: 0 additions & 7 deletions ...apella.validation.doc/html/Validation Rules/integrity/ValidationRules.mediawiki
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,6 @@ Two exchange items that share a common container have conflicting names if both
<br>
{| class="VALIDATION-RULE"
!|[[Image:../../Images/error.gif|ERROR]]
|I_11 - Requirement ID check
|-
| colspan="2"|This rule checks that all Requirements have a unique ID attribute.
|}
<br>
{| class="VALIDATION-RULE"
!|[[Image:../../Images/error.gif|ERROR]]
|I_12 - Function Realization
|-
| colspan="2"|This test checks the realization consistency between functions.
Expand Down

0 comments on commit 693a2c6

Please sign in to comment.