From 2d0291a89ca5b90531dd728f73c09c4238f92f68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Nettingsmeier?= Date: Tue, 4 Feb 2014 16:42:20 +0100 Subject: [PATCH] improve CSS and tagging of platform-specifics. --- STYLE_GUIDE | 12 ++++++++++++ .../02_about-ardour-documentation.html | 12 ++++++------ .../05_setting-up-midi/02_midi-on-linux.html | 2 +- .../08_platform-specifics/01_ubuntu-linux.html | 2 +- .../01_starting-ardour-from-the-command-line.html | 6 +++--- source/css/app.css | 12 +++++++----- 6 files changed, 30 insertions(+), 16 deletions(-) diff --git a/STYLE_GUIDE b/STYLE_GUIDE index e991b7c..02cd1c2 100644 --- a/STYLE_GUIDE +++ b/STYLE_GUIDE @@ -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 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). + is only used for program code, or the content of configuration files etc. Do not abuse to style keys or user input, use instead. diff --git a/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html b/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html index 3caf2e2..e964684 100644 --- a/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html +++ b/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html @@ -56,10 +56,10 @@ title: About Ardour documentation ⇓ ⇒

-

"Context-click"

+

Context-click

- Many times the term context-click is used to indicate - that you should (typically) right-click on a particular element of the graphical + The term context-click is used to indicate + that you should (typically) Right-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. In rare cases, you will be required to perform certain operations at the command line of your operating system:

-cat /proc/cpuinfo -sleep 3600 -ping www.google.com +cat /proc/cpuinfo +sleep 3600 +ping www.google.com

Program Output

diff --git a/_manual/03_setting-up-your-system/05_setting-up-midi/02_midi-on-linux.html b/_manual/03_setting-up-your-system/05_setting-up-midi/02_midi-on-linux.html index 3639310..63cbc24 100644 --- a/_manual/03_setting-up-your-system/05_setting-up-midi/02_midi-on-linux.html +++ b/_manual/03_setting-up-your-system/05_setting-up-midi/02_midi-on-linux.html @@ -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

-a2jmidid -e +a2jmidid -e

If a2jmidid does not exist, install it with the software manager of your Linux distribution and try again. diff --git a/_manual/03_setting-up-your-system/08_platform-specifics/01_ubuntu-linux.html b/_manual/03_setting-up-your-system/08_platform-specifics/01_ubuntu-linux.html index d150927..24c6317 100644 --- a/_manual/03_setting-up-your-system/08_platform-specifics/01_ubuntu-linux.html +++ b/_manual/03_setting-up-your-system/08_platform-specifics/01_ubuntu-linux.html @@ -117,7 +117,7 @@ title: Ubuntu Linux named /etc/security/limits.d/audio.conf.disabled, rename it to the former. Run the command

- sudo usermod -a -G audio + sudo usermod -a -G audio YOUR-LOGIN-NAME

Then log out and log in again. On Ubuntu Studio the user is a member of audio diff --git a/_manual/04_ardours-interface/01_starting-ardour/01_starting-ardour-from-the-command-line.html b/_manual/04_ardours-interface/01_starting-ardour/01_starting-ardour-from-the-command-line.html index 2d6af4f..9f0c654 100644 --- a/_manual/04_ardours-interface/01_starting-ardour/01_starting-ardour-from-the-command-line.html +++ b/_manual/04_ardours-interface/01_starting-ardour/01_starting-ardour-from-the-command-line.html @@ -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:

-ardour3> +ardour3>

To start Ardour with an existing session:

-ardour3 /path/to/session +ardour3 /path/to/session

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

To start Ardour with a new, named session:

-ardour3 -N /path/to/session +ardour3 -N /path/to/session

Other Command Line Options

diff --git a/source/css/app.css b/source/css/app.css index 68ca432..f6c54b8 100644 --- a/source/css/app.css +++ b/source/css/app.css @@ -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; }