Skeleton: Difference between revisions

Revision as of 22:47, 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; NOT IMPLEMENTED
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

Project creation and maintenance Help/Support

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

@@ Line 10: / Line 10: @@
 == Project page ==
-To mark a page as project, use the <nowiki>{{Project}}</nowiki> 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.
+To mark a page as project, use the <nowiki>{{Project}}</nowiki> 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 ===
-'''NOTE: Please remove the optional fields you don't need from the list, otherwise it could have unwanted side effects on the layout.<br>
+This is a minimal working template for a project. You can add other, optional parameters.
-Stars mark the fields that are mandatory.'''
 <pre>
 {{Project
- |name=*
+  |founder=
- |wikiPageName=*
+  |status=
- |image=http://wiki.base48.cz/skins/base.png
+  |shortdesc=
-  |founder=*
- |coops=
- |swlic=
- |hwlic=
-  |status=*
- |tags=*
- |github=
-  |shortdesc=*
- |created=*
- |curr_version=
- |os=
- |arch=
- |proglang=
 }}
 </pre>
+Project with parameters for additional properties can look like this:
-=== Parameter Description ===
-==== name (mandatory) ====
-Reflects the name of the project.
-This field has 2 functions:
-* Display Name
-* Page Name + Display Name
-If you would like to show an other name in the meta information sections, than the name of the page, you can use this field to set a display name.
-In this case you will have to set the 'wikiPageName' field to the name of the page.
-For this skeleton project page it looks like this:
-<pre>|name=Skeleton</pre>
-It is the name of the project page. Therefore the 'wikiPageName' field is not necessary.
-==== wikiPageName (optional) ====
-If this field is used, when the 'name' field will be only used as display name. Then the value of this field, will be used as project page name.
-Example: If we would like to use the display name 'Other DisplayName example' instead of the name 'Skeleton', we would write it like this:
 <pre>
-|name=Other DisplayName example
+ |name=Base48 Rostock
-|wikiPageName=Skeleton
+ |image=Rostock.jpg
+ |founder=rmarko
+ |coops=hyna,arius,cubz
+ |hwlic=GPL
+ |status=active
+ |tags=hw
+ |shortdesc=Our Rostock
+ |created=2012-11-11
 </pre>
+=== Mandatory parameters ===
-==== image (optional) ====
+; founder
-This value should contain a File/Image wiki tag or a plain URL.
+: who created the project and/or who is the main contact person for it
-Please ensure that the image is not bigger than 290px. '''NOTE:''' ''Bigger images will destroy the layout of the Project Page Meta field.''
+; status
+: idea, active, or closed
-==== founder (mandatory) ====
+: '''NEED MORE INFO'''
-This field should contain the list of founders or the founder himself.
+; shortdesc
+: short (less than 255 characters) description of the project
-If there are multiple founders, then list them with the separator character ','
-Example:<pre>|founder=name1,name2,name3</pre>
-==== 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.
-==== status (mandatory) ====
-The value of this field, will be displayed as the status of the project
-==== tags (mandatory) ====
-This will help to automatically group the project in several lists we are displaying.
-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.
-==== shortdesc (mandatory) ====
-It should contain a short description of the project. This value may contain multiple lines and formatting for the text. Like making something bold etc. Yes, lists can be used as well.
-Example:
-<pre>|shortdesc=This project's aim consists of the following points:
-* First point
-* Second point
-* Third point</pre>
-==== created (mandatory) ====
-This field should be set to the date the project was started. The value should have the following format: YYYY-MM-DD
-Example:<pre>|created=2012-03-16</pre>
-==== 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) ====
+=== Optional parameters ===
-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) ====
+; name
-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.
+: 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
+: '''NOT IMPLEMENTED'''
+; tags
+: list of keywords that will allow to add project to relevant categories
+: see the [[#Tags|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
-==== proglang (optional) ====
+=== Tags ===
-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.
+; hw
+: hardware project
+; sw
+: software project
+; wiki
+: projects related to this wiki
+; infrastructure
+: base 48 infrastructure related projects
 == Project creation and maintenance Help/Support ==
-<del>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. :-)</del>
-Since the project template has been heavily tampered with, contact [[User:b42|b42]] if you need any help.
+Please contact [[User:b42]] for help or feature requests. The original project templates were written by [[User:evilissimo]].