Difference between revisions of "Template:Project"

From Nottinghack Wiki
Jump to navigation Jump to search
m
(added usage and some arguments)
Line 16: Line 16:
 
! Created
 
! Created
 
{{!}} {{{created}}}
 
{{!}} {{{created}}}
 +
}}
 +
{{#if:{{{completeddate|}}}|
 +
{{!}}-
 +
! Completed Date
 +
{{!}} {{{completeddate}}}
 +
}}
 +
{{#if:{{{dormantdate|}}}|
 +
{{!}}-
 +
! Dormant Date
 +
{{!}} {{{dormantdate}}}
 
}}
 
}}
 
{{#if:{{{version|}}}|
 
{{#if:{{{version|}}}|
Line 31: Line 41:
 
! Project Status
 
! Project Status
 
{{!}} {{{status}}}
 
{{!}} {{{status}}}
 +
}}
 +
{{#if:{{{type|}}}|
 +
{{!}}-
 +
! Type
 +
{{!}} {{{type}}}
 
}}
 
}}
 
{{#ifexpr:{{{qrmode|1}}} > 0|
 
{{#ifexpr:{{{qrmode|1}}} > 0|
Line 39: Line 54:
 
|}<!--
 
|}<!--
 
-->
 
-->
 
 
<noinclude>
 
<noinclude>
 
{{clear}}
 
{{clear}}
Line 48: Line 62:
 
'''Note:''' if ''version'' is set, the project title links to the parent of the page that includes this template.
 
'''Note:''' if ''version'' is set, the project title links to the parent of the page that includes this template.
  
=== Arguments ===
+
===Usage===
 +
 
 +
Inserting the following text onto 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!
 +
 
 +
 
 +
 
 +
<nowiki>{{Project|image=</nowiki>'''File:Yourimage.jpg'''|created='''xx/xx/xxxx'''|members='''<nowiki>[[User:YourUsername|YourUsername]]</nowiki>'''|qrmode='''0'''|type='''member'''|status='''In Progress'''}}
 +
 
 +
 
 +
== Arguments ==
 
;image
 
;image
 
:An image, in the format File:<image name>.<ext>. DO NOT include the <nowiki>[[]]</nowiki> brackets otherwise the image will display full size.
 
:An image, in the format File:<image name>.<ext>. DO NOT include the <nowiki>[[]]</nowiki> brackets otherwise the image will display full size.
 
;name
 
;name
:Project name override (default: the page name without the '''Project:''' prefix)
+
: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
:Primary Contact
+
:Primary contact.
 +
:This is a useful argument where more than one person has worked on the project.
 
;created
 
;created
:Creation date
+
:The creation date of the project.
 +
;completeddate
 +
:The date the project was completed.
 +
;dormantdate
 +
:The date the project was put on hold or made dormant.
 
;version
 
;version
 
:Project version number (e.g. 1).
 
:Project version number (e.g. 1).
Line 62: Line 92:
 
:List of members involved. Ideally, use <nowiki>[[User:username|username]]</nowiki> format.
 
:List of members involved. Ideally, use <nowiki>[[User:username|username]]</nowiki> format.
 
;status
 
;status
:Project status  
+
:Project status.
:Please use the following catagories: (planning/dormant/complete/in progress)
+
:Please use the following categories: (planning/dormant/complete/in progress)
 +
;type
 +
:Is the project to benefit Hackspace infrastructure or is it a Members Project?
 +
:Please use the following categories: (infrastructure/member/other)
 
;qrmode
 
;qrmode
:(0/1/2) If set to 1 (default), a link to the QR code is displayed.  
+
: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.
 
: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.
  
===Source===
+
 
 +
==Source==
 
Thanks to London Hackspace for the original version of this template ([https://wiki.london.hackspace.org.uk/view/Template:Project Template:Project on London Hackspace wiki]).
 
Thanks to London Hackspace for the original version of this template ([https://wiki.london.hackspace.org.uk/view/Template:Project Template:Project on London Hackspace wiki]).
  
 
[[Category:Templates infoboxes]]
 
[[Category:Templates infoboxes]]
 
</noinclude>
 
</noinclude>

Revision as of 01:22, 6 January 2019

Project





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 onto 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=File:Yourimage.jpg|created=xx/xx/xxxx|members=[[User:YourUsername|YourUsername]]|qrmode=0|type=member|status=In Progress}}


Arguments

image
An image, in the format File:<image name>.<ext>. DO NOT include the [[]] brackets otherwise the image will display full size.
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.
completeddate
The date the project was completed.
dormantdate
The date the project was put on hold or made dormant.
version
Project version number (e.g. 1).
members
List of members involved. Ideally, use [[User:username|username]] format.
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?
Please use the following categories: (infrastructure/member/other)
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.


Source

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