| 1 |
<?php |
<?php |
| 2 |
// $Id: metrics.module,v 1.1 2007/07/24 21:11:02 drewish Exp $ |
// $Id: metrics.module,v 1.2 2007/08/02 20:46:11 drewish Exp $ |
| 3 |
|
|
| 4 |
/** |
/** |
| 5 |
* Implementation of hook_help(). |
* Implementation of hook_help(). |
| 7 |
function metrics_help($section) { |
function metrics_help($section) { |
| 8 |
switch ($section) { |
switch ($section) { |
| 9 |
case 'admin/help#metrics': |
case 'admin/help#metrics': |
| 10 |
return t('TODO: Create admin help text.'); |
return t("<p>Overview of the parts of Metrics.</p> |
| 11 |
case 'admin/content/metrics': |
<dl> |
| 12 |
return t('Metrics are grouped into <em>Properties</em>...'); |
<dt>Metric</dt> |
| 13 |
|
<dt>A metric is a function that takes a node and computes a numeric score and an explanatory string.</dt> |
| 14 |
|
<dt>Ranking</dt> |
| 15 |
|
<dt>A ranking has a name, a numeric threshold, and a description. The ranking's purpose is to help a user interpret a property's score. Is a score of 30 is good or bad?</dt> |
| 16 |
|
<dt>Property</dt> |
| 17 |
|
<dt>A property has a name and a description to explain what it measures. The property is made up of metrics and rankings. Each metric within the property can have options and a multiplier. The multiplier is used to adjust the importance of each metric in the overall score.</dt> |
| 18 |
|
<dt>Property result</dt> |
| 19 |
|
<dt>When a property is computed for a node, each metrics is evaluated, the numeric value multiplied by the multiplier then added to the total, and the explanatory strings concatenated. This is stored in the database and displayed in a block on the node's page.</dt> |
| 20 |
|
</dl> |
| 21 |
|
<p>The property results are computed during a cron run by first looking for missing results and then updating the most out of date. The administrator can determine how frequently the properties are updated and how many are updated in a single cron run.</p> |
| 22 |
|
"); |
| 23 |
} |
} |
| 24 |
} |
} |
| 25 |
|
|
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch