Add keywords tutorial page.

Signed-off-by: Diego Araújo <diegoamc90@gmail.com>

Add keywords tutorial page.
Signed-off-by: Diego Araújo <diegoamc90@gmail.com>
Daniel · Diego Camarinha
1 parent d91d8847
Showing 2 changed files with 23 additions and 0 deletions Show diff stats
app/assets/stylesheets/keywords.css
app/views/tutorials/keywords.html.erb
@@ -0,0 +1,3 @@
+.keyword-explanation {
+  padding-bottom: 20px;
+}
@@ -0,0 +1,20 @@
+<h1>Keywords</h1>
+
+<hr />
+
+<h3 id="module">Module</h3>
+
+<p class="keyword-explanation">Represents a fragment of the software. Every node in the processing tree generated by the Kalibro processor is a module. It can be a software package, file or the whole software.</p>
+
+<h3 id="range">Range</h3>
+
+<p class="keyword-explanation">Represents numerical intervals that may contain the value calculated for a given metric. Ranges combined with readings provide interpretations for metric results.</p>
+
+<h3 id="reading">Reading</h3>
+
+<p class="keyword-explanation">The interpretation given to a metric result (e.g., "Good", "Complex", "A"). Readings combined with ranges provide interpretations for metric results.</p>
+
+<h3 id="reading-group">Reading Group</h3>
+
+<p class="keyword-explanation">A set of readings that make sense when grouped together (e.g., "Good" and "Bad", "Simple" and "Complex").</p>
+
...	...	@@ -0,0 +1,3 @@
	1	+.keyword-explanation {
	2	+ padding-bottom: 20px;
	3	+}
...	...
...	...	@@ -0,0 +1,20 @@
	1	+<h1>Keywords</h1>
	2	+
	3	+<hr />
	4	+
	5	+<h3 id="module">Module</h3>
	6	+
	7	+<p class="keyword-explanation">Represents a fragment of the software. Every node in the processing tree generated by the Kalibro processor is a module. It can be a software package, file or the whole software.</p>
	8	+
	9	+<h3 id="range">Range</h3>
	10	+
	11	+<p class="keyword-explanation">Represents numerical intervals that may contain the value calculated for a given metric. Ranges combined with readings provide interpretations for metric results.</p>
	12	+
	13	+<h3 id="reading">Reading</h3>
	14	+
	15	+<p class="keyword-explanation">The interpretation given to a metric result (e.g., "Good", "Complex", "A"). Readings combined with ranges provide interpretations for metric results.</p>
	16	+
	17	+<h3 id="reading-group">Reading Group</h3>
	18	+
	19	+<p class="keyword-explanation">A set of readings that make sense when grouped together (e.g., "Good" and "Bad", "Simple" and "Complex").</p>
	20	+
...	...