X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=STYLE_GUIDE;h=491794cf5def497e587f675afcfcd434505ebde0;hb=e74c09802c2ca4038144d051c425a65661bde3ea;hp=09b45dfc9473aa1765418cae7395ecba4c599887;hpb=9d7c49ccf028b6ad2e78b4ce03562c7ba4ebb975;p=ardour-manual diff --git a/STYLE_GUIDE b/STYLE_GUIDE index 09b45df..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 ----------------------------------- @@ -237,7 +240,7 @@ is only used for the textual output of any code, never for anything the user types or presses. -4.5 Images +4.6 Images ----------@@ -260,7 +263,7 @@ inside as well to describe to the reader what the image is. * 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