Template:Issues/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search

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.

My Issues
my critical:my important:my minor:
my identified:
1
5
2
🠗
🠗
🠗
my still open:
1
3
1
=
Critical

{{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.

1
5
2
🠗
🠗
🠗
0
3
1
=
Important

{{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.

1
5
2
🠗
🠗
🠗
0
0
1
=
Minor

{{Issues|vscale=0.7|criticTotal=1|importantTotal=5|minorTotal=2|minorOpen=1|IssueLink=Template:Wikiproject Uganda|helpVisual=yes|helpLink=Template:Wikiproject Uganda|helpEnable=yes}}

Templatedata

Creates a dashboard item to summaries project issues / challenges / goals.

Template parameters

ParameterDescriptionTypeStatus
Labellabel

Description of the name which is used for the issues / chalenges / golas in the project. Any value.

Stringoptional
Template scalingvscale

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.

Default
1
Numberoptional
Critical totalcriticTotal

Total number of critical items identified in the project. If there are no critical items don't define the parameter, will display as 0.

Numberoptional
Critical still opencriticOpen

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.

Numberoptional
Important totalimportantTotal

Total number of critical items identified in the project. If there are no critical items don't define the parameter, will display as 0.

Numberoptional
Important still openimportantOpen

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.

Numberoptional
Minor totalminorTotal

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.

Numberoptional
Minor still openminorOpen

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.

Numberoptional
Link to issues pageIssueLink

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.

Stringoptional
Issues label helphelp

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.

Stringoptional
Help label 1st columncol1help

User configurable label help text for the first column. It will be displayed vertical above the column.

Default
critical
Stringoptional
Help label 2nd columncol2help

User configurable label help text for the second column. It will be displayed vertical above the column.

Default
important
Stringoptional
Help label 3rd columncol3help

User configurable label help text for the third column. It will be displayed vertical above the column.

Default
minor
Stringoptional
Help label 1st rowrow1help

User configurable label help text for the first row. It will be displayed horizontally in front of the row.

Default
identified
Stringoptional
Help label 2nd rowrow2help

User configurable label help text for the second row. It will be displayed horizontally in front of the row.

Default
still open
Stringoptional
Make help button visualhelpVisual

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.

Stringoptional
Help button linkhelpLink

Creates a link from the help button to the user defined (this parameter) help page.

Default
User:Bert Araali
Stringoptional
Enable Help buttonhelpEnable

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.

Stringoptional

See also