Skeleton/meta/doc - Revision history

imported>Martian742: adding stars to the template for better visual guidance after pasting, to know what is mandatory

2012-05-01T20:33:04Z

adding stars to the template for better visual guidance after pasting, to know what is mandatory

← Older revision		Revision as of 20:33, 1 May 2012
Line 1:		Line 1:

	== Copy and Paste Template for Projects ==		== 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.'''		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.<br>
			Stars mark the fields that are mandatory.'''
	<pre>		<pre>
	{{{{ProjectMetaFormat\|format={{{format}}}}}\|tag_filter={{{tag_filter\|}}}		{{{{ProjectMetaFormat\|format={{{format}}}}}\|tag_filter={{{tag_filter\|}}}
	\|name=		\|name=*
	\|wikiPageName=		\|wikiPageName=*
	\|image=		\|image=
	\|founder=		\|founder=*
	\|coops=		\|coops=
	\|swlic=		\|swlic=
	\|hwlic=		\|hwlic=
	\|status=		\|status=*
	\|tags=		\|tags=*
	\|github=		\|github=
	\|shortdesc=		\|shortdesc=*
	\|created=		\|created=*
	\|curr_version=		\|curr_version=
	\|os=		\|os=

imported>Evilissimo at 01:11, 16 March 2012

2012-03-16T01:11:53Z

← Older revision		Revision as of 01:11, 16 March 2012
Line 79:		Line 79:
	* sw - Software project		* sw - Software project
	* template - template page for common things (for example this project)		* template - template page for common things (for example this project)
			* wiki - projects related to this wiki
	* infrastructure - Base 48 infrastructure related projects		* infrastructure - Base 48 infrastructure related projects

imported>Evilissimo at 01:02, 16 March 2012

2012-03-16T01:02:06Z

← Older revision		Revision as of 01:02, 16 March 2012
Line 1:		Line 1:

	= Copy and Paste Template for Projects =		== 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.'''		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.'''
	<pre>		<pre>

imported>Evilissimo: Created page with " = 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. '''N..."

2012-03-16T01:01:37Z

Created page with " = 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. '''N..."

New 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.'''
<pre>
{{{{ProjectMetaFormat|format={{{format}}}}}|tag_filter={{{tag_filter|}}}
|name=
|wikiPageName=
|image=
|founder=
|coops=
|swlic=
|hwlic=
|status=
|tags=
|github=
|shortdesc=
|created=
|curr_version=
|os=
|arch=
|proglang=
}}
</pre>

== 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
|wikiPageName=Skeleton
</pre>

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