Template:Project/doc

From base48
Revision as of 21:17, 12 February 2016 by imported>B42 (explain how to create new page)



Project page

To add new project, create a page with the project name as a title (don't be afraid to use spaces/punctuation). Quickest way to create a new page is to type its name into the search box, click Go, and then Create the page link.

To mark the new page as 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:

{{Project
 |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
tags
list of keywords that will allow to add project to relevant categories
see the Tags section for current list of tags
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
created
date when the project was started, if not set, the date of the page creation will be used instead
accepts the YYYY-MM-DD format

Tags

hw
hardware project
sw
software project
wiki
projects related to this wiki
infrastructure
base 48 infrastructure related projects

Project creation and maintenance Help/Support

Please contact User:b42 for help or feature requests. The original project templates were written by User:evilissimo.