Differences between revisions 10 and 11
Revision 10 as of 2009-02-26 20:56:33
Size: 1783
Editor: PaulBoddie
Comment: Update the guidelines.
Revision 11 as of 2009-02-27 01:20:19
Size: 1885
Comment:
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
 * You can use [[HelpOnParsers/ReStructuredText|ReStructured Text]] mark-up, but this can be confusing to people, so try not to do this too much. Importing content from somewhere else for initial publication is probably the most excusable exception.  * You can use [[HelpOnParsers/ReStructuredText|ReStructured Text]] mark-up, but this can be confusing to people, so try not to do this too much. Importing content from somewhere else for initial publication is probably the most excusable exception.  Pages requiring more sophisticated markup are also easier done with ReST than with !MoinMoin markup.

Wiki Editing Guidelines

Currently there are only few guidelines for creating a page inside Python Wiki:

  • If you want to add a new page, check to see if there isn't already a page for that topic.
  • If you can't edit a page because you don't have permission, yet really need to change something, send a mail to <pydotorg AT python DOT org> mentioning the page and your motivations. We have locked down some parts of this Wiki to prevent vandalism.

  • Please structure long pages to sections (learn to use '== headings ==').
  • If you have source code included, run it yourself to test for at least simple errors.
  • Avoid duplicating information when not necessary, and respect copyrights. If you are unsure, at least credit the source, so that others can fix things if needed.
  • Learn to use Wiki format mentioned in HelpOnFormatting. It allows for more consistent page styles.

  • You can use ReStructured Text mark-up, but this can be confusing to people, so try not to do this too much. Importing content from somewhere else for initial publication is probably the most excusable exception. Pages requiring more sophisticated markup are also easier done with ReST than with MoinMoin markup.

  • Take advantage of this Wiki's ability to format and colour Python source code - it is easier to read than a simple, plain monochrome section. An example:
       1 from hello import world
       2 
       3 def say_hello():
       4     """Just say hello :)"""
       5     what = world()
       6     message = what.greet()  # no, there's no module named "hello" 
       7                             # in Python stdlib - at least not yet :)
       8     return message
       9 
      10 if __name__ == "__main__":
      11     say_hello()
    
  • When there's no content on a topic, it's better to put something in and let others correct it, don't you think? What are you waiting for?!

WikiGuidelines (last edited 2013-11-14 18:29:01 by PaulBoddie)

Unable to edit the page? See the FrontPage for instructions.