Difference between revisions of "DocumentationStandards"
Jump to navigation
Jump to search
| Line 10: | Line 10: | ||
*section | *section | ||
*para | *para | ||
* | *title+Intro+screenshot+Activation+Procedure+Additional infos+Links | ||
=Miscellany= | =Miscellany= | ||
* Links to sections should be named the same as the section title, except don't use caps and replace all spaces with dashes, e.g., the link for section "Menu Bar" would be "menu-bar". | * Links to sections should be named the same as the section title, except don't use caps and replace all spaces with dashes, e.g., the link for section "Menu Bar" would be "menu-bar". | ||
Revision as of 15:19, 9 November 2007
Here is a list of proposals for documentation standards for the User Manual (most important for DocBook xml and content)
DocBook tags we should use
- maybe http://www.docbook.org/schemas/sdocbook/elements.html?
- http://live.gnome.org/ProjectMallard - not much there
- book
- part
- chapter
- section
- para
- title+Intro+screenshot+Activation+Procedure+Additional infos+Links
Miscellany
- Links to sections should be named the same as the section title, except don't use caps and replace all spaces with dashes, e.g., the link for section "Menu Bar" would be "menu-bar".