Templates

From Openmoko

(Difference between revisions)
Jump to: navigation, search
(See also: Add a couple of navigational templates)
(Revise text)
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.
+
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
  
You can see [http://wiki.openmoko.org/index.php?title=Special%3AAllpages&from=&namespace=10 all available templates here].
+
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 no need for a "Template" category. 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 ==
Line 242: Line 242:
 
== Navigation boxes ==
 
== 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 !
+
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
  
 
=== [[:Template:Om 2008.8]] ===
 
=== [[:Template:Om 2008.8]] ===

Revision as of 09:04, 8 September 2008

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 no need for a "Template" category. You can see all available templates here.

Contents

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
Feature 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

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

Template:Om 2008.8


 

Template:OM2007.2

Om 2007.2

(Other distributions)


 

See also

List of all templates

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

You can see all available templates here.

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
Feature 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

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 !

Template:Om 2008.8

Key pages on:
Om 2008


 

Template:OM2007.2

Om 2007.2

(Other distributions)


 

See also

List of all templates