Improve docs

doc/helgobox/modules/ROOT/nav.adoc

@@ -7,5 +7,6 @@
 ** xref:app/user-interface.adoc[]
 *** xref:app/user-interface/title-bar.adoc[]
 *** xref:app/user-interface/navigation-bar.adoc[]
+*** xref:app/user-interface/settings-dialog.adoc[]
 *** xref:app/user-interface/keyboard-shortcuts.adoc[]
 * xref:reaper-actions.adoc[]

doc/helgobox/modules/ROOT/pages/app.adoc

@@ -1,6 +1,3 @@
 = Helgobox App
 
-At the moment, the app primarily provides the user interface for xref:playtime::introduction.adoc[Playtime], but it will contain more stuff in the future.
-
-.App window
-image::screenshots/app-window.png[]
+See xref:app/user-interface.adoc[].

doc/helgobox/modules/ROOT/pages/app/user-interface.adoc

@@ -1 +1,11 @@
 = User interface
+
+Each Helgobox instance can display its own xref:app.adoc[] window, embedded into REAPER:
+
+. Open the xref:plug-in.adoc[]
+. Press menu:Menu[Show App]
+
+.App window
+image::screenshots/app-window.png[]
+
+At the moment, the app primarily provides the user interface for xref:playtime::introduction.adoc[Playtime], but it will contain more stuff in the future.

doc/helgobox/modules/ROOT/pages/app/user-interface/settings-dialog.adoc

@@ -0,0 +1,31 @@
+= Settings dialog
+
+image::generated/screenshots/main/settings.png[]
+
+For product-specific settings, see:
+
+* xref:realearn::user-interface/settings-dialog.adoc[ReaLearn settings]
+* xref:playtime::user-interface/settings-dialog.adoc[Playtime settings]
+
+== Appearance
+
+include::partial$generated/elements/settings/overall-size.adoc[]
+include::partial$generated/elements/settings/roundness.adoc[]
+include::partial$generated/elements/settings/prefer-tidy-appearance.adoc[]
+include::partial$generated/elements/settings/display-development-status-hints.adoc[]
+include::partial$generated/elements/settings/display-tooltip-if-help-panel-hidden.adoc[]
+include::partial$generated/elements/settings/display-license-info.adoc[]
+include::partial$generated/elements/settings/prefer-native-popup-menus.adoc[]
+include::partial$generated/elements/settings/theme-mode.adoc[]
+include::partial$generated/elements/settings/use-context-coloring.adoc[]
+include::partial$generated/elements/settings/use-host-colors.adoc[]
+include::partial$generated/elements/settings/contrast.adoc[]
+include::partial$generated/elements/settings/custom-color-rendering.adoc[]
+include::partial$generated/elements/settings/color-scheme.adoc[]
+
+== Title bar
+
+include::partial$generated/elements/settings/dim-opacity.adoc[]
+
+== Shortcuts
+// TODO Escape stuff

doc/helgobox/modules/ROOT/pages/introduction.adoc

@@ -2,8 +2,7 @@
 
 link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an instrument plug-in for link:https://www.reaper.fm[REAPER] that unites the products link:https://www.helgoboss.org/projects/realearn[ReaLearn] and link:https://www.helgoboss.org/projects/playtime[Playtime] under one roof.
 
-In addition to the plug-in, it comes with the Helgobox App, a modern user interface for the Helgobox Instrument.
+In addition to the plug-in, it comes with the xref:app.adoc[], a modern user interface for the Helgobox Instrument.
 It runs embedded in REAPER and in the future also as a separate mobile app (iOS, Android).
 
-The reference of Helgobox itself is mainly about its installation process.
 If you want to learn more about the contained products, please refer to the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference].

doc/helgobox/modules/ROOT/pages/plug-in.adoc

@@ -1 +1,3 @@
 = Helgobox Instrument Plug-In
+
+See xref:plug-in/user-interface.adoc[]

doc/helgobox/modules/ROOT/pages/usage.adoc

