GSoC/GCI Archive
Google Code-in 2010 MoinMoin Wiki

create markup docs (mediawiki format)

completed by: Peter Hoffmann

mentors: Alexander Schremmer, ReimarBauer, Thomas Waldmann, Ronny Pfannschmidt

 

Abstract

You need to write a "cheat sheet" / reference for "mediawiki" markup.

You need to create a .rst document, so we can include it in our sphinx-generated docs.

 

Details

Your intended audience are wiki users (new and advanced).

Document Structure:

  • first the easy/basic/often used stuff
  • then advanced stuff

Important: you have to try whether your documentation is correct, i.e. whether the markup really works the way you are documenting. If something does not work as expected, put a TODO there plus a remark what is not working.

You maybe can find and partially reuse some existing markup references / docs.

Deliverable: .rst document or a patch

 

Skill Requirements

See tags. Please note that you of course should also know the markup format you are documenting.

 

You can discuss this issue in the MoinMoin wiki: http://moinmo.in/EasyToDo/create%20markup%20docs%20%28mediawiki%29