Difference between revisions of "DocumentationStandards"

From Inkscape Wiki
Jump to navigation Jump to search
(New page: 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= =Miscellany= * Links to sections sho...)
 
Line 2: Line 2:
  
 
=DocBook tags we should use=
 
=DocBook tags we should use=
 +
* maybe http://www.docbook.org/schemas/sdocbook/elements.html?
 +
* http://live.gnome.org/ProjectMallard - not much there
  
 
=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 21:44, 22 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

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".