]> Shamusworld >> Repos - ardour-manual/blobdiff - STYLE_GUIDE
copy-editing chapter 8.
[ardour-manual] / STYLE_GUIDE
index 4c57d00ca94a9d487a505adb974278858c78e1e6..7d2dad4ee7db2489a6d13d079d13917bb792c442 100644 (file)
@@ -175,8 +175,9 @@ elements</q>.
 ------------------------------------
 
 <kbd>
-Any keys or key combinations, mouse buttons, or controllers  should be marked
-with this element. 
+Any keys or key combinations, mouse buttons or controllers, menu items or
+textual user input should be marked with this element. It is used here in
+the widest possible sense, qualified by classes.
 E.g.:
 "Press <kbd>F</kbd> to fit all tracks to the height of the Editor window."
 "Move <kbd>Fader 1</kbd> on your MIDI controller to bind it.
@@ -269,3 +270,11 @@ https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capit
 * Do not capitalize concepts in the text body, with the possible exceptions
   of _the_ Editor and _the_ Mixer.
 
+
+5.4 Janitorial tasks/review
+---------------------------
+
+If you encounter something that is unclear or patent nonsense, but you are
+not bold or knowledgeable to fix it, express your doubts with an <p
+class="fixme">editorial note</p>, so that readers will be warned and fellow
+editors know where there's work to do.