@@ -1,7 +1,7 @@
 = Basic usage
 
 This section illustrates the basics of using Helgobox.
-For more information, please refer to the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference].
+For product-specific information, please consult the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference].
 
 == Add plug-in instance
 
@@ -11,17 +11,4 @@ Helgobox is fired up just like any other VST instrument in REAPER: By adding an
 . Select menu:Insert virtual instrument on new track...[]
 . Double-click entry "VSTi: Helgobox - ReaLearn & Playtime (Helgoboss)"
 
-Initially, you see the xref:plug-in.adoc[]:
-
-.Plug-in window
-image::screenshots/plugin-window.png[]
-
-== Show the Helgobox App
-
-Each Helgobox instance can display its own xref:app.adoc[] window, embedded into REAPER:
-
-. Open the Helgobox instrument plug-in
-. Press menu:Menu[Show App]
-
-.App window
-image::screenshots/app-window.png[]
+Initially, you see the xref:plug-in/user-interface.adoc[plug-in user interface]. From there you can open the xref:app/user-interface.adoc[Helgobox App].

doc/helgobox/modules/ROOT/partials/generated/elements/settings/color-scheme.adoc

@@ -0,0 +1,6 @@
+[#settings-color-scheme]
+=== Color scheme
+
+image:generated/screenshots/elements/settings/color-scheme.png[Color scheme, role="related thumb right"]
+
+Choose the prominent color for the user interface.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/contrast.adoc

@@ -0,0 +1,6 @@
+[#settings-contrast]
+=== Contrast
+
+image:generated/screenshots/elements/settings/contrast.png[Contrast, role="related thumb right"]
+
+Choose between multiple color variations that influence the perceived contrast of the app's appearance.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/custom-color-rendering.adoc

@@ -0,0 +1,6 @@
+[#settings-custom-color-rendering]
+=== Custom color rendering
+
+image:generated/screenshots/elements/settings/custom-color-rendering.png[Custom color rendering, role="related thumb right"]
+
+Determines how user-defined colors (e.g. for tracks and clips) will be rendered.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/dim-opacity.adoc

@@ -0,0 +1,6 @@
+[#settings-dim-opacity]
+=== Dim opacity
+
+image:generated/screenshots/elements/settings/dim-opacity.png[Dim opacity, role="related thumb right"]
+
+Determines how much to dim the Helgobox app window when pressing the dim button.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/display-development-status-hints.adoc

@@ -0,0 +1,6 @@
+[#settings-display-development-status-hints]
+=== Display development status hints
+
+image:generated/screenshots/elements/settings/display-development-status-hints.png[Display development status hints, role="related thumb right"]
+
+If enabled, the inspector will display even settings that are not available yet and it will show small annotations about the development state of a feature.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/display-license-info.adoc

@@ -0,0 +1,6 @@
+[#settings-display-license-info]
+=== Display license info
+
+image:generated/screenshots/elements/settings/display-license-info.png[Display license info, role="related thumb right"]
+
+If enabled, the licensee name will be displayed in the window title bar (only when using a commercial component such as Playtime).

doc/helgobox/modules/ROOT/partials/generated/elements/settings/display-tooltip-if-help-panel-hidden.adoc

@@ -0,0 +1,6 @@
+[#settings-display-tooltip-if-help-panel-hidden]
+=== Display tooltip if help panel hidden
+
+image:generated/screenshots/elements/settings/display-tooltip-if-help-panel-hidden.png[Display tooltip if help panel hidden, role="related thumb right"]
+
+If enabled and the help panel in the bottom right corner is not visible, a tooltip will be showed instead.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/overall-size.adoc

@@ -0,0 +1,6 @@
+[#settings-overall-size]
+=== Overall size
+
+image:generated/screenshots/elements/settings/overall-size.png[Overall size, role="related thumb right"]
+
+Allows you to adjust the overall size of the user interface, including the font size.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/prefer-native-popup-menus.adoc

@@ -0,0 +1,6 @@
+[#settings-prefer-native-popup-menus]
+=== Prefer native popup menus (experimental)
+
+image:generated/screenshots/elements/settings/prefer-native-popup-menus.png[Prefer native popup menus (experimental), role="related thumb right"]
+
+If enabled, dropdown and right-click menus will be rendered using your system's native user interface component.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/prefer-tidy-appearance.adoc

@@ -0,0 +1,8 @@
+[#settings-prefer-tidy-appearance]
+=== Prefer tidy appearance
+
+image:generated/screenshots/elements/settings/prefer-tidy-appearance.png[Prefer tidy appearance, role="related thumb right"]
+
+If enabled, the inspector will show dropdown menus even if if they present just a handful of options. This looks more tidy but you will need 2 mouse clicks to choose an option.
+
+If disabled, it will show all options as buttons instead.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/roundness.adoc

@@ -0,0 +1,8 @@
+[#settings-roundness]
+=== Roundness
+
+image:generated/screenshots/elements/settings/roundness.png[Roundness, role="related thumb right"]
+
+Determines whether to round off corners of various user interface elements and how much.
+
+**Tip:** If you want slot cells with rounded corners, play with the cell color position setting!

doc/helgobox/modules/ROOT/partials/generated/elements/settings/theme-mode.adoc

@@ -0,0 +1,6 @@
+[#settings-theme-mode]
+=== Theme mode
+
+image:generated/screenshots/elements/settings/theme-mode.png[Theme mode, role="related thumb right"]
+
+Switches between dark, light and automatic theme mode. In automatic theme mode, the app will adopt your system settings.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/use-context-coloring.adoc

@@ -0,0 +1,6 @@
+[#settings-use-context-coloring]
+=== Use context coloring
+
+image:generated/screenshots/elements/settings/use-context-coloring.png[Use context coloring, role="related thumb right"]
+
+If enabled, some inspector panels will get a special background color that reflects their purpose (e.g. red for recording and green for playback). This makes it easier to distinguish between the purpose of different settings but it may not go so well with the color design of your theme.

doc/helgobox/modules/ROOT/partials/generated/elements/settings/use-host-colors.adoc

@@ -0,0 +1,6 @@
+[#settings-use-host-colors]
+=== Use host colors (experimental)
+
+image:generated/screenshots/elements/settings/use-host-colors.png[Use host colors (experimental), role="related thumb right"]
+
+Borrows some color from the REAPER theme.

doc/playtime/modules/ROOT/nav.adoc

@@ -14,7 +14,11 @@
 *** xref:user-interface/inspector/slot.adoc[]
 *** xref:user-interface/inspector/clip.adoc[]
 ** xref:user-interface/info-panel.adoc[]
-*** xref:user-interface/keyboard-shortcuts.adoc[]
+** xref:user-interface/purchase-and-activate-dialog.adoc[]
+** xref:user-interface/settings-dialog.adoc[]
+** xref:user-interface/sequences-dialog.adoc[]
+** xref:user-interface/tempo-settings-dialog.adoc[]
+** xref:user-interface/keyboard-shortcuts.adoc[]
 * xref:further-concepts.adoc[]
 ** xref:further-concepts/general.adoc[]
 * xref:reaper-actions.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/purchase-and-activate-dialog.adoc

@@ -0,0 +1,3 @@
+= Purchase & Activate dialog
+
+image::generated/screenshots/main/purchase.png[]

doc/playtime/modules/ROOT/pages/user-interface/sequences-dialog.adoc

@@ -0,0 +1,3 @@
+= Sequences dialog
+
+image::generated/screenshots/main/sequences.png[]

doc/playtime/modules/ROOT/pages/user-interface/settings-dialog.adoc

@@ -0,0 +1,19 @@
+= Settings dialog
+
+image::generated/screenshots/main/settings.png[]
+
+== Appearance
+
+include::partial$generated/elements/settings/show-control-unit-frames.adoc[]
+include::partial$generated/elements/settings/show-column-numbers.adoc[]
+include::partial$generated/elements/settings/show-clip-activity.adoc[]
+include::partial$generated/elements/settings/show-cell-selection-as-crosshair.adoc[]
+include::partial$generated/elements/settings/show-hypothetical-play-cursor.adoc[]
+include::partial$generated/elements/settings/cell-color-position.adoc[]
+include::partial$generated/elements/settings/cell-progress-position.adoc[]
+include::partial$generated/elements/settings/cell-width.adoc[]
+include::partial$generated/elements/settings/cell-height.adoc[]
+
+== Engine
+
+include::partial$generated/elements/settings/tempo-latency.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/tempo-settings-dialog.adoc

@@ -0,0 +1,5 @@
+= Tempo settings dialog
+
+image::generated/screenshots/main/tempo-settings.png[]
+
+include::partial$generated/elements/tempo-settings/click-vo

doc/playtime/modules/ROOT/partials/generated/elements/settings/cell-color-position.adoc

@@ -0,0 +1,6 @@
+[#settings-cell-color-position]
+=== Cell color position
+
+image:generated/screenshots/elements/settings/cell-color-position.png[Cell color position, role="related thumb right"]
+
+Determines how a slot cell shows the color of its primary clip.

doc/playtime/modules/ROOT/partials/generated/elements/settings/cell-height.adoc

@@ -0,0 +1,6 @@
+[#settings-cell-height]
+=== Cell height
+
+image:generated/screenshots/elements/settings/cell-height.png[Cell height, role="related thumb right"]
+
+Sets the height of all cells.

doc/playtime/modules/ROOT/partials/generated/elements/settings/cell-progress-position.adoc

@@ -0,0 +1,6 @@
+[#settings-cell-progress-position]
+=== Cell progress position
+
+image:generated/screenshots/elements/settings/cell-progress-position.png[Cell progress position, role="related thumb right"]
+
+Determines how a slot cell shows the playback progress of a clip.

doc/playtime/modules/ROOT/partials/generated/elements/settings/cell-width.adoc

@@ -0,0 +1,6 @@
+[#settings-cell-width]
+=== Cell width
+
+image:generated/screenshots/elements/settings/cell-width.png[Cell width, role="related thumb right"]
+
+Sets the width of all cells relative to their height.

doc/playtime/modules/ROOT/partials/generated/elements/settings/show-cell-selection-as-crosshair.adoc

@@ -0,0 +1,6 @@
+[#settings-show-cell-selection-as-crosshair]
+=== Show cell selection as cross hair
+
+image:generated/screenshots/elements/settings/show-cell-selection-as-crosshair.png[Show cell selection as cross hair, role="related thumb right"]
+
+If enabled, Playtime will not just highlight the currently selected cells but also all other cells which are in the same row and column. Makes it easier to spot the selected cell.

doc/playtime/modules/ROOT/partials/generated/elements/settings/show-clip-activity.adoc

@@ -0,0 +1,8 @@
+[#settings-show-clip-activity]
+=== Show clip activity
+
+image:generated/screenshots/elements/settings/show-clip-activity.png[Show clip activity, role="related thumb right"]
+
+Makes a slot cell light up according to the activity of its clips (e.g. when the clip plays a note).
+
+Depending on color settings, this will be more or less visible. If the cell background is used for displaying the clip progress, it's not going to make a difference at all.

doc/playtime/modules/ROOT/partials/generated/elements/settings/show-column-numbers.adoc

@@ -0,0 +1,6 @@
+[#settings-show-column-numbers]
+=== Show column numbers
+
+image:generated/screenshots/elements/settings/show-column-numbers.png[Show column numbers, role="related thumb right"]
+
+If enabled, a column number will appear on top of each column.

doc/playtime/modules/ROOT/partials/generated/elements/settings/show-control-unit-frames.adoc

@@ -0,0 +1,6 @@
+[#settings-show-control-unit-frames]
+=== Show control unit frames
+
+image:generated/screenshots/elements/settings/show-control-unit-frames.png[Show control unit frames, role="related thumb right"]
+
+If supported grid controllers are connected, Playtime usually shows which part of the matrix they are currently controlling by showing a colored frame. You can disable that.

doc/playtime/modules/ROOT/partials/generated/elements/settings/show-hypothetical-play-cursor.adoc

@@ -0,0 +1,8 @@
+[#settings-show-hypothetical-play-cursor]
+=== Show hypothetical play cursor
+
+image:generated/screenshots/elements/settings/show-hypothetical-play-cursor.png[Show hypothetical play cursor, role="related thumb right"]
+
+If enabled, Playtime will also show an additional red cursor in the waveform view that represents the hypothetical playback position.
+
+This is an expert feature usable for timing and bug analysis and should normally be turned off.

doc/playtime/modules/ROOT/partials/generated/elements/settings/tempo-latency.adoc

@@ -0,0 +1,8 @@
+[#settings-tempo-latency]
+=== Tempo latency
+
+image:generated/screenshots/elements/settings/tempo-latency.png[Tempo latency, role="related thumb right"]
+
+Determines how many milliseconds of audio will be pre-buffered ahead of time.
+
+Higher latencies improve resilience against sudden CPU spikes when playing back audio clips. But they will also increase the time that Playtime needs to respond to ad-hoc tempo changes.

doc/realearn/modules/ROOT/nav.adoc

@@ -20,6 +20,8 @@
 *** xref:user-interface/mapping-panel/glue-section.adoc[]
 *** xref:user-interface/mapping-panel/bottom-section.adoc[]
 *** xref:user-interface/mapping-panel/advanced-settings-dialog.adoc[]
+** xref:user-interface/settings-dialog.adoc[]
+** xref:user-interface/controller-dialog.adoc[]
 * xref:sources.adoc[]
 ** xref:sources/none.adoc[]
 ** xref:sources/midi.adoc[]

doc/realearn/modules/ROOT/pages/user-interface.adoc

@@ -14,4 +14,7 @@ Most of the information in this section focuses on the instrument plug-in.
 Helgobox App::
 This interface is accessible via menu:Menu[Show app] in the plug-in.
 In the future, the app will also be available for mobile devices and offer remote connections to REAPER.
-Currently, the app only provides the interface for Playtime with one exception: ReaLearn's xref:further-concepts/unit.adoc#projection[] feature.
+Currently, the app only provides the interface for Playtime with the following exceptions:
++
+* ReaLearn's xref:further-concepts/unit.adoc#projection[] feature
+* ReaLearn's global controller settings

doc/realearn/modules/ROOT/pages/user-interface/controller-dialog.adoc

@@ -0,0 +1,5 @@
+= Controller dialog
+
+include::partial$available-in-app.adoc[]
+
+image::generated/screenshots/main/controller.png[]

doc/realearn/modules/ROOT/pages/user-interface/settings-dialog.adoc

@@ -0,0 +1,10 @@
+= Settings dialog
+
+include::partial$available-in-app.adoc[]
+
+image::generated/screenshots/main/settings.png[]
+
+== Controllers
+
+include::partial$generated/elements/settings/controllers/add.adoc[]
+include::partial$generated/elements/settings/controllers/delete.adoc[]

doc/realearn/modules/ROOT/partials/available-in-app.adoc

@@ -0,0 +1 @@
+This part of ReaLearn is located in the xref:helgobox::app.adoc[].

doc/realearn/modules/ROOT/partials/generated/elements/settings/controllers/add.adoc

@@ -0,0 +1,6 @@
+[#settings-controllers-add]
+=== Add controller
+
+image:generated/screenshots/elements/settings/controllers/add.png[Add controller, role="related thumb right"]
+
+Adds a new controller.

doc/realearn/modules/ROOT/partials/generated/elements/settings/controllers/delete.adoc

@@ -0,0 +1,6 @@
+[#settings-controllers-delete]
+=== Delete controller
+
+image:generated/screenshots/elements/settings/controllers/delete.png[Delete controller, role="related thumb right"]
+
+Deletes the controller. This can't be undone.