X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=STYLE_GUIDE;h=7d2dad4ee7db2489a6d13d079d13917bb792c442;hb=4c1590e505f3c47ef0f2783f64dc074338a82f17;hp=5c367ab6dc3cf519f250c625c1fec5842ef4d918;hpb=5f92c0832cc395082fef91df5cb695bb53510e6a;p=ardour-manual diff --git a/STYLE_GUIDE b/STYLE_GUIDE index 5c367ab..7d2dad4 100644 --- a/STYLE_GUIDE +++ b/STYLE_GUIDE @@ -102,6 +102,11 @@ level below its predecessor. Do not abuse headings to style a head line. Every snippet of text should be enclosed in a block level element. The default choice is

, the plain paragraph. + +Cross-reference links in the manual are reasonably stable, since they are +independent of the ordering number (which gets removed from the URL) and the +pretty page title (the URL is created from the file name). So unless a file +is renamed or moved to another sub-directory, links should be ok. 4.1 Inline markups ------------------ @@ -170,8 +175,9 @@ elements. ------------------------------------ -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 F to fit all tracks to the height of the Editor window." "Move Fader 1 on your MIDI controller to bind it. @@ -248,8 +254,8 @@ paragraph. additional information, if at all. -5.3 Headline Capitalization ---------------------------- +5.3 Chapter Headline Capitalization +------------------------------------ Capitalization follows https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capitalization @@ -260,4 +266,15 @@ https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capit Conjunctions: and, but, for, not, so, yet ... Prepositions of three or fewer letters: at, for, by, in, to ... * Keep headlines short and concise. +* secondary headlines in articles are not capitalized +* 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

editorial note

, so that readers will be warned and fellow +editors know where there's work to do.