Talk:Community Updates/2009-08-06

From Openmoko

< Talk:Community Updates(Difference between revisions)
Jump to: navigation, search
(=editing and extending discussion)
m (Talk:Community Updates/Draft 2009-08-06 moved to Talk:Community Updates/2009-08-06: Releasing Community Update for period 2009-07-24 to 2009-08-06)

Revision as of 23:53, 6 August 2009

Contents

Welcome

Here you can get a clue on how to contribute to Community updates, while conforming to wiki editing guidelines. You can take a look at Community_Update_Draft, to have a feel how coming update draft would look like, if we follow all these standarised wiki guidelines. Feel free to discuss here about this topic, maybe we achieve consensus before next CU. Everybody is welcome to help. Following are main topics which IMHO should be covered. --LeadMan 15:58, 21 July 2009 (UTC)

Guidelines

Conform to Openmoko_Wiki_Editing_Guidelines. These guidelines covers most of uncertain cases an editor might run into while editing wiki pages. It takes half an hour to dig through this, but is worth to do it at least summarily.

Editing

Conform to Help:Editing

Templates

Conform to Templates. Especially when it comes to handy Semantic boxes, like 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
}}

If application/something else has its own wiki page, put its name in double square brackets:

Links

Keep in mind the difference between internal and external links. Try to use them properly, accordingly to their destination

Date format

Dates in article body text should all have the same format. Use one standarized date format. As in computer world date format YYY-MM-DD is natural, and also is natural choice for sorting purposes, wiki editor should probably use this format. Current version of media wiki software is 1.19.22. When it will be 1.15+ we can use unified date format, which would be represented accordingly to predefined user's preferences, while showing some default format for not registered users. (Is there any chance for upgrading this wiki version?) Here is nice example of date formating

Filling "Edit Summary" field

Many wiki editors do not fill in "Edit Summary" filed under "edit" box. This summary becomes very handy when it comes to later version comparing. Always fill in "edit summary" field when editing wiki pages. All you need to put there are 2~4 words of comment, and really makes life easier for wiki administrators. It's a good idea to set your user preferences (under Editing) to "Prompt me when entering a blank edit summary". If you really want to keep it empty, you can just confirm the message or enter a blank space to avoid the message. It is also quick and quite good habit to prefix summary with +/-/= depending upon you add/delete/edit content.

Creating new templates

Using Template:ApplicationBox is great idea! Why not create similar templates for other parts of CU? The disadvantage of this way would be little more code to fill, but all entries in particular part of CU would have similar layout. Currently there is work in progress on creating DistributionBox template. You can have a look on Community Update Draft how proposed templates look like. You can also vote for your favourite template here or on List for Openmoko community discussion:

  • LeadMan: Version 2
  • your_nick: your_choice

Community Update releasing process

And last but not least...In fact it is pretty important: never copy/paste contents of CU to release the page! Instead always use "move" button on top of wiki page. This "button" is intended for this action and by using it you save all editions and contributions history.

Your topic

...add your own topic here...

Personal tools

Welcome

Here you can get a clue on how to contribute to Community updates, while conforming to wiki editing guidelines. You can take a look at Community_Update_Draft, to have a feel how coming update draft would look like, if we follow all these standarised wiki guidelines. Feel free to discuss here about this topic, maybe we achieve consensus before next CU. Everybody is welcome to help. Following are main topics which IMHO should be covered. --LeadMan 15:58, 21 July 2009 (UTC)

Guidelines

Conform to Openmoko_Wiki_Editing_Guidelines. These guidelines covers most of uncertain cases an editor might run into while editing wiki pages. It takes half an hour to dig through this, but is worth to do it at least summarily.

Editing

Conform to Help:Editing

Templates

Conform to Templates. Especially when it comes to handy Semantic boxes, like 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
}}

If application/something else has its own wiki page, put its name in double square brackets:

Links

Keep in mind the difference between internal and external links. Try to use them properly, accordingly to their destination

Date format

Dates in article body text should all have the same format. Use one standarized date format. As in computer world date format YYY-MM-DD is natural, and also is natural choice for sorting purposes, wiki editor should probably use this format. Current version of media wiki software is 1.19.22. When it will be 1.15+ we can use unified date format, which would be represented accordingly to predefined user's preferences, while showing some default format for not registered users. (Is there any chance for upgrading this wiki version?) Here is nice example of date formating

Filling "Edit Summary" field

Many wiki editors do not fill in "Edit Summary" filed under "edit" box. This summary becomes very handy when it comes to later version comparing. Always fill in "edit summary" field when editing wiki pages. All you need to put there are 2~4 words of comment, and really makes life easier for wiki administrators. It's a good idea to set your user preferences (under Editing) to "Prompt me when entering a blank edit summary". If you really want to keep it empty, you can just confirm the message or enter a blank space to avoid the message. It is also quick and quite good habit to prefix summary with +/-/= depending upon you add/delete/edit content.

Creating new templates

Using Template:ApplicationBox is great idea! Why not create similar templates for other parts of CU? The disadvantage of this way would be little more code to fill, but all entries in particular part of CU would have similar layout. Currently there is work in progress on creating DistributionBox template. You can have a look on Community Update Draft how proposed templates look like. You can also vote for your favourite template here or on List for Openmoko community discussion:

  • LeadMan: Version 2
  • your_nick: your_choice

Community Update releasing process

And last but not least...In fact it is pretty important: never copy/paste contents of CU to release the page! Instead always use "move" button on top of wiki page. This "button" is intended for this action and by using it you save all editions and contributions history.

Your topic

...add your own topic here...