Update Preferences documentation for 8.0

This commit is contained in:
Alexandre Prokoudine 2023-10-10 04:56:18 +02:00
parent 1581bc23a5
commit a9ebd7da40

View File

@ -200,6 +200,10 @@
<li> <li>
<dfn>Theme</dfn> <dfn>Theme</dfn>
<ul> <ul>
<li>
<dfn>Color faders with track/bus colors</dfn>: when enabled, fills faders
for tracks and busses with respective track or bus colors.
</li>
<li> <li>
<dfn>Draw &quot;flat&quot; buttons</dfn>: when enabled, button controls <dfn>Draw &quot;flat&quot; buttons</dfn>: when enabled, button controls
in the user interface will be drawn with a flat look. When disabled button in the user interface will be drawn with a flat look. When disabled button
@ -215,12 +219,6 @@
mixer will be styled to look like if they were made of LEDs, with a dotted mixer will be styled to look like if they were made of LEDs, with a dotted
bar. Unchecking this option makes the bars flat and continuous. bar. Unchecking this option makes the bars flat and continuous.
</li> </li>
<li>
<dfn>Icon Set:</dfn> Changes the mouse cursor icons used to indicate
different tool modes in the editor. An example would be the icons used to
indicate whether the cursor will select a region or change the length of a
region.
</li>
</ul> </ul>
</li> </li>
<li> <li>
@ -261,7 +259,7 @@
<dfn>Graphics Acceleration</dfn> <dfn>Graphics Acceleration</dfn>
<ul> <ul>
<li> <li>
<dfn>Disable Graphics Hardware Acceleration (requires restart)</dfn>: <dfn>Use intermediate image-surface to render canvas (requires restart)</dfn>:
Ardour uses hardware accelerated UI rendering by default for speed. Ardour uses hardware accelerated UI rendering by default for speed.
Sometimes though, a buggy driver can cause this to make the system slow or Sometimes though, a buggy driver can cause this to make the system slow or
unstable. Checking this will make Ardour draw its UI without unstable. Checking this will make Ardour draw its UI without
@ -375,6 +373,23 @@
saturation of the notes color proportional to its velocity, hence making saturation of the notes color proportional to its velocity, hence making
a more veloce note more intense in color. a more veloce note more intense in color.
</li> </li>
<li>
<dfn>Display note names in track headers</dfn>: allows selecting in
which scenario Ardour will display note names:
<ul>
<li>
<em>Always</em> — Ardour will always try to display note names
regardless of whether they are available through a MIDNAM file.
</li>
<li>
<em>When Available</em> — Ardour will only show note names when
they are provided in a MIDNAM file.
</li>
<li>
<em>Never</em> — Ardour will never display note names.
</li>
</ul>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -499,8 +514,9 @@
<dfn>Display Action-Buttons</dfn> <dfn>Display Action-Buttons</dfn>
<ul> <ul>
<li> <li>
<dfn>Column <em>n</em></dfn> enables or disables the visibility <dfn>Column <em>n</em></dfn> enables or disables the visibility of the
of the six possible columns of <a href="@@other-toolbar-items#mode_selector">Lua script buttons</a>. six possible columns of
<a href="@@other-toolbar-items#mode_selector">Lua script buttons</a>.
Each columns contains two user-assignable buttons. Each columns contains two user-assignable buttons.
</li> </li>
</ul> </ul>
@ -610,15 +626,15 @@
editor and mixer. This setting requires a restart of Ardour to take effect. editor and mixer. This setting requires a restart of Ardour to take effect.
</li> </li>
<li> <li>
<dfn>Float detached monitor-section window</dfn>: as the <a href="@@monitor-section"> <dfn>Float detached monitor-section window</dfn>: as the
monitor section</a> can be detached from the mixer, this option makes it a <a href="@@monitor-section">monitor section</a> can be detached from
floating window, which may be handled differently by the windowing system the mixer, this option makes it a floating window, which may be handled
and easier to access. differently by the windowing system and easier to access.
</li> </li>
<li> <li>
<dfn>Render Canvas on openGL texture (requires restart)</dfn>: Ardour <dfn>Allow to resize Engine Dialog</dfn>: allow to resize the engine
will render the edutor canvas on an OpenGL texture to try improving dialog window to work around a bug on some XWayland systems that render
graphics performance. this dialog as blank.
</li> </li>
</ul> </ul>
</li> </li>
@ -640,7 +656,7 @@
</li> </li>
</ul> </ul>
<h2 id="preferences-editor">Editor</h2> <h3 id="preferences-appearance-regions">Regions</h3>
<ul> <ul>
<li> <li>
@ -662,6 +678,11 @@
</li> </li>
</ul> </ul>
</li> </li>
</ul>
<h2 id="preferences-editor">Editor</h2>
<ul>
<li> <li>
<dfn>Scroll and Zoom Behaviors</dfn> <dfn>Scroll and Zoom Behaviors</dfn>
<ul> <ul>
@ -763,8 +784,8 @@
<ul> <ul>
<li>Clear the Region Selection: nothing is selected anymore</li> <li>Clear the Region Selection: nothing is selected anymore</li>
<li>Select only the newly-created regions BEFORE the split point: <li>Select only the newly-created regions BEFORE the split point:
</li>if regions have been affected by the split, then the regions if regions have been affected by the split, then the regions
created by the split before the split point is selected created by the split before the split point is selected</li>
<li>Select only the newly-created regions BEFORE the split point: <li>Select only the newly-created regions BEFORE the split point:
same as above, for the regions created after the split point</li> same as above, for the regions created after the split point</li>
<li>Select the newly-created regions: sum of the two above, i.e. all <li>Select the newly-created regions: sum of the two above, i.e. all
@ -782,7 +803,7 @@
<ul> <ul>
<li> <li>
<dfn>General Snap options:</dfn> <dfn>General Snap options</dfn> :
<ul> <ul>
<li> <li>
<dfn>Snap Threshold (pixels):</dfn> is the maximum distance between <dfn>Snap Threshold (pixels):</dfn> is the maximum distance between
@ -808,7 +829,7 @@
and end of the resulting selecting box will both be grid anchors. and end of the resulting selecting box will both be grid anchors.
</li> </li>
<li> <li>
<dfn>Grid switches to alternate selection for Internal Edit Tools</dfn> <dfn>Grid switches to alternate selection for Internal Edit Tools</dfn>.
Two levels of grid mode can coexist in Ardour, one for global regions Two levels of grid mode can coexist in Ardour, one for global regions
manipulations, and one for finer, in-region editing (e.g. for placing manipulations, and one for finer, in-region editing (e.g. for placing
MIDI events in a MIDI region). When this option is checked, entering MIDI events in a MIDI region). When this option is checked, entering
@ -821,6 +842,9 @@
</li> </li>
</ul> </ul>
</li> </li>
<li>
<dfn>Snap Target Mode</dfn>:
<ul>
<li> <li>
<dfn>When "Snap" is enabled, snap to:</dfn> <dfn>When "Snap" is enabled, snap to:</dfn>
Lists the different possible anchors to which an object should snap to, among: Lists the different possible anchors to which an object should snap to, among:
@ -834,6 +858,28 @@
</ul> </ul>
</li> </li>
</ul> </ul>
</li>
<li>
<dfn>Snap Targets</dfn>
<ul>
<li>
<dfn>Markers</dfn>: whether markers are snap targets
</li>
<li>
<dfn>Playhead</dfn>: whether the playhead is a snap targets
</li>
<li>
<dfn>Region Sync Points</dfn>: whether region sync points are snap targets
</li>
<li>
<dfn>Regions Starts</dfn>: whether regions starts are snap targets
</li>
<li>
<dfn>Regions Ends</dfn>: whether regions ends are snap targets
</li>
</ul>
</li>
</ul>
<h3 id="preferences-editor-modifiers">Modifiers</h3> <h3 id="preferences-editor-modifiers">Modifiers</h3>
@ -905,7 +951,7 @@
range. E.g. B4 is B on the fourth octave. range. E.g. B4 is B on the fourth octave.
</li> </li>
<li> <li>
<dfn>Maximum note length</dfn> sets the height of MIDI notes in pixels <dfn>Maximum note height</dfn> sets the height of MIDI notes in pixels
at maximum vertical zoom. Attempting to zoom in closer will result in at maximum vertical zoom. Attempting to zoom in closer will result in
scrolling the pianoroll up or down. scrolling the pianoroll up or down.
</li> </li>
@ -1449,7 +1495,7 @@
See <a href="@@monitoring">Monitoring</a> for more information. See <a href="@@monitoring">Monitoring</a> for more information.
</li> </li>
<li> <li>
<dfn>Auto Input does 'Talkback'</dfn> when enabled, the <dfn>Auto Input does 'talkback'</dfn> when enabled, the
<kbd class="option">Transport > Auto Input</kbd> option also sets <kbd class="option">Transport > Auto Input</kbd> option also sets
the tracks to monitor its audio input when transport is not rolling. the tracks to monitor its audio input when transport is not rolling.
</li> </li>
@ -1647,16 +1693,6 @@
</li> </li>
</ul> </ul>
</li> </li>
<li>
<dfn>Tempo</dfn>
<ul>
<li>
<dfn>Default tempo ruler state for new sessions</dfn>: allows choosing
whether a tempo map is created by default or requires the user to
build it from mapping performance to bars and beats.
</li>
</ul>
</li>
</ul> </ul>
@ -1918,4 +1954,3 @@
</ul> </ul>
</li> </li>
</ul> </ul>