Skip to content

Commit

Permalink
improve CSS and tagging of platform-specifics.
Browse files Browse the repository at this point in the history
  • Loading branch information
nettings committed Feb 4, 2014
1 parent 6e64603 commit 2d0291a
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 16 deletions.
12 changes: 12 additions & 0 deletions STYLE_GUIDE
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions _manual/01_welcome-to-ardour/02_about-ardour-documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ <h4>Mouse wheel</h4>
<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
Expand Down Expand Up @@ -109,9 +109,9 @@ <h3>User Input</h3>
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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h3>Check for a2jmidid availability</h3>
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h3>How to fix</h3>
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
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,
Expand All @@ -23,6 +23,6 @@
<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>
12 changes: 7 additions & 5 deletions source/css/app.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down

0 comments on commit 2d0291a

Please sign in to comment.