Talk:Community Updates/Draft

From Openmoko

< Talk:Community Updates(Difference between revisions)
Jump to: navigation, search
(adding new thoughts)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Welcome=
+
==Welcome==
Hi,
+
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|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 should be covered.
I have started this page, to try to standardize Community Updates (following refer as '''CU'''). You can take a look [http://wiki.openmoko.org/wiki/Community_Update_Draft here], to have a feel how coming update would look like, if we foolow all these standarised wiki guidelines. Probably I have started this little too late for 23th release, but maybe we achieve consensus before next CU. Everybody is welcome to help. Following are main topics which IMHO should be covered.
+
  
=Guidelines=
+
==Guidelines==
Conform to [[Openmoko_Wiki_Editing_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=
+
==Editing==
 
Conform to [[Help:Editing]]
 
Conform to [[Help:Editing]]
  
=Templates=
+
==Creating new templates==
Conform to [[Templates]]. Especially when it comes to handy Semantic boxes, like Template:ApplicationBox:<BR>
+
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. Following this idea [[Template:DistributionBox]] is currently being developed. You can see preview on [[Community_Update_Draft]] in Distribution section.
<pre><nowiki>
+
{{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
+
}}
+
</nowiki></pre>
+
If application/something else has its own wiki page, put its name in double square brackets:
+
  
=Links=
+
==Mailing list interface==
Keep in mind the difference between [http://meta.wikimedia.org/wiki/Help:Link#Interwiki_links internal] and [http://meta.wikimedia.org/wiki/Help:Link#External_links external] links. Try to use them properly, accordingly to their destination
+
Often there is a need to provide link pointing to discussion on a mailing list. Services providing web interface to mailing lists (like nabble.com) were [http://lists.openmoko.org/pipermail/community/2009-June/050363.html reported] many times to break discussion threads in mail clients. Remember, mailing lists were designed to be used with mail clients, not with web forums. If you need to provide link to discussion on mailinglist for those who are not subscribed, use mailing list archives.
 
+
* Go to [http://news.gmane.org/index.php?prefix=gmane.comp.handhelds.openmoko gname]
=Date format=
+
* choose a mailing list
Dates in article body text should all have the same format. Use one standarized date format. Current version of media wiki software is {{CURRENTVERSION}}. 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?)
+
* From top panel choose a post (preferably the one on the top of a thread)
Here is nice example of [http://www.mediawiki.org/wiki/Help:Variables#Formatting date formating]
+
* At bottom panel click "Subject:" link
 
+
* Copy URL from your browser into Community Update
=Filling "Edit Summary" field=
+
I have noticed that 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 pyt there are 3~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.)
+
 
+
=Community Update releasing process=
+
NEVER copy/paste CU to release page! Instead ALWAYS use "move" button on top. This saves all editions and contributions history.
+
 
+
=Your topic=
+
...add your own topic here...
+
 
+
--[[User:Leadman|LeadMan]] 18:41, 20 July 2009 (UTC)
+

Latest revision as of 09:19, 4 August 2010

Contents

[edit] 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 should be covered.

[edit] 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.

[edit] Editing

Conform to Help:Editing

[edit] 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. Following this idea Template:DistributionBox is currently being developed. You can see preview on Community_Update_Draft in Distribution section.

[edit] Mailing list interface

Often there is a need to provide link pointing to discussion on a mailing list. Services providing web interface to mailing lists (like nabble.com) were reported many times to break discussion threads in mail clients. Remember, mailing lists were designed to be used with mail clients, not with web forums. If you need to provide link to discussion on mailinglist for those who are not subscribed, use mailing list archives.

  • Go to gname
  • choose a mailing list
  • From top panel choose a post (preferably the one on the top of a thread)
  • At bottom panel click "Subject:" link
  • Copy URL from your browser into Community Update
Personal tools

Welcome

Hi, I have started this page, to try to standardize Community Updates (following refer as CU). You can take a look here, to have a feel how coming update would look like, if we foolow all these standarised wiki guidelines. Probably I have started this little too late for 23th release, but maybe we achieve consensus before next CU. Everybody is welcome to help. Following are main topics which IMHO should be covered.

Guidelines

Conform to Openmoko_Wiki_Editing_Guidelines

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. Current version of media wiki software is 1.19.21. 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

I have noticed that 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 pyt there are 3~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.)

Community Update releasing process

NEVER copy/paste CU to release page! Instead ALWAYS use "move" button on top. This saves all editions and contributions history.

Your topic

...add your own topic here...

--LeadMan 18:41, 20 July 2009 (UTC)