Overview
- Title
- create markup docs (docbook xml format)
- Duration
- 120
- Difficulty
- Easy
- Type
- Documentation
- Tags
- rst,english
- Mentors
- thomaswaldmann,rb_proj,ronny_pfannschmidt,xoraxax,valentinjaniaut
- Count
- -1
Description
Abstract
You need to write a "cheat sheet" / reference for "docbook xml" 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.
Links
See: DOM DocBook and HTML 2010/DocBook-DOM for the list of DocBook elements supported by MoinMoin.