X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=STYLE_GUIDE;h=491794cf5def497e587f675afcfcd434505ebde0;hb=7dc9c99860b69da042c64d99b333c42151748681;hp=af78e989efa8cae5b85a68c70fb555576519e56f;hpb=e6123839d20de4f903ed74820cc087fc8401f625;p=ardour-manual diff --git a/STYLE_GUIDE b/STYLE_GUIDE index af78e98..491794c 100644 --- a/STYLE_GUIDE +++ b/STYLE_GUIDE @@ -50,6 +50,9 @@ Watch out for the ampersand "&" and angle brackets "<" and ">". They will render your XHTML invalid, and must be replaced by their named entities "&", "<", and ">". +Keep line lengths within 108 characters so that additions or changes are easy to view in github pull requests. +Code examples that are supposed to be all one line are an exception in which case the
tag should be +used to to tell the browser to display the code as one line. 3. Custom classes ================= @@ -120,7 +123,7 @@ signal to the build system that it is an internal link that needs to be fixed so that it points to the correct URL. -4.1 Inline markups +4.2 Inline markups ------------------ @@ -156,7 +159,7 @@ spacing of sections. If you're unhappy with those, fix the CSS (which fixes the entire manual in one go!). -4.2 Lists +4.3 Lists ---------@@ -182,7 +185,7 @@ For inline citations, the W3C recommends touse the cite and q elements. -4.4 Keyboard/Controller interaction +4.5 Keyboard/Controller interaction ----------------------------------- @@ -204,8 +207,10 @@ So if you want the user to press Ctrl-N on Linux, that's actually N. It will render as "Ctrl N" for you, and as "Cmd N" for your Mac-using friend. Nice, huh? -N.B.: If you want to have just the name of the modifier key by itself, use - block, and should contain ablock +inside as well to describe to the reader what the image is. + 5. Other conventions ==================== @@ -254,7 +263,7 @@ unless they are no higher than one row and make sense in the text flow. * Avoid any typographical quotation marks to highlight terms or express any kind of subtle inflection, use semantic markup instead. -* The hyphen is used to for compound words such as this well-advised example. +* The hyphen is used for compound words such as this well-advised example. * Do not hyphenate words at line breaks. * For breaks in thought—such as this splendid example—use the long em-dash. Note that the em-dash is snugged up against the text on both