Template:OWWProject/doc

From OpenWetWare
Jump to navigationJump to search

Template:OWWProject (talk, backlinks, edit)


Purpose

This template should be added to the main page of all OWW Projects documented on this wiki (and only the main page). It will add a useful infobox using the information supplied (see below) and will automatically add the OWW Projects to Category:All OWW Projects.

Usage

Cut and paste:

{{OWWProject
|name          =
|type          =
|status        =
|requestedby   =
|startdate     =
|enddate       =
|description   =
}}

For help with parameter values, see below.

           
List of OpenWetWare Projects
Name: {{{name}}}
Description {{{description}}}
Project Type  {{{type}}}
Status  {{{status}}}
Requested By  [[User:{{{requestedby}}}|{{{requestedby}}}]]
Start Date  {{{startdate}}}
End Date  {{{enddate}}}
Warning: Default sort key "{{{NAME}}}" overrides earlier default sort key "OWWProject/doc".



Content parameters

This section describes parameters that govern infobox content.

Content parameters
name Project name
type Type of project. Specific types to be defined
status Current status of the project. Specific status labels to be defined
requestedby OWW Member requesting feature or work
startdate Start date of the project.
enddate Start date of the project.
description Short description of the project.


Using the infobox

Existing OWW Project pages

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new OWW Project

If you want to create a new OWW Project, enter the name below and click the button. A new page will be created with the infobox template already in place.


Please replace "MyOWWProject" with the new OWW Project name:



Enhancing this template

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

Fixing documentation

If you would like to fix documentation, please be aware that documentation and code is split into two files:


In addition, Template:OWWProject/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:OWWProject/doc.

The "Create OWW Project" button

To improve the "Create OWW Project" behavior:

Infobox parameters

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.

Test case

See if the following pages are still ok, after edited this template.