Renamed current as trunk.

git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1433 abb3cda0-5349-4a8f-a601-0c33ac3a8c38

documentation/trunk/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-derived-metrics.wiki

@@ -0,0 +1,21 @@
+[[Property:title|Defining derived metrics]]
+[[Property:weight|1]]
+[[Property:uuid|d9c9037a-7b87-3810-c5c8-d34523cdad7b]]
+To define a derived metric, you must select the''' Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Basic metric''' and then the type of the results you are looking for (i.e. Class, Feature, Line, ...). Once done, you can perform the following steps:
+# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
+# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
+#  Choose your criteria by selecting the item with ... in the '''Criterion definition''' list. Once selected you can press Ctrl+Space to see the list of available criterion. Once the criterion is set, you can add some properties (e.g. a property could be <eiffel>STRING</eiffel> if the criterion you have is to look for descendants of the <eiffel>STRING</eiffel> class). 
+# Once you have completed the metric definition you need to save your metric by clicking on the Save button.
+# If you want to define another derived metric, repeat all the previous steps.
+
+For more information about criterion, read the [[Criterion References|Managing criterion]]  section.
+
+A summary of the metric you just defined appears in a textual representation in the '''Expression''' text field.
+
+{{seealso|<br/>
+[[Managing new metrics|Managing metrics]]  <br/>
+[[Criterion References|Managing criterion]]  }}
+
+
+
+

documentation/trunk/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-linear-metrics.wiki

@@ -0,0 +1,20 @@
+[[Property:title|Defining linear metrics]]
+[[Property:weight|2]]
+[[Property:uuid|bfcfffff-08ec-8e18-fed4-3f39ac3772da]]
+To define a linear metric, you must select the '''Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Linear metric''' and then the type of the results you are looking for (i.e. Class, Feature, Line, ...). Once done, you can perform the following steps:
+# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
+# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
+# Define a single term by choosing a metric from the combo box that appears when selecting the '''Metrics''' column, and then choose a coefficent in the '''Coefficient''' column of the metric definition list.
+# To add other terms, repeat operation 3 as many times as needs.
+# Once you have completed the metric definition you need to save your metric by clicking on the Save button.
+# If you want to define another linear metric, repeat all the previous steps.
+
+A summary of the metric you just defined appears in a textual representation in the '''Expression''' text field.
+
+{{seealso|<br/>
+[[Managing new metrics|Managing metrics]]  <br/>
+}}
+
+
+
+

documentation/trunk/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/defining-ratio-metrics.wiki

@@ -0,0 +1,21 @@
+[[Property:title|Defining ratio metrics]]
+[[Property:weight|3]]
+[[Property:uuid|40394359-600c-5392-8609-6f994920a3b1]]
+To define a ratio metric, you must select the '''Metric Definition''' tab and click the '''New metric''' button. A menu appears asking you the kind of metric you want to define. Select '''Ratio metric'''. Once done, you can perform the following steps:
+# Enter a name for the metric in the "Name" field. Next to the field you will see the type of metric as well as the unit for this metric.
+# Enter a description for the metric. The description is shown as a tooltip when you navigate the list of available metrics.
+# Select a metric for numerator in the "Metric" combo box of the "Numerator" frame to change the numerator in the "Ratio" field. 
+# Select a metric for denominator in the "Metric" combo box of the "Denominator" frame to change the denominator in the "Ratio" field. 
+# If you want to change again either numerator or denominator repeat operations 3. or 4. as many times as needed.
+# Once you have completed the metric definition you need to save your metric by clicking on the Save button.
+# If you want to define another ratio metric, repeat all the previous steps.
+
+A summary of the metric you just defined appears in a textual representation in the '''Expression''' text field.
+
+{{seealso|<br/>
+[[Managing new metrics|Managing metrics]]  <br/>
+}}
+
+
+
+

documentation/trunk/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/defining-new-metrics/index.wiki

@@ -0,0 +1,13 @@
+[[Property:title|Defining new metrics]]
+[[Property:weight|1]]
+[[Property:uuid|7f36c01c-40f4-be23-dfcd-d92bf2bbd535]]
+The metric interface provides by default a set of basic metrics. However, user may want to define other metrics, such as linear sums or different ratios, or combining some criteria... This is possible thanks to the '''Metric Definition''' tab of the metric tool. 
+
+New metrics are increasingly added to the list of metrics which is ordered by unit type, and are available for [[Evaluating a measure|calculation]] . 
+
+{{seealso|<br/>
+[[Evaluating a measure|Evaluating a measure]]  <br/>
+[[Managing new metrics]]  }}
+
+
+

documentation/trunk/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/index.wiki

@@ -0,0 +1,9 @@
+[[Property:title|Handling new metrics]]
+[[Property:weight|2]]
+[[Property:uuid|1ca7a8cf-f446-6cbc-59e1-0455e633ce44]]
+The metric tool ("Metric" tab of the context tool) provides by default a set of metrics that can be used to make some measurements over various scopes in order to evaluate a project.
+
+This set of metrics is certainly not complete, users may probably want to define other metrics regarding their own needs. And then, since needs are different and in order to avoid an explosion in the number of basic metrics, we agreed on implementing only elementary metrics that could not be evaluated if not implemented in the tool.
+
+Users can then define their own metrics. The metric tool provides an interface to define new metrics. Click on the '''Metric Definition''' tab in the metric tool to start adding new metrics and modifying existing metrics.
+

documentation/trunk/eiffelstudio/eiffelstudio-how-tos/how-analyze-project/handling-new-metrics/managing-new-metrics.wiki

@@ -0,0 +1,7 @@
+[[Property:title|Managing new metrics]]
+[[Property:weight|2]]
+[[Property:uuid|540cbcc4-27cb-7fc4-5c98-0c622bfb0841]]
+After having [[Defining new metrics|defined]]  some new metrics, it is possible to delete the useless ones, or to edit them: 
+* Deleting a metric: select the metric you want to delete and click on the '''Remove current selected metric''' button.
+* Editing a metric: select the metric you want to edit and start changing its definition by adding or removing criteria (derived), adding or removing terms (linear), changing numerator and denominator (ratio).
+