improve CSS and tagging of platform-specifics.
This commit is contained in:
parent
6e64603e61
commit
2d0291a89c
12
STYLE_GUIDE
12
STYLE_GUIDE
@ -191,6 +191,18 @@ events and controller actions.
|
|||||||
Keys and mouse key names should always be capitalized. We do not need to
|
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".
|
distringuish between "x" and "X", because the latter would be "Shift-X".
|
||||||
In case you forget, the stylesheet takes care of this.
|
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>
|
<code>
|
||||||
is only used for program code, or the content of configuration files etc. Do
|
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.
|
not abuse to style keys or user input, use <kbd> instead.
|
||||||
|
@ -56,10 +56,10 @@ title: About Ardour documentation
|
|||||||
<kbd class="mouse">⇓</kbd> <kbd class="mouse">⇒</kbd></dt>
|
<kbd class="mouse">⇓</kbd> <kbd class="mouse">⇒</kbd></dt>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h4>"Context-click"</h4>
|
<h4>Context-click</h4>
|
||||||
<p>
|
<p>
|
||||||
Many times the term <kbd class="mouse">context-click</kbd> is used to indicate
|
The term <dfn>context-click</dfn> is used to indicate
|
||||||
that you should (typically) right-click on a particular element of the graphical
|
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
|
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,
|
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
|
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
|
such as this</kbd>. In rare cases, you will be required to perform certain
|
||||||
operations at the command line of your operating system:
|
operations at the command line of your operating system:
|
||||||
</p>
|
</p>
|
||||||
<kbd class="lincmd">cat /proc/cpuinfo</kbd>
|
<kbd class="cmd lin">cat /proc/cpuinfo</kbd>
|
||||||
<kbd class="maccmd">sleep 3600</kbd>
|
<kbd class="cmd mac">sleep 3600</kbd>
|
||||||
<kbd class="wincmd">ping www.google.com</kbd>
|
<kbd class="cmd win">ping www.google.com</kbd>
|
||||||
|
|
||||||
<h3>Program Output</h3>
|
<h3>Program Output</h3>
|
||||||
<p>
|
<p>
|
||||||
|
@ -26,7 +26,7 @@ title: MIDI on Linux
|
|||||||
First, check whether a2jmidid is already installed in your system. After
|
First, check whether a2jmidid is already installed in your system. After
|
||||||
starting your JACK server, go to the command line and type
|
starting your JACK server, go to the command line and type
|
||||||
</p>
|
</p>
|
||||||
<kbd class="lincmd">a2jmidid -e</kbd>
|
<kbd class="cmd lin">a2jmidid -e</kbd>
|
||||||
<p>
|
<p>
|
||||||
If a2jmidid does not exist, install it with the software manager of your
|
If a2jmidid does not exist, install it with the software manager of your
|
||||||
Linux distribution and try again.
|
Linux distribution and try again.
|
||||||
|
@ -117,7 +117,7 @@ title: Ubuntu Linux
|
|||||||
named /etc/security/limits.d/audio.conf.disabled, rename it to the former.
|
named /etc/security/limits.d/audio.conf.disabled, rename it to the former.
|
||||||
Run the command
|
Run the command
|
||||||
</p>
|
</p>
|
||||||
<kbd class="lincmd">sudo usermod -a -G audio
|
<kbd class="cmd lin">sudo usermod -a -G audio
|
||||||
<em>YOUR-LOGIN-NAME</em></kbd>
|
<em>YOUR-LOGIN-NAME</em></kbd>
|
||||||
<p>
|
<p>
|
||||||
Then log out and log in again. On Ubuntu Studio the user is a member of audio
|
Then log out and log in again. On Ubuntu Studio the user is a member of audio
|
||||||
|
@ -10,11 +10,11 @@ menu-title: Starting from Linux Cmdline
|
|||||||
Like (almost) any other program on Linux, Ardour can be started on the
|
Like (almost) any other program on Linux, Ardour can be started on the
|
||||||
command line. Type the following command in a terminal window:
|
command line. Type the following command in a terminal window:
|
||||||
</p>
|
</p>
|
||||||
<kbd class="lincmd">ardour3</kbd>>
|
<kbd class="cmd lin">ardour3</kbd>>
|
||||||
<p>
|
<p>
|
||||||
To start Ardour with an existing session:
|
To start Ardour with an existing session:
|
||||||
</p>
|
</p>
|
||||||
<kbd class="lincmd">ardour3 <em>/path/to/session</kbd>
|
<kbd class="cmd lin">ardour3 <em>/path/to/session</em></kbd>
|
||||||
<p>
|
<p>
|
||||||
replacing /path/to/session with the actual path to your session. You can
|
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,
|
specify either the session folder or any session file inside the folder,
|
||||||
@ -23,6 +23,6 @@ menu-title: Starting from Linux Cmdline
|
|||||||
<p>
|
<p>
|
||||||
To start Ardour with a new, named session:
|
To start Ardour with a new, named session:
|
||||||
</p>
|
</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>
|
<h3>Other Command Line Options</h3>
|
||||||
|
@ -272,29 +272,31 @@ kbd {
|
|||||||
text-transform:capitalize;
|
text-transform:capitalize;
|
||||||
}
|
}
|
||||||
|
|
||||||
kbd.input,kbd.lincmd,kbd.maccmd,kbd.wincmd {
|
kbd.input,kbd.cmd {
|
||||||
font-family:mono;
|
font-family:mono;
|
||||||
border-width:0;
|
border-width:0;
|
||||||
|
text-transform:none;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
kbd.lincmd,kbd.maccmd,kbd.wincmd {
|
kbd.cmd {
|
||||||
display:block;
|
display:block;
|
||||||
width:100%;
|
width:100%;
|
||||||
margin-bottom:1ex;
|
margin-bottom:1ex;
|
||||||
text-transform:none;
|
text-transform:none;
|
||||||
}
|
}
|
||||||
|
|
||||||
kbd.lincmd:before {
|
kbd.cmd.lin:before {
|
||||||
content: 'user@linux:~ ';
|
content: 'user@linux:~ ';
|
||||||
color:#999999;
|
color:#999999;
|
||||||
}
|
}
|
||||||
|
|
||||||
kbd.maccmd:before {
|
kbd.cmd.mac:before {
|
||||||
content: 'MacBook:~/Desktop User\$ ';
|
content: 'MacBook:~/Desktop User\$ ';
|
||||||
color:#999999;
|
color:#999999;
|
||||||
}
|
}
|
||||||
|
|
||||||
kbd.wincmd:before {
|
kbd.cmd.win:before {
|
||||||
content: 'C:\\Users\\myAccount> ';
|
content: 'C:\\Users\\myAccount> ';
|
||||||
color:#999999;
|
color:#999999;
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user