[WIP] Working on tooltips and keywords

Signed off by: Heitor Reis <marcheing@gmail.com>

[WIP] Working on tooltips and keywords
Signed off by: Heitor Reis <marcheing@gmail.com>
Alessandro Palmeira · Diego Camarinha
1 parent 840c905c
Showing 4 changed files with 30 additions and 24 deletions Show diff stats
app/assets/stylesheets/form_with_tooltip.css
app/views/metric_configurations/_form.html.erb
app/views/mezuro_configurations/_form.html.erb
app/views/tutorials/keywords.html.erb
@@ -16,7 +16,7 @@
 .field-container {
   position: relative;
   float: left;
-  width: 653px;
+  width: 100%;
   padding: 20px;
 }
@@ -10,7 +10,7 @@
       </div>
       <div class="help-container">
         <p>
-          The Weight of a metric is used to calculate the weighted average of a <%= link_to 'module',  tutorials_path("keywords", anchor: "module")%>.
+          It is used to calculate the weighted average of a <%= link_to 'module',  tutorials_path("keywords", anchor: "module")%>.
         </p>
       </div>
     </div>
@@ -22,7 +22,7 @@
       </div>
       <div class="help-container">
         <p>
-          It is the calculation of statistical results for higher <%= link_to 'granularity', tutorials_path('keywords', anchor: 'granularity') %> modules (e.g., average lines of code of classes inside a package).
+          It is the calculation of statistical results for higher <%= link_to 'granularity', tutorials_path('keywords', anchor: 'granularity') %> modules (e.g., average lines of code of the classes inside a package).
         </p>
       </div>
     </div>
@@ -9,11 +9,6 @@
         <%= f.label :name, class: 'control-label' %><br>
         <%= f.text_field :name, class: 'text-field' %>
       </div>
-      <div class="help-container">
-        <p>
-          The name of your Configuration.
-        </p>
-      </div>
     </div>
     <div class="form-row">
@@ -21,11 +16,6 @@
         <%= f.label :description, class: 'control-label' %><br>
         <%= f.text_area :description, class: 'text-area' %>
       </div>
-      <div class="help-container">
-        <p>
-          A short description of your Configuration.
-        </p>
-      </div>
     </div>
   </div>
@@ -7,36 +7,52 @@
   <div>
     <h3 id="granularity">Granularity</h3>
-    <p>Mezuro uses four levels of granularity:</p>
-      <ul>
-        <li>Method</li>
-        <li>Class</li>
-        <li>Package</li>
-        <li>Software</li>
-      </ul>
+    <p>Represents the granularity level of the code fragment being measured. Mezuro uses four levels of granularity:</p>
+    <ul>
+      <li>Method</li>
+      <li>Class</li>
+      <li>Package</li>
+      <li>Software</li>
+    </ul>
   </div>
   <div>
     <h3 id="module">Module</h3>
-    <p>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>
+    <p>Represents a fragment of the software. Every node in the processing tree generated by the Kalibro processor is a module and each module has a <i>granularity</i>.</p>
   </div>
   <div>
     <h3 id="range">Range</h3>
-    <p>Represents numerical intervals that may contain the value calculated for a given metric. Ranges combined with readings provide interpretations for metric results.</p>
+    <p>Represents numerical intervals that may contain the value calculated for a given <i>metric</i>. Ranges combined with readings provide interpretations for <i>metric results</i>.</p>
   </div>
   <div>
     <h3 id="reading">Reading</h3>
-    <p>The interpretation given to a metric result (e.g., "Good", "Complex", "A"). Readings combined with ranges provide interpretations for metric results.</p>
+    <p>The interpretation given to a <i>metric result</i> (e.g., "Good", "Complex", "A"). Readings combined with ranges provide interpretations for <i>metric results</i>.</p>
   </div>
   <div>
     <h3 id="reading-group">Reading Group</h3>
-    <p>A set of readings that make sense when grouped together (e.g., "Good" and "Bad", "Simple" and "Complex").</p>
+    <p>A set of <i>readings</i> that make sense when grouped together (e.g., "Good" and "Bad", "Simple" and "Complex").</p>
+  </div>
+  <div>
+    <h3 id="configuration">Configuration</h3>
+
+    <p></p>
+  </div>
+  <div>
+    <h3 id="metric_result">Metric Result</h3>
+
+    <p>It is a numerical result associated to a metric by the Collector or aggregating in the case of a Compound Metric</p>
+  </div>
+
+  <div>
+    <h3 id="metric">Metric</h3>
+    <p>A software metric is a quantitative measure of some property of a module. For more details see
+    <%= link_to 'Carlos Morais dissertation', 'http://www.teses.usp.br/teses/disponiveis/45/45134/tde-25092013-142158/publico/dissertacao.pdf' %>.</p>
   </div>
 </div>
	@@ -16,7 +16,7 @@		@@ -16,7 +16,7 @@
16	.field-container {	16	.field-container {
17	position: relative;	17	position: relative;
18	float: left;	18	float: left;
19	- width: 653px;	19	+ width: 100%;
20	padding: 20px;	20	padding: 20px;
21	}	21	}
22		22
	@@ -10,7 +10,7 @@		@@ -10,7 +10,7 @@
10	</div>	10	</div>
11	<div class="help-container">	11	<div class="help-container">
12	<p>	12	<p>
13	- The Weight of a metric is used to calculate the weighted average of a <%= link_to 'module', tutorials_path("keywords", anchor: "module")%>.	13	+ It is used to calculate the weighted average of a <%= link_to 'module', tutorials_path("keywords", anchor: "module")%>.
14	</p>	14	</p>
15	</div>	15	</div>
16	</div>	16	</div>
	@@ -22,7 +22,7 @@		@@ -22,7 +22,7 @@
22	</div>	22	</div>
23	<div class="help-container">	23	<div class="help-container">
24	<p>	24	<p>
25	- It is the calculation of statistical results for higher <%= link_to 'granularity', tutorials_path('keywords', anchor: 'granularity') %> modules (e.g., average lines of code of classes inside a package).	25	+ It is the calculation of statistical results for higher <%= link_to 'granularity', tutorials_path('keywords', anchor: 'granularity') %> modules (e.g., average lines of code of the classes inside a package).
26	</p>	26	</p>
27	</div>	27	</div>
28	</div>	28	</div>