Skip to content
Snippets Groups Projects
Commit ca1559f2 authored by Saad bin Abid's avatar Saad bin Abid
Browse files

added fonts folder and newly worked glossary, requirements_analysis and 

requirements html files. newly added files are for demo only purposes.

<Sub-system>: <Summary>

*

Issue-Ref: 4006
Issue-Url: https://af3-developer.fortiss.org/issues/4006



Signed-off-by: default avatarsaadbinabid1 <abid@fortiss.org>
parent de86d656
No related branches found
No related tags found
1 merge request!31Task 4006 online help content
Hide whitespace changes
Inline Side-by-side
Showing
with 492 additions and 1 deletion
org.fortiss.af3.rcp.help/html/requirements/MIRA.glossary.html
+ 1
− 1
View file @ ca1559f2
......@@ -49,7 +49,7 @@ For each entry you should at least specify the <i>name</i> (the vocabulary term
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 "-_/&rsquo;()" are allowed.
In <i>names</i>, <i>abbreviations</i> and <i>synonyms</i> only the special characters (might use text style type writter)"-_/&rsquo;()" are allowed.
<br><br>
<img src="./pictures/MIRA.Glossary.GlossaryEntry.png">
<br><br>
......
org.fortiss.af3.rcp.help/html/requirements/MIRA.glossary1.html 0 → 100644
+ 103
− 0
View file @ ca1559f2
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of MIRA - Model-based Integrated Requirements Analysis.
@author becker
@ConQAT.Rating GREEN Hash: 850E39092E4DF6F9EEB6D26D886BEF68
-->
<html>
<head>
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<style>
* {
margin: 0;
padding: 0;
}
.imgbox {
display: grid;
height: 100%;
}
.center-fit {
max-width: 100%;
max-height: 100vh;
margin: auto;
}
</style>
</head>
<div class="navbar">
<a href="../getting_started.html">Home</a>
<div class="dropdown">
<button class="dropbtn">Requirements Engineering <i class="fa fa-caret-down"></i></button>
<div class="dropdown-content">
<a href="MIRA.requirements_analysis1.html">Requirements Analysis</a>
<a href="MIRA.requirements1.html">Requirements Creation</a>
</div>
</div>
<div class="topnav-right">
<div class="dropdown">
<button class="dropbtn">Report a Problem?<i class="fa fa-caret-down"></i></button>
<div class="dropdown-content">
<a href="mailto:af_user@lists.fortiss.org">Figure Error</a>
<a href="mailto:af_user@lists.fortiss.org">Documentation Error</a>
</div>
</div>
</div>
</div>
</div>
</div>
</head>
<body>
<h2>Creating a Glossary</h2>
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.
<br><br>
To create a new glossary, select <i>Glossary</i> in the context menu of a requirements analysis.
<br><br>
<img src="./pictures/MIRA.Glossary.NewGlossary.png">
<br><br>
<br><br>
You can create multiple glossary nodes with specific names (set in the properties view) to group your glossary terms.
<h3>Creating Glossary Entries</h3>
In the context menu of the glossary node you can then create glossary entries by clicking <i>Entry</i>.
<br><br>
<img src="./pictures/MIRA.Glossary.NewEntry.png">
<h2>Glossary Overview</h2>
By double-clicking on the <i>Glossary</i> node, an overview over all glossary entries opens.
<br><br>
<img src="./pictures/MIRA.GlossaryOverview.png">
<br><br>
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.
<h2>Specifying Glossary Entries</h2>
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 <div class="typewriter"><b>"-_/&rsquo;()"</b></div> are allowed.
<br><br>
<img src="./pictures/MIRA.Glossary.GlossaryEntry.png">
<br><br>
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 .af3_20 file.
If you want to send the model file to someone else, you should also send the <i>Images</i> folder.
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/requirements/MIRA.requirements1.html 0 → 100644
+ 84
− 0
View file @ ca1559f2
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head><link rel="stylesheet" type="text/css" href="stylesheet.css">
<style>
@media screen and (max-width: 600px) {
.topnav a:not(:first-child), .dropdown .dropbtn {
display: none;
}
.topnav a.icon {
float: right;
display: block;
}
}
@media screen and (max-width: 600px) {
.topnav.responsive {position: relative;}
.topnav.responsive .icon {
position: absolute;
right: 0;
top: 0;
}
}
</style>
</head>
<body>
<div class="navbar">
<a href="../getting_started.html">Home</a>
<div class="dropdown">
<button class="dropbtn">Requirements Engineering <i class="fa fa-caret-down"></i></button>
<div class="dropdown-content">
<a href="MIRA.requirements_analysis1.html">Requirements Analysis</a>
<a href="MIRA.glossary1.html">Glossary Creation</a>
</div>
</div>
<div class="topnav-right">
<div class="dropdown">
<button class="dropbtn">Report a Problem? <i class="fa fa-caret-down"></i></button>
<div class="dropdown-content">
<a href="mailto:af_user@lists.fortiss.org">Figure Error</a>
<a href="mailto:af_user@lists.fortiss.org">Documentation Error</a>
</div>
</div>
</div>
</div>
</div>
</div>
<body>
<h2>Create a Requirements Node</h2>
<p>Before creating <i>Requirements</i>, you have to create a <a href="MIRA.requirements_analysis1.html" target="_blank">Requirements Analysis</a> node.<br />
<br />
Create a new <i>Requirements</i> node by choosing <i>Requirements</i>, in the context menu of the <i>Requirements Analysis</i> node.<br />
<br />
<img src="./pictures/MIRA.Requirements.NewRequirements.png" height: auto; /><br />
<br />
<br />
<br />
Change the name of a <i>Requirements</i> node in the properties view. You also can create multiple requirement nodes with different names to organize your requirements.</p>
<h2>Requirements Overview</h2>
<p>By double-clicking on the <i>Requirements</i> node, an overview over all requirements opens.<br />
<br />
<img src="./pictures/MIRA.RequirementsOverview.png" height: auto;/><br />
<br />
The list of requirements can be sorted by clicking on the column headers of the overview list. You can filter the requirements by inserting a filter text in the filter section. Double-clicking on a column opens the corresponding requirement source element.</p>
<h2>Requirements Packages</h2>
<p>Requirements are structured by <i>Requirements Packages</i>.<br />
<br />
<img src="./pictures/MIRA.Requirements.Packages.png" height: auto; /></p>
<h2>Specify Requirements</h2>
<p>To add a new requirement, open the context menu of the requirements node. You can choose between the following requirement types:</p>
<p><img src="./pictures/MIRA.Requirements.NewRequirement.png" height: auto;/><br />
</body>
</html>
org.fortiss.af3.rcp.help/html/requirements/MIRA.requirements_analysis1.html 0 → 100644
+ 74
− 0
View file @ ca1559f2
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<style>
@media screen and (max-width: 600px) {
.topnav a:not(:first-child), .dropdown .dropbtn {
display: none;
}
.topnav a.icon {
float: right;
display: block;
}
}
@media screen and (max-width: 600px) {
.topnav.responsive {position: relative;}
.topnav.responsive .icon {
position: absolute;
right: 0;
top: 0;
}
}
</style>
</head>
<body>
<div class="navbar">
<a href="../getting_started.html">Home</a>
<div class="dropdown">
<button class="dropbtn">Requirements Engineering <i class="fa fa-caret-down"></i></button>
<div class="dropdown-content">
<a href="MIRA.requirements1.html">Requirements Creation</a>
<a href="MIRA.glossary1.html">Glossary Creation</a>
</div>
</div>
<div class="topnav-right">
<div class="dropdown">
<button class="dropbtn">Report a Problem? <i class="fa fa-caret-down"></i></button>
<div class="dropdown-content">
<a href="mailto:af_user@lists.fortiss.org">Figure Error</a>
<a href="mailto:af_user@lists.fortiss.org">Documentation Error</a>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="main">
<h2>Create a Requirements Analysis Node</h2>
To create a new <i>Requirements Analysis Node</i> in project, open the context menu of the project by right-clicking on the project and select <i>Requirements Analysis</i>.
<br><br>
<img src="./pictures/MIRA.NewAnalysis.png" height: auto;>
<br><br>
In the same way, you can add more requirements analysis nodes to your project.
<h2>Requirements Overview</h2>
By double-clicking on the <i>Requirements Analysis</i> node, an overview over all requirements opens.
<br><br>
<img src="./pictures/MIRA.RequirementsOverview.png" height: auto;>
<br><br>
The list of requirements can be sorted by clicking on the column headers of the overview list.
You can filter the requirements by inserting filter text in the filter section. Double-clicking on a requirement opens the corresponding requirement.
</div>
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_100.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_100_Italic.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_300.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_300_Italic.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_500.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_500_Italic.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_700.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_700_Italic.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_900.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/fonts/MuseoSans_900_Italic.otf 0 → 100644
+ 0
− 0
View file @ ca1559f2
File added
org.fortiss.af3.rcp.help/html/requirements/stylesheet.css 0 → 100644
+ 230
− 0
View file @ ca1559f2
body {
padding: 0;
margin: 0 auto;
background-color: #fff;
color: #192846;
font-size: 100%;
font-weight: 500;
text-align: center;
font-family: 'testfont';
}
@font-face {
font-family: testfont;
src: url("fonts/MuseoSans_500.otf");
}
.navbar {
overflow: hidden;
background-color:#004ea8;
}
.navbar a {
float: left;
font-size: 16px;
color: white;
text-align: center;
padding: 14px 16px;
text-decoration: none;
}
.subnav {
float: left;
overflow: hidden;
}
.subnav .subnavbtn {
font-size: 16px;
border: none;
outline: none;
color: none;
padding: 14px 16px;
background-color: none;
font-family: inherit;
margin: 0;
}
.topnav-right {
float: right;
}
.navbar a:hover, .subnav:hover .subnavbtn {
background-color: none;
}
.subnav-content {
display: none;
position: absolute;
left: 0;
background-color: none;
width: 100%;
z-index: 1;
}
.subnav-content a {
float: left;
color: black;
text-decoration: none;
}
.subnav-content a:hover {
background-color: green;
color: black;
position:relative;
}
.subnav:hover .subnav-content {
display: block;
}
/*======================================================================================*/
/* Content formats
/*======================================================================================*/
/* Headlines */
h1 {
color: #192846;
font-size: 2.8rem;
font-weight: 500;
line-height: 120%;
margin: 0 0 40px 0; }
h2 {
color: #192846;
font-size: 2.4rem;
font-weight: 500;
line-height: 120%;
margin: 0 0 20px 0; }
h3 {
color: #192846;
font-size: 1.6rem;
font-weight: 500;
line-height: 120%;
margin: 0 0 15px 0; }
h4 {
color: #ffcd00;
font-size: 1.2rem;
font-weight: 500;
line-height: 120%;
margin: 0 0 10px 0; }
.topnav {
overflow: hidden;
background-color: #333;
}
.topnav a {
float: left;
display: block;
color: #f2f2f2;
text-align: center;
padding: 14px 16px;
text-decoration: none;
font-size: 17px;
}
.active {
background-color: #4CAF50;
color: white;
}
.topnav .icon {
display: none;
}
.dropdown {
float: left;
overflow: hidden;
}
.dropdown .dropbtn {
font-size: 17px;
border: none;
outline: none;
color: black;
padding: 14px 16px;
background-color: inherit;
font-family: inherit;
margin: 0;
}
.dropdown-content {
display: none;
position: absolute;
background-color: #f9f9f9;
min-width: 160px;
box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);
z-index: 1;
}
.dropdown-content a {
float: none;
color: black;
padding: 12px 16px;
text-decoration: none;
display: block;
text-align: left;
}
.topnav a:hover, .dropdown:hover .dropbtn {
background-color: #555;
color: white;
}
.dropdown-content a:hover {
background-color: #ddd;
color: black;
}
.dropdown:hover .dropdown-content {
display: block;
}
.topnav.responsive a {
float: none;
display: block;
text-align: left;
}
.topnav.responsive .dropdown {float: none;}
.topnav.responsive .dropdown-content {position: relative;}
.topnav.responsive .dropdown .dropbtn {
display: block;
width: 100%;
text-align: left;
}
.topnav-right {
float: right;
}
.img {
max-width:100%;
height:auto;
max-height:100%;
}
/* Hyperlinks */
a{
transition: all ease 0.15s;
}
a:hover {
color: lightblue;
}
a:active {
text-decoration: underline;
}
/* keyboard/programming letters type */
/* This text is in Lucida Sans Typewriter */
.program {
font-family: Lucida Sans Typewriter,Lucida Console,monaco,Bitstream Vera Sans Mono,monospace;
}
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment