finish copy-editing of chapter 4.

[ardour-manual-diverged] / STYLE_GUIDE

diff --git a/STYLE_GUIDE b/STYLE_GUIDE
index e991b7c93872bef2d5eb5e1e5fb66c89aaf62500..5c367ab6dc3cf519f250c625c1fec5842ef4d918 100644 (file)
--- a/STYLE_GUIDE
+++ b/STYLE_GUIDE
@@ -191,6 +191,18 @@ events and controller actions.
 Keys and mouse key names should always be capitalized. We do not need to
 distringuish between "x" and "X", because the latter would be "Shift-X".
 In case you forget, the stylesheet takes care of this.
 Keys and mouse key names should always be capitalized. We do not need to
 distringuish between "x" and "X", because the latter would be "Shift-X".
 In case you forget, the stylesheet takes care of this.

+
+CSS Classes used with <kbd> are:
+.modN
+.mouse: mouse buttons
+.cmd: a command line
+.lin, .win, .mac: add nice prompts to that command line
+.input: inline text to be entered by the user
+.menu: path to an Ardour menu or other GUI item
+.option: path to an option, with (X) at the end.
+.optoff: path to an option, with ( ) at the end.
+.button, .fader, .knob: external controllers (OSC or MIDI).
+

 <code>
 is only used for program code, or the content of configuration files etc. Do
 not abuse to style keys or user input, use <kbd> instead.
 <code>
 is only used for program code, or the content of configuration files etc. Do
 not abuse to style keys or user input, use <kbd> instead.


@@ -207,7 +219,8 @@ types or presses.
 The image tag must contain a 'src="/images/yourimage.png"' element and a
 descriptive 'alt="A short textual description of the image content"'
 element.
 The image tag must contain a 'src="/images/yourimage.png"' element and a
 descriptive 'alt="A short textual description of the image content"'
 element.

-
+Images are usually placed as block-level elements, i.e. outside of a
+paragraph.

 
 5. Other conventions
 ====================
 
 5. Other conventions
 ====================