Support/l10nPriorityPRD/Plugin Usage
This is a draft, and will very likely change in appearance and structure shortly.
PAGELIST
The pagelist plugin (aka PAGELIST) takes a list of tikiwiki pages, finds each page's current l10n status, and then displays the list in an user friendly manner. Results can offset or limited and be sorted by 'score' or 'priority'.
Syntax
Usage: {PAGELIST(list=>Example,title=>Title,description=>Description,style=>table)}{PAGELIST}
| Parameter | Description | Default | Required |
| list | Name of the list containing the pages to be displayed in the table | NULL | Yes |
| title | Override the list's display title with your own | NULL | No |
| description | Override the list's description text with your own | NULL | No |
| lang | Used for forcing a language during the l10n status checking. If omitted, the current locale is used | URL locale | No |
| offset | Integer value used to start after the specified number of pages | 0 | No |
| limit | Integer value used to restrict the number of pages displayed in the table | NULL | No |
| sort | Column to sort pages on. Can be either 'priority' or 'score' in the form of 'column_desc' for descending or 'column_asc' for ascending. | priority_asc | No |
| style | Display style for the plugin. Can be 'table', 'ul', or 'ol'. | table | No |
| filter | Only return pages of a particular l10n status. Can be 'translated', 'needs review', 'needs update', 'draft', 'needs translation'. | NULL | No |
| hide | to separate the values (eg, score|status). | NULL | No |
Examples
Coming soon...
LISTPROGRESS
The listprogress plugin (aka LISTPROGRESS) takes a list's pages and quantifies a particular l10n status for a given locale in the form of a progress bar and percentage or ratio label.
Syntax
Usage: {LISTPROGRESS(list=>Example,filter=>translated,scoreLimit=>.5)}{LISTPROGRESS}
| Parameter | Description | Default | Required |
| list | Name of the list containing the pages to be displayed in the table | NULL | Yes |
| title | Override the list's display title with your own | NULL | No |
| description | Override the list's description text with your own | NULL | No |
| lang | Used for forcing a language during the l10n status checking. If omitted, the current locale is used | URL locale | No |
| limit | Integer value used to restrict the number of pages used during the calculation of a locale's progress | NULL | No |
| scoreLimit | Value between 0 and 100 used to 'weigh' the percentage calculation of a locale's progress. For example, a value of 50 means that a progress percentage of 50% will be displayed as %100. | 1 | No |
| sort | Column to sort pages on pre-locale progress calculation. Can be either 'priority' or 'score' in the form of 'column_desc' for descending or 'column_asc' for ascending. | score_desc | No |
| style | Display style for the plugin. Can be 'percentage', 'named percentage', 'ratio', 'named ratio'. | percentage | No |
| filter | Only return pages of a particular l10n status. Can be 'translated', 'needs review', 'needs update', 'draft', 'needs translation'. | translated | No |
| anchor | Turn anchor links off in list titles. Only accepted value is 'none'. | NULL | No |
Examples
{LISTPROGRESS(list=>kb,style=>percentage,scoreLimit=>.15)}{LISTPROGRESS}
{LISTPROGRESS(list=>kb,title=>This is an example title,description=>This is an example description,style=>percentage,limit=>50)}{LISTPROGRESS}
