Skip to content

Commit 5d7c7ef

Browse files
committed
Update manuals
1 parent 1514557 commit 5d7c7ef

File tree

8 files changed

+65
-37
lines changed

8 files changed

+65
-37
lines changed

res/doc/css/style.css

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,12 @@ img.portrait {
111111
img.plugin {
112112
height: auto;
113113
max-height: 100%;
114-
max-width: 100%;
114+
max-width: 450px;
115115
object-fit: contain;
116116
width: auto;
117+
float: left;
118+
margin: 0 25px 10px 0;
119+
border: 2px solid #1b1c22;
117120
}
118121

119122
pre {
@@ -385,7 +388,6 @@ a img:hover {
385388
-ms-transition: all 0.3s ease;
386389
}
387390

388-
389391
.lpa {
390392
background: url(../svg/lpa.png) no-repeat top left;
391393
background-size: contain;
@@ -982,7 +984,6 @@ tr.stroke {
982984
padding: 0;
983985
text-transform: uppercase;
984986
text-align: left !important;
985-
986987
}
987988

988989
.menu-mob-popup li {
@@ -1027,6 +1028,15 @@ tr.stroke {
10271028
/*grid-template-rows: repeat(2, 203px);*/
10281029
}
10291030

1031+
.grid-2col-man {
1032+
display: -ms-grid;
1033+
display: grid;
1034+
grid-gap: 8px 6px;
1035+
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
1036+
/*grid-template-rows: repeat(2, 203px);*/
1037+
padding: 8px 8px 0px 0px;
1038+
}
1039+
10301040
.grid-2col .ti-box-youtube {
10311041
padding: 8px 8px 0px 0px;
10321042
}
@@ -1354,9 +1364,9 @@ tr.stroke {
13541364
}
13551365

13561366
@media only screen and (min-width : 353px) and (max-width : 768px) {
1357-
1358-
pre {
1359-
font-size: 11px;}
1367+
pre {
1368+
font-size: 11px;
1369+
}
13601370
}
13611371

13621372
@media only screen and (min-width : 711px) and (max-width : 768px) {
@@ -1365,7 +1375,6 @@ pre {
13651375
max-width: 768px;
13661376
}
13671377

1368-
13691378
.ti-box-youtube {
13701379
height: 198px;
13711380
}
@@ -1638,9 +1647,14 @@ pre {
16381647
margin: 0 auto !important;
16391648
}
16401649

1641-
.lpa, .bou, .pay, .eth, .ptr, .lpa:hover, .bou:hover, .pay:hover, .eth:hover, .ptr:hover { display: table; margin-bottom: 10px;}
1642-
.sup-container {display: inline-block;}
1650+
.lpa, .bou, .pay, .eth, .ptr, .lpa:hover, .bou:hover, .pay:hover, .eth:hover, .ptr:hover {
1651+
display: table;
1652+
margin-bottom: 10px;
1653+
}
16431654

1655+
.sup-container {
1656+
display: inline-block;
1657+
}
16441658
}
16451659

16461660
@media only screen and (min-width : 0px) and (max-width : 550px) {
-73.3 KB
Loading
5.91 KB
Loading

res/doc/img/graph/limiter-patches.png

5.09 KB
Loading
6.3 KB
Loading
9.88 KB
Loading
576 Bytes
Loading

src/doc/manuals/controls.php

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
<?php
22
$CTL = $RES_ROOT . "/img/controls/";
33
?>
4-
<p>The following picture demonstrates typical Graphical User Interface (GUI) of plugin:</p>
5-
<img src="<?= $RES_ROOT ?>/img/plugins/phase_detector.png">
6-
4+
<div class="grid-2col-man">
5+
<div class="thc-descr">
6+
<p>The following picture demonstrates typical Graphical User Interface (GUI) of plugin:</p>
7+
<img class="plugin" style="max-width: 100%;" src="<?= $RES_ROOT ?>/img/plugins/phase_detector.png">
8+
</div>
9+
<div class="thc-descr">
710
<p>Each plugin consists of the following elements:</p>
811
<ul>
912
<li><b>AudioFile</b> - audio file chooser and editor.</li>
@@ -27,18 +30,27 @@
2730
<li><b>Sample Editor</b> - sample editor.</li>
2831
<li><b>Switch</b> - Switch control.</li>
2932
</ul>
33+
</div>
34+
</div>
3035

3136
<p>Colors of widgets may vary but the color scheme of widgets often follows these rules:</p>
3237
<ul>
3338
<li>Widgets that adjust parameters of similar objects are consolidated into one common group.</li>
3439
<li>Widgets that control parameters of one object often have similar colors.</li>
3540
<li>Widgets associated with audio channels often use the following color scheme:</li>
3641
<ul>
37-
<li><b style="color:#0000ff">Blue</b> and <b style="color:#ff00ff">Magenta</b> - for thresholds.</li>
38-
<li><b style="color:#00c0ff">Sapphirine</b> - for mono channel, stereo channel (when both left and right channels are controlled at same time), middle channel.</li>
39-
<li><b style="color:#ff0000">Red</b> - for left channel in stero pair.</li>
40-
<li><b style="color:#00ffff">Cyan</b> - for right channel in stereo pair, direct output channel.</li>
41-
<li><b style="color:#00cc00">Green</b> - for side channel or sidechain.</li>
42+
<li><b style="color:#c344d3">Moderate magenta</b> - for thresholds.</li>
43+
<li><b style="color:#bf6455">Moderate red</b> - for mono channel and stereo channel (when both left and right channels are controlled at same time).</li>
44+
<li><b style="color:#d8412a">Strong red</b> and <b style="color:#5072f4">Soft blue</b> - for left and right channels in stereo pair, direct output channel.</li>
45+
<li><b style="color:#0090a1">Dark cyan</b> and <b style="color:#009700">Dark lime green</b> - for middle and side channels.</li>
46+
<li><b style="color:#d8412a">Strong red</b> - for left channel in stero pair.</li>
47+
<li><b style="color:#5072f4">Soft blue</b> - for right channel </li>
48+
<li><b style="color:#da404a"/>Bright red</b> - for velocity.</li>
49+
<li><b style="color:#b07000"/>Dark orange</b> - for balance.</li>
50+
<li><b style="color:#9e60ee"/>Soft violet</b> - for envelopes.</li>
51+
<li><b style="color:#c65219"/>Strong orange</b> - for sidechain.</li>
52+
<li><b style="color:#c2487b"/>Moderate pink</b> and <b style="color:#009555"/>Lime green</b>- for attack and release.</li>
53+
<li><b style="color:#8c8700"/>Olive tone</b> and <b style="color:#368ccc"/>Moderate blue</b> - for dry and wet.</li>
4254
</ul>
4355
<li>Each widget that allows to set continuous parameters has corresponding label displaying it's current value and, optionally, units</li>
4456
</ul>
@@ -47,34 +59,45 @@
4759

4860
<h2>AudioFile</h2>
4961

62+
<div class="grid-2col-man">
63+
<div class="thc-descr">
5064
<p>AudioFile widget is used for loading and editing audio files. It tells to the plugin the actual location of file on
5165
file system.</p>
52-
5366
<p>By default there is no file associated with plugin, so the file widget displays
5467
<b style="color: #00c000">'Click to load'</b> text.</p>
55-
<div class="images">
68+
</div>
69+
70+
<div class="thc-descr">
71+
<!-- <div class="images"> -->
5672
<img src="<?= $CTL ?>file_unloaded.png">
5773
</div>
5874

75+
<div class="thc-descr">
5976
<p>By clicking left mouse button on the widget you may open file choosing dialog and select the file
6077
to use by plugin.</p>
61-
6278
<p>After the path to the file will be passed to plugin, the plugin starts to load the file, and the status
6379
displayed by the file widget changes. If file was successfully loaded, file widget will display
6480
the corresponding content of the file and it's name (without path). On error, error message is displayed
6581
with red color.</p>
66-
<div class="images">
82+
</div>
83+
84+
<div class="thc-descr">
85+
<!-- <div class="images"> -->
6786
<img src="<?= $CTL ?>file_error.png">
6887
</div>
6988

89+
<div class="thc-descr">
7090
<p>By clicking right mouse button, popup dialog appears that allows to cut, copy, paste and clear contents of widget</p>
7191
<p>There is also the way to force plugin to unload file. For this purpose simply double-click by right
7292
mouse button on widget's area if popup menu does not appear.</p>
73-
7493
<p>Example of file widget:</p>
75-
<div class="images">
94+
</div>
95+
96+
<div class="thc-descr">
97+
<!-- <div class="images"> -->
7698
<img src="<?= $CTL ?>file_loaded.png">
7799
</div>
100+
</div>
78101

79102
<h2>Button</h2>
80103

@@ -138,7 +161,7 @@
138161
<h2>Fader</h2>
139162
<p>The Fader widget allows to adjust value for continuous parameters in the pre-defined range.</p>
140163
<p>It is possible to achieve more precision by using the right mouse button instead of left when changing fader's value.</p>
141-
<p>To cancel editing, the opposite mouse button should be pressed (right if used left and vice verse).</p>
164+
<p>To cancel editing, the opposite mouse button should be pressed (right if used left and vice verse).</p>
142165
<p>To reset parameter to it's default value, issue double click by the left mouse button.</p>
143166
<div class="images">
144167
<img src="<?= $CTL ?>fader.png">
@@ -184,7 +207,7 @@
184207
widget's area. Also, additional tolerance may be reached by right-clicking the dot instead of
185208
left-clicking, this makes the change of parameters more accurate. The movement may be cancelled
186209
by pressing the opposite button of the mouse.</p>
187-
<p>Additional tolerance for mouse scroll may be achieved by pressing shift key on keyboard</p>
210+
<p>Additional tolerance for mouse scroll may be achieved by pressing shift key on keyboard</p>
188211

189212
<p>Example showing dot controls:</p>
190213
<div class="images">
@@ -239,7 +262,7 @@
239262
knob's scale. Also, additionally mouse button may be hold and parameter will be adjusted by moving mouse
240263
clockwise/counter-clockwise.</p>
241264
<p>To reset parameter to it's default value, left mouse button double click may be issued.</p>
242-
265+
243266
<p>Example showing knob controls:</p>
244267
<div class="images">
245268
<img src="<?= $CTL ?>knob_blue.png">
@@ -329,8 +352,8 @@
329352
# VST identifier: jav8
330353
# LADSPA identifier: 5002065
331354
#
332-
# (C) Linux Studio Plugins Project
333-
# https://lsp-plug.in/
355+
# (C) Linux Studio Plugins Project
356+
# https://lsp-plug.in/
334357
#
335358
#-------------------------------------------------------------------------------
336359

@@ -395,12 +418,3 @@
395418
<div class="images">
396419
<img src="<?= $CTL ?>switch.png">
397420
</div>
398-
399-
400-
401-
402-
403-
404-
405-
406-

0 commit comments

Comments
 (0)