Shamusworld >> Repos - ardour-manual-diverged/blob - STYLE_GUIDE

   1 *Style guide for the Ardour manual*
   2
   3
   4
   5 1. Rationale
   6 ============
   7
   8 The Ardour manual should be consistent across different media, and it should
   9 be easily updatable when Ardour's behaviour changes.
  10 The markup should be semantic - looks are determined in the CSS, and only
  11 there. If you feel you must compromise the markup in order to obtain a
  12 certain look: don't do it. Accept the look.
  13 Alternatively, edit the CSS, but be careful not to make matters worse
  14 elsewhere.
  15
  16
  17 1.1 visual markup
  18 -----------------
  19
  20 <b>,<i>,<u>,<font> or any other purely visual elements are not used in
  21 the Ardour manual.
  22 What you really mean is an <em>phasis or a <strong> emphasis.
  23 If you feel that some special terms should always be green and underlined, the
  24 approach of choice is this:
  25 <span class="my_important_keyword">foobar</span>
  26 and then add
  27 .my_important_keyword {
  28         text-decoration: underline;
  29         color: #004400;
  30         background-color: #eeffee;
  31 }
  32 to apps.css.
  33 If you add a new class with semantic meaning, document it below, under
  34 "Custom classes", and be sure to explain it to the reader at
  35 _manual/01_welcome-to-ardour/02_about-ardour-documentation.html.
  36
  37
  38 2. Format and Validation
  39 ========================
  40
  41 The Ardour manual has been converted to valid XHTML 1.0. That means it must
  42 be valid XML, with all tags closed properly. The reason for this extra
  43 complication is that XML can be more easily checked and automatically
  44 refactored than plain HTML, which eases maintenance.
  45
  46 Watch out for the ampersand "&" and angle brackets "<" and ">". They will
  47 render your XHTML invalid, and must be replaced by their named entities
  48 "&amp;", "&lt;", and "&gt;".
  49
  50
  51 3. Custom classes
  52 =================
  53
  54 We use the class attribute for some aspects of styling (such as to float an
  55 image left or right in a text paragraph), and also for more fine-grained
  56 semantic markup than core XHTML allows.
  57
  58 Any XHTML element can include a class attribute. If you need to add a class
  59 attribute to a word or a few words which don't have an element of their own,
  60 use <span class="my_new_category">foo bar</span>.
  61 If you need to apply a class to several block-level elements such as
  62 paragraphs or lists, enclose them in a <div>..</div>. Wherever possible,
  63 create semantic classes rather than visual ones.
  64
  65 .left:
  66 make an element float left in the surrounding paragraph.
  67
  68 .right:
  69 make an element float right in the surrounding paragraph.
  70
  71 .note:
  72 use for important notes that should be visually distinct from the
  73 normal text flow, or asides. Currently rendered in a gray box.
  74
  75 .warning:
  76 use for potentially dangerous situations involving data loss, malfunction,
  77 or sound quality issues. Currently rendered in a red box.
  78
  79 Check _manual/01_welcome-to-ardour/02_about-ardour-documentation.html, it
  80 serves as a style and markup guide.
  81
  82
  83 4. Element use
  84 ==============
  85
  86
  87 4.1 Main structural elements
  88 ----------------------------
  89
  90 <h1>..<h6>
  91 A <h1/> heading is added by the Ruby framework, so it should not be used in
  92 the manual page itself. If you feel you need another <h1>, start a new
  93 subpage.
  94 Heading levels must not be skipped. Any sub-heading must be exactly one
  95 level below its predecessor. Do not abuse headings to style a head line.
  96
  97 <p>
  98 Every snippet of text should be enclosed in a block level element. The
  99 default choice is <p>, the plain paragraph.
 100
 101
 102 4.1 Inline markups
 103 ------------------
 104
 105 <dfn>
 106 encloses a newly introduced term that is being explained. Use for the first
 107 occurrence of the main concept of every manual page, or the first occurrence
 108 of a new concept after a sub-heading if necessary.
 109 Keep in mind that <dfn> tags might be used to generate an index of keywords
 110 - don't pollute it too much.
 111
 112 <abbr>
 113 is used to explain an abbreviation such as <abbr title="Linux Audio
 114 Developers Simple Plugin API">LADSPA</abbr>. Browsers will usually pop up the
 115 definition when the user hovers over the word.
 116 On each page, use only for the first occurrence of every abbreviation. Avoid
 117 a redundant explanation in the text - the expansion can easily be extracted
 118 via CSS for printing.
 119 Use only in the text body, not in headings.
 120
 121 <em>
 122 is used to emphasize a word. Commonly rendered as italics.
 123 Use only if its a truly ad-hoc, one-off situation. For anything else,
 124 consider adding a new semantic markup with <span class="foo">.
 125
 126 <strong>
 127 is used to strongly emphasize a word. Commonly rendered in bold.
 128 See above for usage.
 129
 130 <br />
 131 A line-break can sometimes be used to structure a paragraph, or to split a
 132 longish heading. Never use spurious <br/>s at the end of paragraphs or to
 133 control the spacing of sections. If you're unhappy with those, fix the CSS
 134 (which fixes the entire manual in one go!)
 135
 136
 137 4.2 Lists
 138 ---------
 139
 140 <ul>,<ol>
 141 Use the unordered list for information snippets that do not have an implied
 142 order. The ordered list should always be used when a sequence of actions is
 143 described. Within the lists, each item must be enclosed in <li> tags.
 144 Lists cannot be included in <p>aragraphs. Close the paragraph first.
 145
 146 <dl>
 147 Definition lists are for technical terms <dt> and their definition <dd>. Do
 148 not abuse them for anything else.
 149
 150
 151 4.3 Quotations
 152 --------------
 153
 154 <blockquote>
 155 is used when an entire paragraph is quoted. Must contain a
 156 cite="http://mysource.net/foo.pdf" attribute. Do not abuse to indent a
 157 paragraph!
 158
 159 <cite>,<q>
 160 For inline citations, the <cite>W3C</cite> recommends to <q
 161 cite="http://www.w3.org/TR/xhtml1/dtds.html">use the cite and q
 162 elements</q>.
 163
 164
 165 4.4 Keyboard/Controller  interaction
 166 ------------------------------------
 167
 168 <kbd>
 169 Any keys or key combinations, mouse buttons, or controllers  should be marked
 170 with this element.
 171 E.g.:
 172 "Press <kbd>F</kbd> to fit all tracks to the height of the Editor window."
 173 "Move <kbd>Fader 1</kbd> on your MIDI controller to bind it.
 174 "
 175 Since modifier keys are not cross-platform and Ardour makes a point of
 176 abstracting them, do not hard-code "Alt", "Cmd" and friends, use
 177         class="modN"
 178 instead.
 179 So if you want the user to press Ctrl-N on Linux, that's actually <kbd
 180 class="mod1">N</kbd>. It will render as "Ctrl+N" for you, and as "Cmd+N" for
 181 your Mac-using friend. Nice, uh?
 182
 183 For anything you want the user to type, use <kbd> as a block-level element.
 184 See above for other <kbd> classes to denote menu items, selections, mouse
 185 events and controller actions.
 186
 187 <code>
 188 is only used for program code, or the content of configuration files etc. Do
 189 not abuse to style keys or user input, use <kbd> instead.
 190
 191 <samp>
 192 is only used for the textual output of any code, never for anything the user
 193 types or presses.
 194
 195
 196 4.5 Images
 197 ----------
 198
 199 <img>
 200 The image tag must contain a 'src="/images/yourimage.png"' element and a
 201 descriptive 'alt="A short textual description of the image content"'
 202 element.
 203
 204
 205 5. Other conventions
 206 ====================
 207
 208
 209 5.1 Typography
 210 --------------
 211
 212 * Avoid any typographical quotation marks to highlight terms or express any
 213   kind of subtle inflection, use semantic markup instead.
 214 * The hyphen is used to for compound words such as this well-advised example.
 215 * Do not hyphenate words at line breaks.
 216 * For breaks in thought &mdash; such as this splendid example &mdash; use
 217   the long em-dash.
 218 * For ranges of values, use the en-dash: Monday &ndash; Friday, 0 &ndash;
 219   11.
 220 * Use a non-breaking space ("&nbsp;") between a number and its unit.
 221
 222
 223 5.2 Language
 224 ------------
 225
 226 * The Ardour manual is written in Americal English spelling.
 227 * Use SI units with standard abbreviations. Give imperial units only as
 228   additional information, if at all.
 229
 230
 231 5.3 Headline Capitalization
 232 ---------------------------
 233
 234 Capitalization follows
 235 https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capitalization
 236 :
 237
 238 * Capitalize all words in the headline, with the following exceptions:
 239     Articles: a, an, the.
 240     Conjunctions: and, but, for, not, so, yet ...
 241     Prepositions of three or fewer letters: at, for, by, in, to ...
 242 * Keep headlines short and concise.
 243