Help:Metric Documentation
From SONIVIS:Wiki
In this article you can find help on how to describe a measure in our documentation. There are templates and guidelines which are documented in this Wiki article.
A complete example of a metric can be found here.
Contents |
Creating the Measure Page
At first you have to create a page with the name of the measure, for example Author Count.
Measures do not belong to a special namespace.
- If the measure exists in the SONIVIS:Tool, the name should be similar to the used name in the tool. Please note, if you find a measure which is not documented yet, well done. Please, even you have only less time, just create the page with the name of the measure. We will help you complete the description
- If the measure does not exist, you are free to choose a name of your own
Creating the Measure Headlines
At the moment there are four headlines important for a measure.
- Objective: Contains a short description of the measure.
- Explanation (optional): Describes the measure and the idea behind it more deeply. It would be even great to have an example of how this measure can be used and how it should be interpreted.
- Calculation: Contains the mathematical description of a measure.
- Statement: Refers to the way, how this measure is calculated in the tool. For example more or less all our network measures are calculated by using R. The example should be self-explanatory.
- Reference: Contains all weblinks and literature used to describe a measure. Please consider our bibliography.
- Additional Reading: Further documents which discuss this measure.
Default Usage:
==Objective== ==Calculation== ==Statement== ==Reference== ==Additional Reading==
Categorization of measure pages
Please add to each measure page at least on category. This is the the category Category:Measure
Optional sub-categories are:
- Category:Network Measure
- Category:Domain Measure with subcategory Category:MediaWiki Measures
It is recommended to use these optional categories as well.
Creating special content
For general help see Help:Editing.
| What it looks like | What you type | |||
|---|---|---|---|---|
|
For the Measure Headlines please use the normal section wiki markup (==). Measure Headline |
== Measure Headline == |
|||
|
For the mathematical representation of the measure 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 measure 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 measure 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 measure 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}}
|
