User:B42/Test: Difference between revisions

Revision as of 21:48, 12 February 2013

Project page

To mark a page as project, use the {{Project}} template. This will put your project into the projects category and it will render the Project info box on the right side of the content. The template has number of parameters described below, some of them mandatory.

Copy and Paste Template for Projects

This is a minimal working template for a project. You can add other, optional parameters.

{{Project
 |founder=
 |status=
 |shortdesc=
}}

Project with parameters for additional properties can look like this:

 |name=Base48 Rostock
 |image=Rostock.jpg
 |founder=rmarko
 |coops=hyna,arius,cubz
 |hwlic=GPL
 |status=active
 |tags=hw
 |shortdesc=Our Rostock
 |created=2012-11-11

Mandatory parameters

founder: who created the project and/or who is the main contact person for it
status: idea, active, or closed; NEED MORE INFO
shortdesc: short (less than 255 characters) description of the project

Optional parameters

name

if you would like to show another name than the name of the project page, you can use this field to set a display name

created

date when the project was started, if not used date of the page creation will be used

accepts the

YYYY-MM-DD

format

tags

this will help to automatically group the project in several lists we are displaying

image

file name of the project thumbnail image

must be uploaded into the wiki, use only the file name without the File: prefix

coops

should contain the list of people working/interested in the project

colon-separated, e.g.

user1,user2,user3

swlic

software license (description less than 255 chars)

hwlic

hardware license (description less than 255 chars)

github

github repository of the project

in the

user/repo

format

cur_version

current version of the project

proglang

programming language(s) used for the project

Current known tags

hw: hardware project
sw: software project
template: NOT IMPLEMENTED (template page for common things (for example this project))
wiki: projects related to this wiki
infrastructure: Base 48 infrastructure related projects

Project creation and maintenance Help/Support

~~In case if you need anything from the perspective of creating a new project, or having some new meta information being added and displayed, please contact evilissimo for Help. :-)~~

Since the project template has been heavily tampered with, contact b42 if you need any help.

@@ Line 46: / Line 46: @@
 === Optional parameters ===
-==== name (optional) ====
+; name
-Reflects the name of the project.
+: if you would like to show another name than the name of the project page, you can use this field to set a display name
-This field has 2 functions:
+; created
-* Display Name
+: date when the project was started, if not used date of the page creation will be used
-* Page Name + Display Name
+: accepts the <pre>YYYY-MM-DD</pre> format
+; tags
+: this will help to automatically group the project in several lists we are displaying
+; image
+: file name of the project thumbnail image
+: must be uploaded into the wiki, use only the file name without the File: prefix
+; coops
+: should contain the list of people working/interested in the project
+: colon-separated, e.g. <pre>user1,user2,user3</pre>
+; swlic
+: software license (description less than 255 chars)
+; hwlic
+: hardware license (description less than 255 chars)
+; github
+: github repository of the project
+: in the <pre>user/repo</pre> format
+; cur_version
+: current version of the project
+; proglang
+: programming language(s) used for the project
-If you would like to show an other name than the name of the project page, you can use this field to set a display name.
+=== Current known tags ===
+; hw
-==== created (optional) ====
+: hardware project
-'''currently not implemented'''
+; sw
-This field should be set to the date the project was started. The value should have the following format: YYYY-MM-DD
+: software project
+; template
-Example:<pre>|created=2012-03-16</pre>
+: '''NOT IMPLEMENTED''' (template page for common things (for example this project))
+; wiki
-==== tags (optional) ====
+: projects related to this wiki
-This will help to automatically group the project in several lists we are displaying.
+; infrastructure
+: Base 48 infrastructure related projects
-==== image (optional) ====
-This value should contain a File/Image wiki tag or a plain URL.
-Please ensure that the image is not bigger than 290px. '''NOTE:''' ''Bigger images will destroy the layout of the Project Page Meta field.''
-==== coops (optional) ====
-This field should contain the list of coops on the projects or a single coop.
-If there are multiple coops, then list them with the separator character ','
-Example:<pre>|coops=name1,name2,name3</pre>
-==== swlic (optional) ====
-If this value is used, it will display the value for the Software License fields.
-==== hwlic (optional) ====
-If this value is used, it will display the value for the Hardware License fields.
-Current known tags:
-* hw             - Hardware project
-* sw             - Software project
-* template       - template page for common things (for example this project)
-* wiki           - projects related to this wiki
-* infrastructure - Base 48 infrastructure related projects
-==== github (optional) ====
-convenience function to put a link to a github repository in the project info box.
-Usage:<pre>|github=user/repo</pre>
-It will be expanded to the full github url and displayed as link.
-==== cur_version (optional) ====
-This field can be used to set the current version of the project. The value of this will be displayed as is in the 'Current Version' fields.
-==== os (optional) ====
-This field should be used to list the operating systems the project targets. The value of this will be displayed as is in the 'Operating System(s)' fields.
-==== arch (optional) ====
-This field should be used to list the operating systems the project targets. The value of this will be displayed as is in the 'Architecture(s)' fields.
-==== proglang (optional) ====
-This field should be used to list the programming languages the project uses.  The value of this will be displayed as is in the 'Programming Language(s)' fields.
 == Project creation and maintenance Help/Support ==