Skip to content
Snippets Groups Projects

Task 4006 online help content

Merged Task 4006 online help content
task_4006-Online_help_content_ into master
Merged Saad bin Abid requested to merge task_4006-Online_help_content_ into master
Compare
and
Show latest version
2 files
+ 55
− 22
Compare changes
  • Side-by-side
  • Inline
Files
2
org.fortiss.af3.rcp.help/html/requirements/MIRA.glossary.html 0 → 100644
+ 168
− 0
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- Documentation of MIRA - Model-based Integrated Requirements Analysis. -->
<html>
<head>
<link rel="stylesheet" type="text/css" href="../layout/stylesheet.css"/>
<title>Creating a Glossary</title>
</head>
<body>
<div class="header">
<div class="box">
<div class="navbar">
<div class="dropdown">
<a href="../getting_started.html" style="padding:0;">
<button class="btn" id="hamburger" onclick="javascript:window.location.href='../getting_started.html'">
<label for="hamburger" class="hamburger">
<span class="hamburgerLine"></span>
<span class="hamburgerLine"></span>
<span class="hamburgerLine"></span>
</label>
</button>
</a>
<div class="dropdown-content">
<button class="dropdown-btn">Getting Started<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href=".././managing_projects.html"> Create, Import, Export and Load AF3-Projects</a>
<a href=".././tipsAndTricks.html">Tips & Tricks</a>
<a href=".././af3_faq.html">FAQs</a>
</div>
<button class="dropdown-btn">Requirements Engineering<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="MIRA.requirements_analysis.html"> Requirements Analysis Node</a>
<a style="background-color:#f2f2f2;">Glossary</a>
<a href="MIRA.requirements.html">Requirements</a>
</div>
<button class="dropdown-btn">Modeling and Simulation<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../ModandSim/model_element_attributes.html">Introduction to Graphical Modeling Interface</a>
<a href="../ModandSim/component_architecture.html">Component Architecture Modeling</a>
<a href="../ModandSim/data_dictionary.html">Data Dictionary: Types and Functions</a>
<a href="../ModandSim/refactoring.html">Refactoring</a>
<a href="../ModandSim/model_markers_view.html">On-the-fly Checks</a>
<button class="dropdown-btn">Behavior Modeling<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../ModandSim/code_specification.html">Code Specification</a>
<a href="../ModandSim/state_automaton.html">State Automata</a>
<a href="../ModandSim/hierarchical_state_automaton.html">Hierarchical State Automata</a>
<a href="../ModandSim/mode_automaton.html"> Mode Automata</a>
</div>
<button class="dropdown-btn">Simulation<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../ModandSim/simulation_with_af3.html">Simulation</a>
<a href="../ModandSim/operatorpanels.html">Operator Panels</a>
<a href="../ModandSim/operatorpanels_advanced.html">Advanced Operator Panels</a>
<a href="../ModandSim/cosimulation_with_af3.html"> Co-Simulation and FMI Support</a>
</div>
</div>
<button class="dropdown-btn">Deployment and Code Generation<i class="caret-down"></i></button>
<div class="dropdown-container">
<button class="dropdown-btn">Modeling Technical Architectures<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../ta/platform_architecture.html">Platform Architecture</a>
<button class="dropdown-btn">Supported Platform Architectures<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../ta/platform_architecture_generic.html">Generic Platform Architecture</a>
<a href="../ta/platform_architecture_hierarchical.html">Hierarchical Platform Architecture</a>
<a href="../ta/platform_architecture_raspberrypi.html">RaspberryPi Platform Architecture</a>
</div>
<a href="../ta/task_architecture.html">Task Architecture</a>
<a href="../ta/partition_architecture.html"> Partition Architecture</a>
<a href="../ta/allocations.html"> Deployments/Allocations</a>
<a href="../ta/system_schedule.html"> System Schedule</a>
</div>
<a href="../ta/code_generation.html">Code Generation</a>
</div>
<button class="dropdown-btn">Design Space Exploration (DSE)<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../dse/dse_perspective.html">DSE Perspective Overview</a>
<a href="../dse/dse_dashboard.html">DSE Dashboard</a>
<a href="../dse/constraints.html">Constraint Modeling</a>
<a href="../dse/objectives.html">Objective Modeling</a>
<a href="../dse/deployment_synthesis.html">Deployment Synthesis</a>
<a href="../dse/schedule_synthesis.html">Schedule Synthesis</a>
<a href="../dse/visualization.html">Solution Visualization</a>
</div>
<button class="dropdown-btn">Assurance Case Modeling<i class="caret-down"></i></button>
<div class="dropdown-container">
<a href="../assuranceCases/creation.html">Modeling GSN-based Assurance Cases</a>
<a href="../assuranceCases/assessment.html">Quantitative Assessment of Assurance Cases</a>
<a href="../assuranceCases/maintenance.html">Change Impact Analysis</a>
</div>
<a href=".././furtherResources.MainPage.html">Further Resources</a>
</div>
</div>
<div class="topnav-right">
<a href="mailto:af_user@lists.fortiss.org?subject=Reporting 'MIRA.Glossary.html' Documentation Problem!&body= Dear AutoFOCUS3 team, I am reporting an issue related to Glossary Creation Page.
{Please specify the problem precisely here.}.">Report a Problem?</a>
</div>
</div>
</div>
</div>
<div class="box">
<button onclick="topFunction()" id="upBtn" title="Go to top">Top</button>
<h1>Creating a Glossary</h1>
<p> A glossary is used to capture the vocabulary of the problem domain. Once created, the glossary is automatically linked to the requirements.
Using the glossary it is easily visible whether the agreed vocabulary is used in all descriptions.
To create a new glossary, select <i>Glossary</i> in the context menu of a requirements analysis.</p>
<img src="./pictures/MIRA.Glossary.NewGlossary.png" height="auto" align="center"/>
<p>You can create multiple glossary nodes with specific names (set in the properties view) to group your glossary terms.</p>
<h2>Creating Glossary Entries</h2>
<p> In the context menu of the glossary node you can then create glossary entries by clicking <i>Entry</i>. </p>
<img src="./pictures/MIRA.Glossary.NewEntry.png" height="auto" align="center"/>
<h1>Glossary Overview</h1>
<p> By double-clicking on the <i>Glossary</i> node, an overview over all glossary entries opens. </p>
<img class="center" src="./pictures/MIRA.GlossaryOverview.png" width="auto" align="center"/>
<p> The list of glossary entries can be sorted by clicking on the column headers of the overview list.
You can filter the glossary entries by inserting filter text in the filter section. Double-clicking on a column opens the corresponding glossary entry. </p>
<h1>Specifying Glossary Entries</h1>
<p>For each entry you should at least specify the <i>name</i> (the vocabulary term it represents). In the <i>definition</i> field you should enter what this term means in your problem domain. An entry also has a <i>status</i> field (Options: New, In consolidation, Consolidated) which can be used to consolidate it with others.
Furthermore you can specify <i>abbreviations</i> and <i>synonyms</i> for the entry and add a comment.
In <i>names</i>, <i>abbreviations</i> and <i>synonyms</i> only the special characters <tt><b>"-_/&rsquo;()"</b></tt>are allowed.</p>
<img src="./pictures/MIRA.Glossary.GlossaryEntry.png" align="center"/>
<p>For further description of the entry you can add pictures. To add a picture click on the <i>Add</i> button and choose an image file in the dialog.
You can add as many pictures as you want.
Each image has a description field which can be used to give information about the picture and to number the pictures.
If you click on an added picture, it should be displayed in full resolution in your systems picture viewer. <br/>
When you add a picture it is copied into the <i>Images</i> folder in the project directory, next to your <tt>.af3_20</tt> file.
If you want to send the model file to someone else, you should also send the <i>Images</i> folder. </p>
</div>
<script src="../layout/jsscript/topBtn.js"></script>
<script src="../layout/jsscript/submenuScript.js"></script>
<div class="footer">
<p>
&copy; 2020 <a href="https://www.fortiss.org/">fortiss GmbH</a> &nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://www.fortiss.org/en/publications/software/autofocus-3#c2007">Contact</a>&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://www.fortiss.org/en/imprint">Imprint</a>
</p>
</div>
</body>
</html>
\ No newline at end of file