Template:Uganda/ProjectTitleSummary/doc
![]() |
This is a documentation subpage for Template:Uganda/ProjectTitleSummary. It contains usage information, categories and other content or metadata that is not part of the original template. |
Summary
Template:Uganda/ProjectTitleSummary is a template to place summary information of a project on to a wiki page. It is set up for projects in Uganda, but can be used globally. The template places a short text description in the page itself, showing essential basic information about a projects name, administrator, dates, state and links to other project wiki pages.
Parameters
The following parameters can be used in the template:
Parameter name |
Required | Purpose |
---|---|---|
project_name | yes | The name of the project. Is required to link the template and it's data uniquely to a project. The next parameter is used to select if you want it displayed in the template. |
project_name_display | no | If you want the project name to be displayed in the template enter any value or string for this parameter. In some cases you don't want to display the project name, f.i. to avoid duplicating data in the page, like f.i. using this template after a title which already displays the project name.
Displaying without the project name is the standard, so you don't need this parameter if the name is not required to display. |
project_admin | yes | Name of the administrator(s) of the project. Is a string or even a transclusion, URL of the administrators of the project. A commonly used transclusion is an OSM user with the template {{Template:User}}. |
date_start | yes | Start date of the project. The format is at this time not language related, it is a string displaying the date just as the user assigns it as a string to the parameter. |
date_completed | state 0, 1 or 2=no; state 3 or 4=yes | Completion date of the project. Only used, required and displayed when the project is completed but waiting for validation (state = 3) or validated and closed (state = 4). The format is at this time not language related, it is a string displaying the date just as the user assigns it as a string to the parameter. |
date_validated | state 0, 1, 2 or 3=no; state 4=yes | Validation or closing date of the project. Only used, required and displayed when the project is validated and closed (state = 4). The format is at this time not language related, it is a string displaying the date just as the user assigns it as a string to the parameter. |
state | yes | A number representing the state of the project. The state is then reflected in the template with a coloured block:
When no state is assigned the template will display an error message. |
project_overview | no | If the project has an overview page or a page with more information you can enter the link or url to this page here. When not used the line will not show in the template. |
Usage
Default (without displaying the project name)
{{Uganda/ProjectTitleSummary | project_name = My project name | project_admin = {{User|Bert Araali}} | date_start = 27/12/2019 | state = 2 | project_overview = [https://wiki.openstreetmap.org/wiki/WikiProject_Uganda/My project link] }}
Will be transcluded as:
initiated and administered by Bert Araali (on osm, edits, contrib, heatmap, chngset com.)
Status: - Started: 27/12/2019
Details: project link
WIth project name displayed
{{Uganda/ProjectTitleSummary | project_name = My project name | project_name_display = 1 | project_admin = {{User|Bert Araali}} | date_start = 27/12/2019 | date_validated = 29/12/2019 | state = 4 | project_overview = [https://wiki.openstreetmap.org/wiki/WikiProject_Uganda/My project link] }}
Will be transcluded as:
Activity/Project title: My project name
initiated and administered by Bert Araali (on osm, edits, contrib, heatmap, chngset com.)
Status: - Started: 27/12/2019 Validated/closed: 29/12/2019
Details: project link
Template to place summary information of a project on to a wiki page. It is set up for projects in Uganda, but can be used globally. The template places a short text description in the page itself, showing essential basic information about a projects name, administrator, dates, state and links to other project wiki pages.
Parameter | Description | Type | Status | |
---|---|---|---|---|
project_name_display | project_name_display | If you want the project name to be displayed in the template enter any value or string for this parameter. In some cases you don't want to display the project name, f.i. to avoid duplicating data in the page, like f.i. using this template after a title which already displays the project name. Displaying without the project name is the standard, so you don't need this parameter if the name is not required to display
| String | suggested |
project_name | project_name | The name of the project. Is required to link the template and it's data uniquely to a project. The next parameter is used to select if you want it displayed in the template.
| Unknown | required |
project_admin | project_admin | Name of the administrator(s) of the project. Is a string or even a transclusion, URL of the administrators of the project. A commonly used transclusion is an OSM user with the template {{Template:User}}.
| Unknown | required |
state | state | A number representing the state of the project.
| Unknown | required |
date_start | date_start | Start date of the project. The format is at this time not language related, it is a string displaying the date just as the user assigns it as a string to the parameter. | Unknown | required |
date_completed | date_completed | Completion date of the project. Only used, required and displayed when the project is completed but waiting for validation (state = 3) or validated and closed (state = 4). The format is at this time not language related, it is a string displaying the date just as the user assigns it as a string to the parameter. | Unknown | suggested |
date_validated | date_validated | Validation or closing date of the project. Only used, required and displayed when the project is validated and closed (state = 4). The format is at this time not language related, it is a string displaying the date just as the user assigns it as a string to the parameter. | Unknown | suggested |
project_overview | project_overview | If the project has an overview page or a page with more information you can enter the link or url to this page here. When not used the line will not show in the template.
| Unknown | suggested |