1,623
edits
Support/l10nPriorityPRD: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
|||
| Line 71: | Line 71: | ||
* Another function with the same signature that returns a summary (total number of articles, and number of translated articles). | * Another function with the same signature that returns a summary (total number of articles, and number of translated articles). | ||
* A function that can draw a progress bar based on the summary in the function above. | * A function that can draw a progress bar based on the summary in the function above. | ||
=Implementation= | |||
* Mechanism to upload article priority data into the TikiWiki db | |||
**cww+zzxc can advice; already have scripts that parse data and create the prioritized article list -- just need to get them into Tiki. | |||
* Decide how to store this data, e.g. Tracker tables, or new db tables. | |||
**Need at least three article lists: | |||
*** The entire KB, prioritized on page hits | |||
*** The "navigation" articles -- start pages, Ask a Question | |||
*** The How to Contribute articles | |||
** Lists must contain info about: | |||
*** Article name or URL | |||
*** Score (e.g. page hits %, or whatever metrics we use to prioritize the list) | |||
*** Priority order (possibly implied in the Score field above) | |||
* TikiWiki plugin to generate article lists in wiki docs | |||
** Flexible parameter based syntax just like the SHOWFOR plugin, e.g. {l10nTable(list=kb, start=1, limit=10, filter=needsReview)} | |||
** Potential parameters: | |||
*** list: the actual article list (in the Tikiwiki db) to get the article info from | |||
*** start: (optional) a start index in the list. should start from the beginning of the list by default. | |||
*** limit: (optional) limits the number of articles to list | |||
*** scoreLimit: (optional) limits the number of articles to list based on the priority system we use. For example, in our case, we might want to show a list of the articles that are needed in order to reach 50% page hits. We can't just say limit=15 because we don't know if 15 articles are really enough or if it's actually 16, or even 20. Instead, we use scoreLimit=0.5 (assuming the sum of the score for all articles are 1.0) | |||
***filter: it should be possible to filter the list on status. For example, we might want to show a list of only the articles that are translated and waiting for approval/review. Or, we might want to filter out already translated articles. | |||
***style: the mockup above shows two possible styles: a table format with or without the Page Hits % as a column. A third possible style would be a simple HTML list with just the article name. | |||
* TikiWiki plugin/syntax to generate progress bar with progress text/label | |||
** Similar to the plugin above, this progress bar could be limited by the number of articles, or a scoreLimit. So, 100% in the progress bar could be the result of x number of articles in a list translated, or y total score achieved. | |||
** The text label next to the progress bar should be flexible, as we haven't yet figured out which way | |||