MAG:Templates

(→Open/Closed table, justification, and petition templates)
(→Template examples: add ambox and template links)
 
(16 intermediate revisions not shown)
Line 1: Line 1:
-
[http://www.mediawiki.org/wiki/Help:Templates Templates] are an important part of any good mediawiki wiki. They help tag, categorize, identify, stylize and format articles, and improve code readability and clarity, and generally make life easier for everybody.
+
[http://www.mediawiki.org/wiki/Help:Templates Templates] are an important part of any good wiki. They help tag, categorize, identify, stylize and format articles, and improve code readability and clarity, and generally make life easier for everybody.
To that end, I'd like to focus efforts here on creating and maintaining a set of templates for maemowiki.
To that end, I'd like to focus efforts here on creating and maintaining a set of templates for maemowiki.
Line 12: Line 12:
=== Open/Closed table, justification, and petition templates ===
=== Open/Closed table, justification, and petition templates ===
-
We need to put together templates for the open/closed-source plan outlined in the [[Increasing transparency]] page.
+
We need to put together templates for the open/closed-source plan outlined in the [[Task:Mapping openness]] page.
* We need templates for:
* We need templates for:
Line 18: Line 18:
*** Should these templates be set up as "justification tables" to be inserted into larger articles or as individual articles?
*** Should these templates be set up as "justification tables" to be inserted into larger articles or as individual articles?
** Petition templates for requesting that a closed package be opened.
** Petition templates for requesting that a closed package be opened.
-
** Pages maintained by Nokia and containing official information/documentation. They should have a clear notice with Nokia logo on top. It is likely that they would be editable only by a certain group, having the discussion page open for comments. This should be explained in the banner as well.--[[User:qgil|qgil]] 07:53, 28 June 2008 (UTC)
 
-
::''Just started on a more robust and centralized messagebox system. Looks will be controlled from [[Mediawiki:Common.css|Common.css]], will need to figure out the look and a color-coding system. Do you have a specific Nokia logo you'd like used for this particular box? See [[Template:Official]] —[[User:generalantilles|GeneralAntilles]] 08:33, 28 June 2008 (UTC)''
 
-
::[http://maemo.org/midcom-static/style_maemo2007/nokia-logo.gif This one] instead of the traffic signal would do the trick, thanks. Don't get too obsessed about layout design, color schemes... The pages still need to look maemo.org and not Nokia. These docs in the wiki are "Nokia unstable" documentation, full Nokia official and stable docs and pages need to be under the nokia.com domain. In any case you might want to have a look at the [http://wiki.forum.nokia.com/index.php/Wiki_Home Forum Nokia MediaWiki] for inspiration. From my point of view, Nokia logo on top of white background for the banner would do.--[[User:qgil|qgil]] 09:38, 28 June 2008 (UTC)
 
-
::As for the wording, what about "This page may only be edited by Nokia contributors. Please see the talk page for discussion."--[[User:qgil|qgil]] 09:43, 28 June 2008 (UTC)
 
-
:::Looks good! Is it there a public page listing the users that are Nokia contributors with permissions to edit? If so, it would be good to link it from "Nokia contributors" for full transparency on who can edit. If not, no problem.--[[User:qgil|qgil]] 09:55, 28 June 2008 (UTC)
 
-
::::[[Special:ListUsers/nokiaeditors]] should do it. —[[User:generalantilles|GeneralAntilles]] 10:14, 28 June 2008 (UTC)
 
-
:* Equivalent to "This article is a stub, please help expanding it."--[[User:qgil|qgil]] 07:53, 28 June 2008 (UTC)
 
-
:* Equivalent to "This article is probably outdated, please help updating it."--[[User:qgil|qgil]] 07:53, 28 June 2008 (UTC)
 
-
:* Equivalent to "This article has poor language/grammar, please help fixing it."--[[User:qgil|qgil]] 07:53, 28 June 2008 (UTC)
 
-
:* Template to identify tasks? Open/Completed?--[[User:qgil|qgil]] 07:53, 28 June 2008 (UTC)
 
-
== Types of templates ==
+
=== Standard Wikipedia template set ===
-
There are effectively two types of templates that need to be created:
+
* Equivalent to "This article has poor language/grammar, please help fixing it."--[[User:qgil|qgil]] 07:53, 28 June 2008 (UTC)
-
=== Transcluded ===
+
== Template examples ==
-
First, we have transcluded templates are those that help in navigation, organization, categorization, and tagging. They are designed to maintain uniform look and format across the entire wiki. These will constitute the bulk of the work. Things like,
+
-
* [[Template:Main]]:
+
-
{{main|Maemowiki Action Group}}
+
-
* [[Template:100Days agenda]]:
+
-
{{100Days agenda}}
+
-
* [[Template:Community]]:
+
-
{{Community}}
+
-
=== Substituted ===
+
=== ambox ===
-
Second, we have substituted templates, which are those that provide skeletal frameworks for certain types of pages. These will include things like the Close-source justification page, and open-source petition page.
+
-
For example, an early version of such a template is [[Template:Plan metadata]] (see [[User:jaffa/Sandbox]] for example usage). One thing to note is that nice, clean CSS classes like "wikitable" do not seem to be present in maemowiki at the moment.
+
Usage:
 +
<pre>
 +
{{ambox
 +
|type=notice
 +
|text='''Body text for the box.'''<br/>It is suggested to make the first line bold.
 +
}}
 +
</pre>
 +
 
 +
Use the [[Template:Ambox|ambox template]] to insert a box for a warning or notice. The "<code>type</code>" parameter can be omitted and defaults to "<code>notice</code>". There are several templates based on the ambox, such as [[Template:Delete]], [[Template:Out of date]] and [[Template:Expand]].
 +
 
 +
=== clear ===
 +
 
 +
Usage:
 +
<pre>{{clear}}</pre>
 +
 
 +
Use the [[Template:Clear|clear template]] to insert HTML that clears any floats. This is used at the end of a section with floating divs, such as image thumbnails, to make sure that they do not overflow onto the next section. See the [[Orrery]] article for example usage.
 +
 
 +
=== main ===
 +
 
 +
Usage:
 +
<pre>{{main|Wikilink to main article}}</pre>
 +
 
 +
Use the [[Template:Main|main template]] to insert a wikilink to another article, which appears indented and preceded by "''Main article:''".
 +
 
 +
[[Category:Community]]
 +
[[Category:Wiki]]

Latest revision as of 09:52, 1 March 2011

Templates are an important part of any good wiki. They help tag, categorize, identify, stylize and format articles, and improve code readability and clarity, and generally make life easier for everybody.

To that end, I'd like to focus efforts here on creating and maintaining a set of templates for maemowiki.

Contents

[edit] Tasks

  • Develop guidelines for the creation, categorization, style and format of new templates.
    • Ensure existing templates comply with these guidelines.
  • Figure out what templates we need (this is a very fluid task that will likely never be completed).
  • Create those templates.

[edit] Open/Closed table, justification, and petition templates

We need to put together templates for the open/closed-source plan outlined in the Task:Mapping openness page.

  • We need templates for:
    • Individual packages (or package sets, as, say, alarmd and alarmtool can probably both be filed under alarmd), their source-state and (if closed) justification for that state.
      • Should these templates be set up as "justification tables" to be inserted into larger articles or as individual articles?
    • Petition templates for requesting that a closed package be opened.

[edit] Standard Wikipedia template set

  • Equivalent to "This article has poor language/grammar, please help fixing it."--qgil 07:53, 28 June 2008 (UTC)

[edit] Template examples

[edit] ambox

Usage: 

{{ambox
|type=notice
|text='''Body text for the box.'''<br/>It is suggested to make the first line bold.
}}

Use the ambox template to insert a box for a warning or notice. The "type" parameter can be omitted and defaults to "notice". There are several templates based on the ambox, such as Template:Delete, Template:Out of date and Template:Expand.

[edit] clear

Usage: 

{{clear}}

Use the clear template to insert HTML that clears any floats. This is used at the end of a section with floating divs, such as image thumbnails, to make sure that they do not overflow onto the next section. See the Orrery article for example usage.

[edit] main

Usage: 

{{main|Wikilink to main article}}

Use the main template to insert a wikilink to another article, which appears indented and preceded by "Main article:".

Retrieved from "http://bugs.maemo.org/MAG:Templates"