Template:SWP/doc

This is a documentation subpage for Template:SWP (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page.

This template is used to indicate Scratch Wiki Projects.

Usage

The format of a usage item is as follows:

If it is a named-only parameter, it will appear like this:

• nameofparam: Parameter usage.

If it is an unnamed-only parameter, it will appear like this:

1. Parameter usage.

Note the ordered list number - that is the number of the parameter.

If it can be named or unnamed, it will appear like this:

1. alternatename: Parameter usage.

This template should only be used once - on the /project page of the project.

Required parameters

1. num: Number of the project. Use 1 for the first project, 2 for the second, etc. If not specified, "1" is assumed.
2. title: A short title of the project.
3. desc: A description of the project. This should be short enough to fit in the Community Portal topic, but long enough to provide sufficient information as to what the project is.
4. status: This should be a template describing the status of the project. Recommended values are: {{not done}} if the project has not been started; {{doing}} or {{waiting}} if the project is under way; or {{done}} if the project is complete. If not specified, {{not done}} is assumed.
5. owner or assigned: This is a list of people who are working on the project - not only the person who started it. If only one person has started, is working on, and is expected to finish the project, use owner. If multiple people are working on the project, use assigned with the following format:

   Owner_name<br/>Helper_name1, helper_name2, helper_name3...

   If not specified, the username of the last person who edited the /project page is assumed.
6. started: This is the d/m/Y that the project was started. If not specified, the date that the /project page was last edited is assumed.

• link: Named only. This is the title of the Community Portal section referring to the project. For example, after clicking the section title in the table of contents on the Community Portal, if the URL address ends with #Do.2Fdo_not_-_there_is_no_try, the value of this parameter should be Do/do not - there is no try.
• page: Named only. If this parameter is not specified, the template will yield an error. This must be set to the full page name of the /project page. The best value of this parameter is {{subst:FULLPAGENAME}} - remember that the template should only be placed on the /project page for the project.

Optional parameters

7. ended: This is the date that the project was completed.

• cpsub: Named only. If the CP topic is in a CP subpage, for example an archive or Not Done, this is the path to the subpage. For example, the value would be "Not Done" to link to Scratch Wiki talk:Community Portal/Not Done.
• width: Named only. Some project pages suffer from the width of the frame. Specify a custom width here. Default is 50%.

Example

Examples can be seen on the template page itself, on the template's /project page, and on the template's talk page (links to all of which can be found on the template page).