Templates

From Openmoko

(Difference between revisions)
Jump to: navigation, search
(Added all currently possible templates with examples)
 
(38 intermediate revisions by 7 users not shown)
Line 1: Line 1:
Templates are little snippets what you can insert while editing the Wiki. They will be automatically replaced to the tempate's content, for example a large blue box with predefined text, when viewing the page.
+
{{Languages|Templates}}
 +
Templates are little snippets between double accolades what you can insert while editing the Wiki. They will be automatically replaced to the template's content, for example a large blue box with predefined text, when viewing the page.
  
 
The following templates are used for documentation. Click on template names to link to their page for more information. You can copy-paste the examples directly from this page into your article
 
The following templates are used for documentation. Click on template names to link to their page for more information. You can copy-paste the examples directly from this page into your article
 +
 +
Templates are wiki pages that start with the string "Template:". They are in a separate namespace separate from the main wiki pages, so they do not appear in search results by default. There is a "Template" category, for now unsubdivided. You can see [http://wiki.openmoko.org/index.php?title=Special%3AAllpages&from=&namespace=10 all available templates here].
  
 
== Templates for editor notes on pages ==
 
== Templates for editor notes on pages ==
 +
 +
These templates are temporary. They are meant to be removed when the requested edit has been performed. So we give them the yellow "Post-it note" background.
  
 
=== [[:Template:Citation needed]]===
 
=== [[:Template:Citation needed]]===
Line 11: Line 16:
 
<pre>
 
<pre>
 
{{Citation needed}}
 
{{Citation needed}}
 +
</pre>
 +
 +
=== [[:Template:Delete]]===
 +
 +
To propose a page for speedy deletion.
 +
{{Delete|we need examples. But don't do it !|Minh}}
 +
<pre>
 +
{{Delete|Reason for deletion|Signature}}
 
</pre>
 
</pre>
  
Line 23: Line 36:
 
</pre>
 
</pre>
  
===[[:Template:Hardware_Wishlist]]===
+
===[[:Template:Improve]]===
  
An idea or request for a hardware change:
+
When you want to mark an incomplete Wiki section. This template will add the article to the Improve category.
  
{{Hardware_Wishlist}}
+
{{Improve}}
  
 
<pre>
 
<pre>
{{Hardware_Wishlist}}
+
{{Improve}}
 
</pre>
 
</pre>
  
===[[:Template:Improve]]===
 
  
When you want to mark an incomplete Wiki section:
+
===[[:Template:Signature]]===
  
{{Improve}}
+
Telling people to add their signature:
 +
 
 +
{{Signature}}
  
 
<pre>
 
<pre>
{{Improve}}
+
{{Signature}}
 
</pre>
 
</pre>
  
===[[:Template:InProgress]]===
+
=== [[:Template:Stub]] ===
  
When a feature is not yet ready, but is in progress:
+
Mark an article or section which needs to be written.
  
{{InProgress}}
+
{{Stub}}
  
 
<pre>
 
<pre>
{{InProgress}}
+
{{Stub}}
 
</pre>
 
</pre>
  
===[[:Template:Main]]===
+
===[[:Template:Todo]]===
  
When a section in an article is basically a reference to another complete Wiki page, you can supress longer explanation by linking to the main page.
+
Section or article which needs to be written, development or other task which has to be done.
  
{{Main|Qtopia}}
+
{{todo|The todo text comes here}}
  
 
<pre>
 
<pre>
{{Main|Another article}}
+
{{todo|The todo text comes here}}
 
</pre>
 
</pre>
 +
 +
== Templates for emphasizing boxes ==
  
 
===[[:Template:Note]]===
 
===[[:Template:Note]]===
Line 73: Line 89:
 
</pre>
 
</pre>
  
===[[:Template:Outdated]]===
+
===[[:Template:Warning]]===
  
Mark outdated information:
+
Things where extra caution should be taken:
  
{{Outdated}}
+
{{Warning|your text here}}
  
 
<pre>
 
<pre>
{{Outdated}}
+
{{Warning|your text here}}
 
</pre>
 
</pre>
  
===[[:Template:ProgressUnknown]]===
 
  
Progress unknown:
+
== Templates for relevance warning boxes ==
  
{{ProgressUnknown}}
+
===[[:Template:Hardware_Wishlist]]===
  
<pre>
+
An idea or request for a hardware change:
{{ProgressUnknown}}
+
</pre>
+
  
===[[:Template:Signature]]===
+
{{Hardware_Wishlist}}
 
+
Telling people to add their signature:
+
 
+
{{Signature}}
+
  
 
<pre>
 
<pre>
{{Signature}}
+
{{Hardware_Wishlist}}
 
</pre>
 
</pre>
  
===[[:Template:Special_Hardware]]===
+
===[[:Template:InProgress]]===
  
Notification about unusual hardware stuff:
+
When a feature is not yet ready, but is in progress:
  
{{Special_Hardware}}
+
{{InProgress}}
  
 
<pre>
 
<pre>
{{Special_Hardware}}
+
{{InProgress}}
 
</pre>
 
</pre>
  
=== [[:Template:Stub]] ===
+
===[[:Template:Outdated]]===
  
Mark an article or section which needs to be written.
+
Mark outdated information:
  
{{Stub}}
+
{{Outdated}}
  
 
<pre>
 
<pre>
{{Stub}}
+
{{Outdated}}
 
</pre>
 
</pre>
  
===[[:Template:Todo]]===
 
  
Section or article which needs to be written, development or other task which has to be done.
 
  
{{todo|The todo text comes here}}
+
===[[:Template:Wishlist]]===
  
<pre>
+
Openmoko wishlist item, not hardware (see Hardware_Wishlist above).
{{todo|The todo text comes here}}
+
</pre>
+
  
===[[:Template:Unimplemented]]===
+
{{Wishlist}}
 
+
Unimplemented things:
+
 
+
{{Unimplemented}}
+
  
 
<pre>
 
<pre>
{{Unimplemented}}
+
{{Wishlist}}
 
</pre>
 
</pre>
  
===[[:Template:Warning]]===
+
== External links templates ==
  
Things where extra caution should be taken:
+
===[[:Template:Ticket]]===
  
{{Warning|your text here}}
+
An external link to a ticket on the general trac. The template does not care if the ticket is closed or open.
 +
 
 +
{{Ticket|1024}}
  
 
<pre>
 
<pre>
{{Warning|your text here}}
+
{{Ticket|1024}}
 
</pre>
 
</pre>
  
===[[:Template:Wishlist]]===
+
===[[:Template:opkg]]===
  
Openmoko wishlist item, not hardware (see Hardware_Wishlist above).
+
An external link to an application page on opkg.org.
  
{{Wishlist}}
+
{{opkg.org|33|Xlogical}}
  
 
<pre>
 
<pre>
{{Wishlist}}
+
{{opkg.org|33|Xlogical}}
 
</pre>
 
</pre>
  
Line 173: Line 176:
 
<pre>
 
<pre>
 
{{Languages}}
 
{{Languages}}
 +
</pre>
 +
 +
 +
===[[:Template:Main]]===
 +
 +
When a section in an article is basically a reference to another complete Wiki page, you can supress longer explanation by linking to the main page.
 +
 +
{{Main|Qtopia / Qt Extended on FreeRunner}}
 +
 +
<pre>
 +
{{Main|Another article}}
 
</pre>
 
</pre>
  
Line 184: Line 198:
 
!FreeRunner
 
!FreeRunner
 
|-
 
|-
|Feautre 1
+
|Feature 1
 
|{{Yes}}
 
|{{Yes}}
 
|{{No}}
 
|{{No}}
Line 204: Line 218:
 
Software planning tables:
 
Software planning tables:
  
{| class="wikitable sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"  
+
{| class="wikitable sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
 
|-style="background: #ececec; white-space:nowrap;"
 
|-style="background: #ececec; white-space:nowrap;"
!Status  
+
!Status
 
!Project name
 
!Project name
 
!Description
 
!Description
!Contact  
+
!Contact
 
{{FeatureDone|Project|Description|email|Name}}
 
{{FeatureDone|Project|Description|email|Name}}
 
{{FeatureTodo|Project|Description|email|Name}}
 
{{FeatureTodo|Project|Description|email|Name}}
Line 231: Line 245:
 
* [[:Template:FeatureTodo]]
 
* [[:Template:FeatureTodo]]
  
== Page templates ==
+
== Navigation boxes ==
  
 +
Navigation boxes provide inter-pages links to related subjects. There can be also "See also" and "References" sections at the end of the page. How to best this implement interpage contextual navigation is still under discussion. Trial and error !
  
* [[Sample Native-Finger Application]]
+
Current issues:
* [[Sample Native-Stylus Application]]
+
* Standardize colors: Background: orange/black, white, CSS-defined.
* [[Sample Panel Application]]
+
* Standardize width and position. We must try wide and at the bottom of the page
 +
* Get rid of aliases and redirects.
 +
* Rename consistently, i.e. Template:navbox ***
 +
 
 +
Reference: http://en.wikipedia.org/wiki/Wikipedia:Navigational_templates
 +
 
 +
=== [[:Template:Om 2008.8]] ===
 +
 
 +
{{Om 2008.8}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
=== [[:Template:OM2007.2]] ===
 +
 
 +
{{OM2007.2}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
=== [[:Template:FSO]] ===
 +
 
 +
{{FSO}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
=== [[:Template:SHR]] ===
 +
 
 +
{{SHR}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
=== [[:Template:Neo FreeRunner Menu]] ===
 +
 
 +
Todo: change all references to the old template Gta02menu to this one, then delete old template.
 +
 
 +
{{Neo FreeRunner Menu}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
=== [[:Template:Introbox]] ===
 +
 
 +
{{Introbox}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
{{Hdsupport|Hdsupport}}
 +
 
 +
<div class="visualClear">&nbsp;</div>
 +
 
 +
== Semantic boxes ==
 +
 
 +
=== [[:Template:ApplicationBox]] ===
 +
 
 +
{{ApplicationBox|
 +
Name=Gpe-FileManager|
 +
Description=A file manager application with MIME types and remote access support from the the GPE Palmtop Environment (GPE) project.|
 +
Screenshot=Gpe-filemanager.png|
 +
Homepage=http://gpe.linuxtogo.org|
 +
TestedOn=Om2008.8|
 +
PackageName=gpe-filemanager
 +
}}
 +
 
 +
<pre>
 +
{{ApplicationBox|
 +
Name=Gpe-FileManager|
 +
Description=A file manager application with MIME types and remote access support from the the GPE Palmtop Environment (GPE) project.|
 +
Screenshot=Gpe-filemanager.png|
 +
Homepage=http://gpe.linuxtogo.org|
 +
TestedOn=Om2008.8|
 +
PackageName=gpe-filemanager
 +
}}
 +
 
 +
</pre>
 +
 
 +
=== [[:Template:Works]] ===
 +
 
 +
{| style="float:right" border='0' cellspacing=4 cellpadding='4' rules=all align=right style='background-color:#333333;font-weight:bold;font-size:smaller;'
 +
!<FONT COLOR="#FF6600">Hardware</FONT>
 +
!<FONT COLOR="#FF6600">Works</FONT>
 +
|-
 +
|<FONT COLOR="#FF6600">Neo 1973</FONT>
 +
|{{{Neo1973}}}
 +
|-
 +
|<FONT COLOR="#FF6600">FreeRunner</FONT>
 +
|{{{FreeRunner}}}
 +
|-
 +
|<FONT COLOR="#FF6600">HTC-Dream</FONT>
 +
|{{{HTC-Dream}}}
 +
|-
 +
|<FONT COLOR="#FF6600">Other</FONT>
 +
|{{{Other}}}
 +
|}
 +
<br style="clear: both">
 +
<pre>
 +
{| style="float:right" border='0' cellspacing=4 cellpadding='4' rules=all align=right style='background-color:#333333;font-weight:bold;font-size:smaller;'
 +
!<FONT COLOR="#FF6600">Hardware</FONT>
 +
!<FONT COLOR="#FF6600">Works</FONT>
 +
|-
 +
|<FONT COLOR="#FF6600">Neo 1973</FONT>
 +
|{{{Neo1973}}}
 +
|-
 +
|<FONT COLOR="#FF6600">FreeRunner</FONT>
 +
|{{{FreeRunner}}}
 +
|-
 +
|<FONT COLOR="#FF6600">HTC-Dream</FONT>
 +
|{{{HTC-Dream}}}
 +
|-
 +
|<FONT COLOR="#FF6600">Other</FONT>
 +
|{{{Other}}}
 +
|}
 +
</pre>
  
{{Languages|Templates}}
 
  
 
[[Category:Templates| ]]
 
[[Category:Templates| ]]
 +
[[Category:Wiki Editing]]

Latest revision as of 15:40, 20 October 2009

Templates are little snippets between double accolades what you can insert while editing the Wiki. They will be automatically replaced to the template's content, for example a large blue box with predefined text, when viewing the page.

The following templates are used for documentation. Click on template names to link to their page for more information. You can copy-paste the examples directly from this page into your article

Templates are wiki pages that start with the string "Template:". They are in a separate namespace separate from the main wiki pages, so they do not appear in search results by default. There is a "Template" category, for now unsubdivided. You can see all available templates here.

Contents

[edit] Templates for editor notes on pages

These templates are temporary. They are meant to be removed when the requested edit has been performed. So we give them the yellow "Post-it note" background.

[edit] Template:Citation needed

When a Citation needed

to confirm a statement:
{{Citation needed}}

[edit] Template:Delete

To propose a page for speedy deletion.

Proposed for deletion: This page is proposed for deletion. Please see Wiki Issues#Pages proposed for deletion to discuss this proposal.
{{Delete|Reason for deletion|Signature}}

[edit] Template:Editing

When you do a large cleanup on a page for some days:

Editing: (08/05/2008) This page is being edited by Kempelen: your notes...

If this note persists without edits in the history, feel free to remove the Editing template from the page.


{{Editing|your_username_here|date_here|editing_summary_here}}

[edit] Template:Improve

When you want to mark an incomplete Wiki section. This template will add the article to the Improve category.

Need improvement: This article or section needs improving. Feel free to add content.
{{Improve}}


[edit] Template:Signature

Telling people to add their signature:

Add your signature! In order to help others follow the discussion, please add your signature.

You can automatically add your signature by typing the signature tag --~~~~ or using the 2nd button from the right above your input box.


{{Signature}}

[edit] Template:Stub

Mark an article or section which needs to be written.

Stub: This is a stub. You can help OpenMokoWiki by expanding it.


{{Stub}}

[edit] Template:Todo

Section or article which needs to be written, development or other task which has to be done.

TODO: The todo text comes here (See: To-Do List)
{{todo|The todo text comes here}}

[edit] Templates for emphasizing boxes

[edit] Template:Note

To add an important note to a paragraph or article:

NOTE: This is an important note here.


{{Note|your text}}

[edit] Template:Warning

Things where extra caution should be taken:

WARNING: your text here


{{Warning|your text here}}


[edit] Templates for relevance warning boxes

[edit] Template:Hardware_Wishlist

An idea or request for a hardware change:

Hardware wishes warning! This article or section documents a Hardware Wish List item, the features described here may or may not be implemented in future devices.
{{Hardware_Wishlist}}

[edit] Template:InProgress

When a feature is not yet ready, but is in progress:

In progress: This article or section documents one or more features whose implementation are in progress.
{{InProgress}}

[edit] Template:Outdated

Mark outdated information:

Outdated warning ! This article or section is significantly outdated, either by significant hardware or software changes. Procedures mentioned in this page may well not work for current hardware/software.


{{Outdated}}


[edit] Template:Wishlist

Openmoko wishlist item, not hardware (see Hardware_Wishlist above).

Wishes warning! This article or section documents one or more OpenMoko Wish List items, the features described here may or may not be implemented in the future.
{{Wishlist}}

[edit] External links templates

[edit] Template:Ticket

An external link to a ticket on the general trac. The template does not care if the ticket is closed or open.

ticket 1024

{{Ticket|1024}}

[edit] Template:opkg

An external link to an application page on opkg.org.

Xlogical

{{opkg.org|33|Xlogical}}

[edit] Content templates

[edit] Template:Languages

The links to all other languages:


{{Languages}}


[edit] Template:Main

When a section in an article is basically a reference to another complete Wiki page, you can supress longer explanation by linking to the main page.

Main article: Qtopia / Qt Extended on FreeRunner


{{Main|Another article}}

[edit] Template:Yes, Template:No, Template:Maybe, Template:Unknown

For tables with various featrure lists and others, where these values are possible.

Neo 1973 FreeRunner
Feature 1 yes no
Feature 2 maybe


?


{{Yes}}
{{No}}
{{Maybe}}
{{Unknown}}

[edit] Status table rows

Software planning tables:

Status Project name Description Contact
DONE Project Description Name <email>



TODO Project Description Name <email>



{{feature|white|white|Status|Project|Description|email|Name}}
{{FeatureDone|Project|Description|email|Name}}
{{FeatureInProgress|Project|Description|email|Name}}
{{FeatureRedo|Project|Description|email|Name}}
{{FeatureTodo|Project|Description|email|Name}}

Available status table rows:

[edit] Navigation boxes

Navigation boxes provide inter-pages links to related subjects. There can be also "See also" and "References" sections at the end of the page. How to best this implement interpage contextual navigation is still under discussion. Trial and error !

Current issues:

  • Standardize colors: Background: orange/black, white, CSS-defined.
  • Standardize width and position. We must try wide and at the bottom of the page
  • Get rid of aliases and redirects.
  • Rename consistently, i.e. Template:navbox ***

Reference: http://en.wikipedia.org/wiki/Wikipedia:Navigational_templates

[edit] Template:Om 2008.8


 

[edit] Template:OM2007.2

Om 2007.2

(Other distributions)


 

[edit] Template:FSO

Key pages on:
FSO

(Other distributions)


 

[edit] Template:SHR

Template:SHR

 

[edit] Template:Neo FreeRunner Menu

Todo: change all references to the old template Gta02menu to this one, then delete old template.


 

[edit] Template:Introbox

Introduction


 
Hardware
 

[edit] Semantic boxes

[edit] Template:ApplicationBox

Gpe-filemanager.png Gpe-FileManager

A file manager application with MIME types and remote access support from the the GPE Palmtop Environment (GPE) project.


Homepage: http://gpe.linuxtogo.org
Package: gpe-filemanager
Tested on: Om2008.8


{{ApplicationBox|
Name=Gpe-FileManager|
Description=A file manager application with MIME types and remote access support from the the GPE Palmtop Environment (GPE) project.|
Screenshot=Gpe-filemanager.png|
Homepage=http://gpe.linuxtogo.org|
TestedOn=Om2008.8|
PackageName=gpe-filemanager
}}

[edit] Template:Works

Hardware Works
Neo 1973 {{{Neo1973}}}
FreeRunner {{{FreeRunner}}}
HTC-Dream {{{HTC-Dream}}}
Other {{{Other}}}


{| style="float:right" border='0' cellspacing=4 cellpadding='4' rules=all align=right style='background-color:#333333;font-weight:bold;font-size:smaller;'
!<FONT COLOR="#FF6600">Hardware</FONT>
!<FONT COLOR="#FF6600">Works</FONT>
|-
|<FONT COLOR="#FF6600">Neo 1973</FONT>
|{{{Neo1973}}}
|-
|<FONT COLOR="#FF6600">FreeRunner</FONT>
|{{{FreeRunner}}}
|-
|<FONT COLOR="#FF6600">HTC-Dream</FONT>
|{{{HTC-Dream}}}
|-
|<FONT COLOR="#FF6600">Other</FONT>
|{{{Other}}}
|}
Views
Personal tools

Templates are little snippets what you can insert while editing the Wiki. They will be automatically replaced to the tempate's content, for example a large blue box with predefined text, when viewing the page.

The following templates are used for documentation. Click on template names to link to their page for more information. You can copy-paste the examples directly from this page into your article

Templates for editor notes on pages

Template:Citation needed

When a Citation needed

to confirm a statement:
{{Citation needed}}

Template:Editing

When you do a large cleanup on a page for some days:

Editing: (08/05/2008) This page is being edited by Kempelen: your notes...

If this note persists without edits in the history, feel free to remove the Editing template from the page.


{{Editing|your_username_here|date_here|editing_summary_here}}

Template:Hardware_Wishlist

An idea or request for a hardware change:

Hardware wishes warning! This article or section documents a Hardware Wish List item, the features described here may or may not be implemented in future devices.
{{Hardware_Wishlist}}

Template:Improve

When you want to mark an incomplete Wiki section:

Need improvement: This article or section needs improving. Feel free to add content.
{{Improve}}

Template:InProgress

When a feature is not yet ready, but is in progress:

In progress: This article or section documents one or more features whose implementation are in progress.
{{InProgress}}

Template:Main

When a section in an article is basically a reference to another complete Wiki page, you can supress longer explanation by linking to the main page.

Main article: Qtopia


{{Main|Another article}}

Template:Note

To add an important note to a paragraph or article:

NOTE: This is an important note here.


{{Note|your text}}

Template:Outdated

Mark outdated information:

Outdated warning ! This article or section is significantly outdated, either by significant hardware or software changes. Procedures mentioned in this page may well not work for current hardware/software.


{{Outdated}}

Template:ProgressUnknown

Progress unknown:

Progress unknown: This article or section documents one or more features whose implementation has progress unknown.


{{ProgressUnknown}}

Template:Signature

Telling people to add their signature:

Add your signature! In order to help others follow the discussion, please add your signature.

You can automatically add your signature by typing the signature tag --~~~~ or using the 2nd button from the right above your input box.


{{Signature}}

Template:Special_Hardware

Notification about unusual hardware stuff:

Template:Special Hardware

{{Special_Hardware}}

Template:Stub

Mark an article or section which needs to be written.

Stub: This is a stub. You can help OpenMokoWiki by expanding it.


{{Stub}}

Template:Todo

Section or article which needs to be written, development or other task which has to be done.

TODO: The todo text comes here (See: To-Do List)
{{todo|The todo text comes here}}

Template:Unimplemented

Unimplemented things:

Template:Unimplemented

{{Unimplemented}}

Template:Warning

Things where extra caution should be taken:

WARNING: your text here


{{Warning|your text here}}

Template:Wishlist

Openmoko wishlist item, not hardware (see Hardware_Wishlist above).

Wishes warning! This article or section documents one or more OpenMoko Wish List items, the features described here may or may not be implemented in the future.
{{Wishlist}}

Content templates

Template:Languages

The links to all other languages:


{{Languages}}

Template:Yes, Template:No, Template:Maybe, Template:Unknown

For tables with various featrure lists and others, where these values are possible.

Neo 1973 FreeRunner
Feautre 1 yes no
Feature 2 maybe


?


{{Yes}}
{{No}}
{{Maybe}}
{{Unknown}}

Status table rows

Software planning tables:

Status Project name Description Contact
DONE Project Description Name <email>



TODO Project Description Name <email>



{{feature|white|white|Status|Project|Description|email|Name}}
{{FeatureDone|Project|Description|email|Name}}
{{FeatureInProgress|Project|Description|email|Name}}
{{FeatureRedo|Project|Description|email|Name}}
{{FeatureTodo|Project|Description|email|Name}}

Available status table rows:

Page templates

Tools