User:B42/Test: Difference between revisions

From base48
imported>B42
No edit summary
imported>B42
Line 13: Line 13:


=== Copy and Paste Template for Projects ===
=== 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>
<pre>
{{Project
{{Project
|name=*
  |founder=
|image=http://wiki.base48.cz/skins/base.png
  |status=
  |founder=*
  |shortdesc=
|coops=
|swlic=
|hwlic=
  |status=*
|tags=*
|github=
  |shortdesc=*
|created=*
|curr_version=
|os=
|arch=
|proglang=
}}
}}
</pre>
</pre>

Revision as of 21:29, 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=
}}

Mandatory parameters

founder (mandatory)

This field should contain the list of founders or the founder himself.

If there are multiple founders, then list them with the separator character ','

Example:

|founder=name1,name2,name3

status (mandatory)

The value of this field, will be displayed as the status of the project

Optional parameter

name (optional)

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 than the name of the project page, you can use this field to set a display name.

created (optional)

currently not implemented This field should be set to the date the project was started. The value should have the following format: YYYY-MM-DD

Example:

|created=2012-03-16

tags (optional)

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

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:

|coops=name1,name2,name3

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:

|github=user/repo

It will be expanded to the full github url and displayed as link.

Example:

|shortdesc=This project's aim consists of the following points:
* First point
* Second point
* Third point

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

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.