Template:Project

From Nottinghack Wiki
Revision as of 21:41, 15 February 2024 by Asj (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Project
[[{{{image}}}|border|frameless|220px|center]]
Primary Contact {{{primary}}}
Created {{{created}}}
Completed {{{completeddate}}}
Dormant {{{dormantdate}}}
Version {{{version}}}
Members {{{members}}}
Manufacturer {{{manufacturer}}}
Model {{{model}}}
Location [[{{{location}}}]]
GitHub / Repo {{{repo}}}
Status {{{status}}}
Type Undefined
Live Status {{{livestatus}}}
QR code

Documentation

All arguments are optional. The default state of the template with no arguments is shown at the top of this page.

Note: if version is set, the project title links to the parent of the page that includes this template.

Usage

Inserting the following text at the top of your project page will produce an information box on your page that gives an overview of the project to the reader. All of the arguments are optional and can be written in any order.

Images look great with this template, include one if you can!


{{Project
|image=
|name=
|primary=
|created=
|completeddate=
|dormantdate=
|version=
|members=
|location=
|repo=
|status=
|type=
|livestatus=
|qrmode=1
|LookingforCollaborators=
}}

Arguments

image
An image, in the format File:<image name>.<ext>. DO NOT include the [[]] brackets otherwise the image will display full size.
caption
This adds text under the image used for the infobox.
name
Used to override the project name if it is different from the name of the wiki page (default: the page name without the Project: prefix).
primary
Primary contact.
This is a useful argument where more than one person has worked on the project.
created
The creation date of the project, format DD/MM/YYYY. If day of month unknown use 01.
completeddate
The date the project was completed, format DD/MM/YYYY. If day of month unknown use 01.
dormantdate
The date the project was put on hold or made dormant, format DD/MM/YYYY. If day of month unknown use 01.
version
Project version number (e.g. 1).
members
List of members involved. Ideally, use [[User:username|username]] format.
location
Where the project lives
repo
Source code, files, etc - github or other
status
Project status.
Please use the following categories: (Planning/Dormant/Complete/In Progress)
type
Is the project to benefit Hackspace infrastructure or is it a Members Project?
Including this will automatically apply the relevant category to your project.
Please use the following categories: (infrastructure/member/event/workshop/other)
livestatus
This can be used for projects that may be dormant or complete but still maintained/ live eg. vending machines
qrmode
Please use the following categories: (0/1/2)
If set to 1 (default), a link to the QR code is displayed.
If set to 2, it will display the QR code image on. If set to 0, do not display the QR code link or image.
LookingforCollaborators
Indicates that the project is open to collaboration with other members

Extended arguments

location
Some projects are installed, such as the Vending_Machine/Westomatic.
manufacturer
Some projects have associated manufacturers (for example, Vending_Machine/Westomatic).
model
Some projects have associated models (for example, Vending_Machine/Westomatic).

Source

Thanks to London Hackspace for the original version of this template (Template:Project on London Hackspace wiki).