X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=STYLE_GUIDE;fp=STYLE_GUIDE;h=f6101bbe4961e8a719b3efbb38abe8cc402ef0f6;hb=689d1af72ae198d9a38f6c6a6e8aff8f798b67bf;hp=866e86f0a167ff2860ffa3f15f0aefb27c84e0cb;hpb=fdbd351eb81927e87b7abed13bbbc8dc3df9e314;p=ardour-manual diff --git a/STYLE_GUIDE b/STYLE_GUIDE index 866e86f..f6101bb 100644 --- a/STYLE_GUIDE +++ b/STYLE_GUIDE @@ -105,13 +105,16 @@ default choice is
, the plain paragraph.
encloses a newly introduced term that is being explained. Use for the first
occurrence of the main concept of every manual page, or the first occurrence
of a new concept after a sub-heading if necessary.
+Keep in mind that tags might be used to generate an index of keywords
+- don't pollute it too much.
is used to explain an abbreviation such as LADSPA. Browsers will usually pop up the
-definition when the user hovers over the word, and it can easily be
-extracted via CSS for printing.
-Use only for the first occurrence of every new abbreviation.
+definition when the user hovers over the word.
+On each page, use only for the first occurrence of every abbreviation. Avoid
+a redundant explanation in the text - the expansion can easily be extracted
+via CSS for printing.
is used to emphasize a word. Commonly rendered as italics.
@@ -176,6 +179,8 @@ class="mod1">N. It will render as "Ctrl+N" for you, and as "Cmd+N" for
your Mac-using friend. Nice, uh?
For anything you want the user to type, use as a block-level element.
+See above for other classes to denote menu items, selections, mouse
+events and controller actions.
is only used for program code, or the content of configuration files etc. Do