Help:Metric Documentation
From SONIVIS:Wiki
In this article you can find help on how to describe a metric in this wiki. Therefore exist templates and guidelines which are documented in this article. A complete example of a metric can be found here.
Contents |
Creating the Metric-Page
At first you have to create a page with the name of the metric, for example Author Count. The metrics do not belong to a special namespace.
- If the metric exists in the SONIVIS:Tool the name should be like the used name in the tool. Notice that if you find a metric which is not yet documented in the wiki you found the metric to test your attention ;-)
- If the metric does not exist, you are free to choose a name of your own
Creating the Metric-Headlines
At the moment four headlines are important for a metric.
- Objective: means for which object the metric is calculated
- Explanation (optional): to give a deeper look at the metric (what does this metric tell us, how did we build it and how could we interpret this metric)
- Calculation: mathematical interpretation of this metric
- Reference: all weblinks and literature for this metric
Creating special content
For general help see Help:Editing.
| What it looks like | What you type | ||
|---|---|---|---|
|
For the Metric-Headlines please use the normal section wiki markup (==). Metric Headline |
== Metric Headline == |
||
|
For the mathematical representation of the metric please use the varieties of <math>. For more help on displaying a formula take a look here. |
<math>A_c = 1+1</math> |
||
|
For using examples on the calculation you can use the metric example template. For this template you have to define the exampletext and the example. For changing the template take a look here or here.
|
{{Metric Example
|exampletext=SQL-example (MediaWiki)
|example=SELECT count(*) FROM page p;}}
|
||
|
To specialize a metric you can use predefined templates. All templates can be found at Category:Metric Template. For example:
This box will always be shown at the right side of a page and is also floated. |
{{Metric Author}}
|
||
|
To bundle all specialties of a metric you have to use two templates. {{MetricBoxTop}} and {{MetricBoxBottom}}. For the MetricBoxTop you can also include a name to be shown at the top of all. This could be the page name, included by {{PAGENAME}}, or the name you want to give to the metric. Between the two templates you can put as much metric templates as you want.
|
{{MetricBoxTop|{{PAGENAME}}}}
{{Metric Author}}
{{MetricBoxBottom}}
|
Defining categories
As Category must be used: Category:Measure
Optional subcategories can be used:
- Category:Domain Measure with subcategory Category:MediaWiki Measures
- Category:Network Measure with subcategories Category:Position Measure and Category:Structure Measure
Notice: At the moment these are all categories used in the SONIVIS:Tool to characterize a metric.

