Difference between revisions of "Help:Editing"

From ProgrammingExamples
Jump to: navigation, search
(Reformat, add Dos and Don'ts)
m (reformat)
Line 1: Line 1:
* [http://www.mediawiki.org/wiki/Help:Editing_pages#Editing_rules.2C_editing_conventions.2C_and_formatting Editing Wiki Pages]
+
=== [http://www.mediawiki.org/wiki/Help:Editing_pages#Editing_rules.2C_editing_conventions.2C_and_formatting Editing Wiki Pages] ===
** [http://www.mediawiki.org/wiki/Help:Formatting Text Formatting]
+
* [http://www.mediawiki.org/wiki/Help:Formatting Text Formatting]
*** [http://www.mediawiki.org/wiki/Help:Links Creating Links]
+
** [http://www.mediawiki.org/wiki/Help:Links Creating Links]
*** [http://www.mediawiki.org/wiki/Help:Images Adding Images]
+
** [http://www.mediawiki.org/wiki/Help:Images Adding Images]
*** [http://www.mediawiki.org/wiki/Help:Tables Tables]
+
** [http://www.mediawiki.org/wiki/Help:Tables Tables]
* '''Do'''s and '''Don't'''s for using the Programming Examples Wiki
+
=== '''Do'''s and '''Don't'''s for using the Programming Examples Wiki ===
** '''Do'''
+
* '''Do'''
*** Create a 'dispatch page' for each new language that you add, put links to examples in that language on that page.
+
** Create a 'dispatch page' for each new language that you add, put links to examples in that language on that page.
*** Try to keep each example as short as possible... and no shorter!
+
** Try to keep each example as short as possible... and no shorter!
*** Try to demonstrate a single concept per example.
+
** Try to demonstrate a single concept per example.
*** Comment, comment, comment!
+
** Comment, comment, comment!
** '''Don't'''
+
* '''Don't'''
*** Do not treat the wiki as your own personal code dump. Things that are placed here should be useful for many people.
+
** Do not treat the wiki as your own personal code dump. Things that are placed here should be useful for many people.
*** Do not "hijack" code someone else has submitted by changing what it does. (Do improve it if you see a way)
+
** Do not "hijack" code someone else has submitted by changing what it does. (Do improve it if you see a way)

Revision as of 12:24, 27 June 2010

Editing Wiki Pages

Dos and Don'ts for using the Programming Examples Wiki

  • Do
    • Create a 'dispatch page' for each new language that you add, put links to examples in that language on that page.
    • Try to keep each example as short as possible... and no shorter!
    • Try to demonstrate a single concept per example.
    • Comment, comment, comment!
  • Don't
    • Do not treat the wiki as your own personal code dump. Things that are placed here should be useful for many people.
    • Do not "hijack" code someone else has submitted by changing what it does. (Do improve it if you see a way)