Skeleton: Difference between revisions

From base48
imported>B42
(→‎Append to projects list: Mention Template:StaleProjectList)
imported>B42
No edit summary
Line 1: Line 1:
{{Project}}
{{Project
 
|name=Skeleton
 
|image=http://wiki.base48.cz/skins/base.png
 
|founder=evilissimo
[[Skeleton/meta|Go to Meta Data]]
|status=closed
 
|tags=wiki,template
|shortdesc=Skeleton project for the project templates used in this wiki. Including the documentation for it.
|created=2012-03-14
}}


= Project page =
= Project page =

Revision as of 23:30, 24 December 2012


Project page

Put in the beginning of the project the following line:

{{Project}}

This will put your project into the projects category and it will render the Project info box on the right side of the content. For the Project info box to be shown, you have to edit the 'Your Project Page Name/meta' sub page. Please see in the following section how this file must look like and what meta information can be filled.

Meta sub page

Copy and Paste Template for Projects

The first like has to stay like this. Please do not modify it, as it could break the displaying of the lists or meta info boxes. NOTE: Please remove the optional fields you don't need from the list, otherwise it could have unwanted side effects on the layout.
Stars mark the fields that are mandatory.

{{{{ProjectMetaFormat|format={{{format}}}}}|tag_filter={{{tag_filter|}}}
 |name=*
 |wikiPageName=*
 |image=
 |founder=*
 |coops=
 |swlic=
 |hwlic=
 |status=*
 |tags=*
 |github=
 |shortdesc=*
 |created=*
 |curr_version=
 |os=
 |arch=
 |proglang=
}}

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:

|name=Skeleton

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:

|name=Other DisplayName example
|wikiPageName=Skeleton


image (optional)

This value should contain either a like or a File/Image wiki tag Please ensure that the image is not bigger than 290px. NOTE: Bigger images will destroy the layout of the Project Page Meta field.

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

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.

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:

|github=user/repo

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:

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

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:

|created=2012-03-16

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.

Append to projects list

In order to display the project in all project lists on the wiki, you'll have to add a line for your project in the following list: Template:ProjectList. Projects lacking activity should be moved to Template:StaleProjectList (and moved back if they are revived).

Example:

{{ProjectListItem|Your Page Name Here|{{{1|list}}}|{{{2|}}}}}

Please just modify the part which says 'Your Page Name Here', in order to have the items working.

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. :-)