Difference between revisions of "DocumentationStandards"
Jump to navigation
Jump to search
| Line 4: | Line 4: | ||
* maybe http://www.docbook.org/schemas/sdocbook/elements.html? | * maybe http://www.docbook.org/schemas/sdocbook/elements.html? | ||
* http://live.gnome.org/ProjectMallard - not much there | * http://live.gnome.org/ProjectMallard - not much there | ||
*book | |||
*part | |||
*chapter | |||
*section | |||
*para | |||
* ItemizedList, ListItem | |||
*avertissement = Caution or Important or Note or Tip or Warning. (+Title+ bloc) | |||
*Figure (Title+bloc) | |||
*procedure (Title+bloc+step) | |||
*Step (title+bloc, substep is possible) | |||
*KeyCap or KeyCombo or KeySym or MouseButton | |||
*MenuChoice, GUIButton, GUIIcon, GUILabel, GUIMenu, GUISubmenu, Interface. | |||
=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 19:06, 24 October 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
- ItemizedList, ListItem
- avertissement = Caution or Important or Note or Tip or Warning. (+Title+ bloc)
- Figure (Title+bloc)
- procedure (Title+bloc+step)
- Step (title+bloc, substep is possible)
- KeyCap or KeyCombo or KeySym or MouseButton
- MenuChoice, GUIButton, GUIIcon, GUILabel, GUIMenu, GUISubmenu, Interface.
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".