]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
improve CSS and tagging of platform-specifics.
authorJörn Nettingsmeier <nettings@stackingdwarves.net>
Tue, 4 Feb 2014 15:42:20 +0000 (16:42 +0100)
committerJörn Nettingsmeier <nettings@stackingdwarves.net>
Tue, 4 Feb 2014 15:42:20 +0000 (16:42 +0100)
STYLE_GUIDE
_manual/01_welcome-to-ardour/02_about-ardour-documentation.html
_manual/03_setting-up-your-system/05_setting-up-midi/02_midi-on-linux.html
_manual/03_setting-up-your-system/08_platform-specifics/01_ubuntu-linux.html
_manual/04_ardours-interface/01_starting-ardour/01_starting-ardour-from-the-command-line.html
source/css/app.css

index e991b7c93872bef2d5eb5e1e5fb66c89aaf62500..02cd1c26d6ed109ee8f532093ff8267d6699244e 100644 (file)
@@ -191,6 +191,18 @@ events and controller actions.
 Keys and mouse key names should always be capitalized. We do not need to
 distringuish between "x" and "X", because the latter would be "Shift-X".
 In case you forget, the stylesheet takes care of this.
+
+CSS Classes used with <kbd> are:
+.modN
+.mouse: mouse buttons
+.cmd: a command line
+.lin, .win, .mac: add nice prompts to that command line
+.input: inline text to be entered by the user
+.menu: path to an Ardour menu or other GUI item
+.option: path to an option, with (X) at the end.
+.optoff: path to an option, with ( ) at the end.
+.button, .fader, .knob: external controllers (OSC or MIDI).
+
 <code>
 is only used for program code, or the content of configuration files etc. Do
 not abuse to style keys or user input, use <kbd> instead.
index 3caf2e20da2de768030f73400cbf4453d1ec5615..e964684a5c40e39f912f5a0b61d813629f5a691e 100644 (file)
@@ -56,10 +56,10 @@ title: About Ardour documentation
   <kbd class="mouse">&dArr;</kbd> <kbd class="mouse">&rArr;</kbd></dt>
 </p>
 
-<h4>"Context-click"</h4>
+<h4>Context-click</h4>
 <p>
-  Many times the term <kbd class="mouse">context-click</kbd> is used to indicate
-  that you should (typically) right-click on a particular element of the graphical 
+  The term <dfn>context-click</dfn> is used to indicate
+  that you should (typically) <kbd class="mouse">Right</kbd>-click on a particular element of the graphical 
   user interface. Although right-click is the common, default way to do this, there 
   are other ways to accomplish the same thing - this term refers to any of them, 
   and the result is always that a menu specific to the item you clicked on will be
@@ -109,9 +109,9 @@ title: About Ardour documentation
   such as this</kbd>. In rare cases, you will be required to perform certain
   operations at the command line of your operating system:
 </p>
-<kbd class="lincmd">cat /proc/cpuinfo</kbd>
-<kbd class="maccmd">sleep 3600</kbd>
-<kbd class="wincmd">ping www.google.com</kbd>
+<kbd class="cmd lin">cat /proc/cpuinfo</kbd>
+<kbd class="cmd mac">sleep 3600</kbd>
+<kbd class="cmd win">ping www.google.com</kbd>
 
 <h3>Program Output</h3>
 <p>
index 363931098c16acba08806e98e75827d827d6c04a..63cbc242ca110ae6cb7a64f931476566aa392c03 100644 (file)
@@ -26,7 +26,7 @@ title: MIDI on Linux
   First, check whether a2jmidid is already installed in your system. After
   starting your JACK server, go to the command line and type
 </p>
-<kbd class="lincmd">a2jmidid -e</kbd>
+<kbd class="cmd lin">a2jmidid -e</kbd>
 <p>
   If a2jmidid does not exist, install it with the software manager of your
   Linux distribution and try again.
index d15092778e9161853f40d597455f56809b004d00..24c631725fdd8641bd29462d06e621cf44d29c65 100644 (file)
@@ -117,7 +117,7 @@ title: Ubuntu Linux
       named /etc/security/limits.d/audio.conf.disabled, rename it to the former.
       Run the command
     </p>
-    <kbd class="lincmd">sudo usermod -a -G audio
+    <kbd class="cmd lin">sudo usermod -a -G audio
     <em>YOUR-LOGIN-NAME</em></kbd> 
     <p>
       Then log out and log in again. On Ubuntu Studio the user is a member of audio
index 2d6af4ff6c092eebfcf0bda6eef6a69b041a06e6..9f0c654a3cff3bcb1a1117d80654b397761fae8e 100644 (file)
@@ -10,11 +10,11 @@ menu-title: Starting from Linux Cmdline
   Like (almost) any other program on Linux, Ardour can be started on the
   command line. Type the following command in a terminal window:
 </p>
-<kbd class="lincmd">ardour3</kbd>>
+<kbd class="cmd lin">ardour3</kbd>>
 <p>
   To start Ardour with an existing session:
 </p>
-<kbd class="lincmd">ardour3 <em>/path/to/session</kbd>
+<kbd class="cmd lin">ardour3 <em>/path/to/session</em></kbd>
 <p>
   replacing /path/to/session with the actual path to your session. You can
   specify either the session folder or any session file inside the folder,
@@ -23,6 +23,6 @@ menu-title: Starting from Linux Cmdline
 <p>
   To start Ardour with a new, named session:
 </p>
-<kbd class="lincmd">ardour3 -N <em>/path/to/session</kbd>
+<kbd class="cmd lin">ardour3 -N <em>/path/to/session</kbd>
 
 <h3>Other Command Line Options</h3>
index 68ca432868fd0871f8ac597a6d4aee23480782f4..f6c54b887e2196a674316f0088f2a1ccc9b82d83 100644 (file)
@@ -272,29 +272,31 @@ kbd {
     text-transform:capitalize;
 }
 
-kbd.input,kbd.lincmd,kbd.maccmd,kbd.wincmd {
+kbd.input,kbd.cmd {
     font-family:mono;
     border-width:0;
+    text-transform:none;
+
 }
 
-kbd.lincmd,kbd.maccmd,kbd.wincmd {
+kbd.cmd {
     display:block;
     width:100%;
     margin-bottom:1ex;
     text-transform:none;
 }
 
-kbd.lincmd:before {
+kbd.cmd.lin:before {
     content: 'user@linux:~ ';
     color:#999999;
 }
 
-kbd.maccmd:before {
+kbd.cmd.mac:before {
     content: 'MacBook:~/Desktop User\$ ';
     color:#999999;
 }
 
-kbd.wincmd:before {
+kbd.cmd.win:before {
     content: 'C:\\Users\\myAccount> ';
     color:#999999;
 }