Template:Issues/doc
This is a documentation subpage for Template:Issues. It contains usage information, categories and other content or metadata that is not part of the original template. |
Usage
Dashboard topic to display issues, challenges or goals of a project and their general resolved state.
Example
Full option example. Al parameters defined, shows help labels and help button.
{{Issues|label=My Issues|vscale=1|criticTotal=1|criticOpen=1|importantTotal=5|importantOpen=3|minorTotal=2|minorOpen=1|IssueLink=Template:Wikiproject Uganda|help=yes|col1Help=my critical|col2Help=my important|col3Help=my minor|row1Help=my identified|row2Help=my still open|helpVisual=yes|helpLink=Template:Wikiproject Uganda|helpEnable=yes}}
Example without help labels but with a help button. Double scale.
{{Issues|vscale=2|criticTotal=1|importantTotal=5|importantOpen=3|minorTotal=2|minorOpen=1|IssueLink=Template:Wikiproject Uganda|helpVisual=yes|helpLink=Template:Wikiproject Uganda|helpEnable=yes}}}
Minimal exampe at 0.75 scale.
{{Issues|vscale=0.7|criticTotal=1|importantTotal=5|minorTotal=2|minorOpen=1|IssueLink=Template:Wikiproject Uganda|helpVisual=yes|helpLink=Template:Wikiproject Uganda|helpEnable=yes}}
For improved user friendliness during editing, use a indented layout with the parameters on separate lines. Parameters which are not used can be commented out, so when you need them at a later stage they are easy to add by just removing the comment start (<!--) and end(-->) markers. Example: which is entered as: |
Templatedata
Creates a dashboard item to summaries project issues / challenges / goals.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Label | label | Description of the name which is used for the issues / chalenges / golas in the project. Any value. | String | optional |
Template scaling | vscale | Number to base 1 (fractions to scale down, multiplication to scale up) to scale the whole template up or down. Caution: scaling down may cause the summary icon to display at full size, due to inaccuracies in the calculation. In those cases use a different factor with less significant numbers behind the decimal separator.
| Number | optional |
Critical total | criticTotal | Total number of critical items identified in the project. If there are no critical items don't define the parameter, will display as 0. | Number | optional |
Critical still open | criticOpen | Total number of critical items identified in the project that are not yet resolved, still open. If all critical items are resolved, it will display as 0 and change the summary icon in the front of the dashboard. If there are no more issues open don't define the parameter. This will update the summary icon and display an actual value of 0. If you define a value of 0 the summary icon will not update. | Number | optional |
Important total | importantTotal | Total number of critical items identified in the project. If there are no critical items don't define the parameter, will display as 0. | Number | optional |
Important still open | importantOpen | Total number of critical items identified in the project that are not yet resolved, still open. If all critical items are resolved, it will display as 0 and change the summary icon in the front of the dashboard. If there are no more issues open don't define the parameter. This will update the summary icon and display an actual value of 0. If you define a value of 0 the summary icon will not update. | Number | optional |
Minor total | minorTotal | Total number of minor items identified in the project. If there are no more minor items don't define the parameter, will display as 0. | Number | optional |
Minor still open | minorOpen | Total number of minor items identified in the project that are not yet resolved, still open. If all minor items are resolved, it will display as 0 and change the summary icon in the front of the dashboard. If there are no more issues open don't define the parameter. This will update the summary icon and display an actual value of 0. If you define a value of 0 the summary icon will not update. | Number | optional |
Link to issues page | IssueLink | Makes the summary icon work as a link, provide a link to the page or page section describing the issues in detail. Without this parameter there will be no link defined. | String | optional |
Issues label help | help | Will display labels for the rows and columns in the dashboard template, describing the row and column contents (descriptions can be determined by the user). If you don't want the labels just don't define the parameter. | String | optional |
Help label 1st column | col1help | User configurable label help text for the first column. It will be displayed vertical above the column.
| String | optional |
Help label 2nd column | col2help | User configurable label help text for the second column. It will be displayed vertical above the column.
| String | optional |
Help label 3rd column | col3help | User configurable label help text for the third column. It will be displayed vertical above the column.
| String | optional |
Help label 1st row | row1help | User configurable label help text for the first row. It will be displayed horizontally in front of the row.
| String | optional |
Help label 2nd row | row2help | User configurable label help text for the second row. It will be displayed horizontally in front of the row.
| String | optional |
Make help button visual | helpVisual | Visualizes a help button in the top right corner of the dashboard template. Any value will work. If you don't want a help button just don't define the parameter. | String | optional |
Help button link | helpLink | Creates a link from the help button to the user defined (this parameter) help page.
| String | optional |
Enable Help button | helpEnable | Use this parameter (any value will work) to show the help button as enabled or with transparent face as disabled. For disabled just don't define the parameter. | String | optional |
See also