Improve docs

doc/helgobox/modules/ROOT/nav.adoc

@@ -1,3 +1,11 @@
 * xref:introduction.adoc[]
 * xref:installation.adoc[]
-* xref:usage.adoc[]
+* xref:usage.adoc[]
+* xref:plug-in.adoc[]
+** xref:plug-in/user-interface.adoc[]
+* xref:app.adoc[]
+** xref:app/user-interface.adoc[]
+*** xref:app/user-interface/title-bar.adoc[]
+*** xref:app/user-interface/navigation-bar.adoc[]
+*** xref:app/user-interface/keyboard-shortcuts.adoc[]
+* xref:reaper-actions.adoc[]

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

@@ -0,0 +1,6 @@
+= 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[]

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

@@ -0,0 +1,6 @@
+= User interface
+
+The Helgobox instrument plug-in's user interface primarily provides the user interface for link:https://www.helgoboss.org/projects/realearn[ReaLearn]. Refer to the xref:realearn::user-interface.adoc[] section of the ReaLearn Reference for details.
+
+.Plug-in window
+image::screenshots/plugin-window.png[]

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

@@ -0,0 +1,41 @@
+= Keyboard shortcuts
+
+Within the app, you can use the following keyboard shortcuts.
+
+|===
+|Shortcut |Purpose
+
+|kbd:[Esc]
+|Hides the app window.
+
+By default, you can quickly bring it back by pressing kbd:[Shift+Cmd/Ctrl+P].
+
+|kbd:[F]
+|Toggle full-screen mode
+
+|kbd:[Shift+Cmd/Ctrl+H]
+|Executes the REAPER action xref:helgobox::reaper-actions.adoc#toggle-app-focus[].
+
+|===
+
+Depending on the currently selected page, more keyboard shortcuts are available:
+
+- xref:playtime::user-interface/keyboard-shortcuts.adoc[Playtime shortcuts]
+
+[TIP]
+====
+**Normal REAPER's keyboard shortcuts are generally disabled when the app is focused!**
+
+This prevents conflicts and ensures flexibility for adding more app shortcuts in the future.
+
+If you want to use a certain REAPER shortcut while the app is focused, you must make it global:
+
+. Open menu:Actions[Show action list...]
+. Press btn:[Find shortcut...]
+. Press the shortcut key
++
+The action list should jump to the action mapped to that key.
+. Double-click the desired shortcut in the "Shortcuts for selected action" list
+. Change the property "Scope" to **Global**
+. Press btn:[OK]
+====

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

@@ -0,0 +1,14 @@
+= Navigation bar
+
+The bar on the left is the _Navigation bar_.
+Its main purpose is to switch between different user interface pages.
+
+include::partial$generated/elements/navbar/home.adoc[]
+
+include::partial$generated/elements/navbar/projection.adoc[]
+
+include::partial$generated/elements/navbar/playtime.adoc[]
+
+include::partial$generated/elements/navbar/enable-disable-global-control.adoc[]
+
+include::partial$generated/elements/navbar/show-helgobox-plugin.adoc[]

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

@@ -0,0 +1,39 @@
+= Title bar
+
+The bar on the top of the app window is the _Title bar_.
+
+include::partial$generated/elements/title-bar/hide-window.adoc[]
+
+include::partial$generated/elements/title-bar/full-screen.adoc[]
+
+include::partial$generated/elements/title-bar/move-window.adoc[]
+
+include::partial$generated/elements/title-bar/toggle-nav-bar.adoc[]
+
+include::partial$generated/elements/title-bar/theme-mode.adoc[]
+
+include::partial$generated/elements/title-bar/dim.adoc[]
+
+include::partial$generated/elements/title-bar/settings.adoc[]
+
+include::partial$generated/elements/title-bar/refresh.adoc[]
+
+include::partial$generated/elements/title-bar/undo.adoc[]
+
+include::partial$generated/elements/title-bar/redo.adoc[]
+
+include::partial$generated/elements/title-bar/theme-switcher.adoc[]
+
+include::partial$generated/elements/title-bar/panic-midi.adoc[]
+
+include::partial$generated/elements/title-bar/save-project.adoc[]
+
+include::partial$generated/elements/title-bar/play-arrangement.adoc[]
+
+include::partial$generated/elements/title-bar/stop-arrangement.adoc[]
+
+include::partial$generated/elements/title-bar/pause-arrangement.adoc[]
+
+include::partial$generated/elements/title-bar/help.adoc[]
+
+include::partial$generated/elements/title-bar/helgobox-info.adoc[]

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

@@ -0,0 +1 @@
+= Helgobox Instrument Plug-In

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

@@ -0,0 +1 @@
+= User interface

doc/helgobox/modules/ROOT/pages/reaper-actions.adoc

@@ -0,0 +1,30 @@
+= REAPER actions
+
+== General actions
+
+Helgobox provides a few global REAPER actions.
+
+You can find those actions directly in the menu menu:Extensions[Helgobox].
+Alternatively, search for "helgobox" in REAPER's action list (menu:Actions[Show action list...]).
+
+[TIP]
+====
+On Linux, you currently need to add at least one Helgobox FX instance to make the actions available.
+
+This is likely going to change in the future.
+For the time being, it can be useful to put a Helgobox instance on REAPER's monitoring FX chain in order to have access to those actions at all times.
+====
+
+Helgobox/General: Show welcome screen::
+Shows the welcome screen that was displayed after the first installation of Helgobox.
+
+[#toggle-app-focus]
+Helgobox/General: Toggle app focus kbd:[Shift+Cmd/Ctrl+H]::
+Switches focus between REAPER and the xref:app.adoc[].
+
+== Product-specific actions
+
+The products contained in Helgobox provide additional actions:
+
+- xref:realearn::reaper-actions.adoc[ReaLearn actions]
+- xref:playtime::reaper-actions.adoc[Playtime actions]

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

@@ -1,4 +1,4 @@
-= Usage
+= 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].
@@ -11,24 +11,17 @@ 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 Helgobox instrument plug-in, which primarily provides the user interface for link:https://www.helgoboss.org/projects/realearn[ReaLearn]:
+Initially, you see the xref:plug-in.adoc[]:
 
 .Plug-in window
-image::helgobox/screenshots/plugin-window.png[]
+image::screenshots/plugin-window.png[]
 
 == Show the Helgobox App
 
-Helgobox also provides an App, which primarily provides the user interface for link:https://www.helgoboss.org/projects/playtime[Playtime].
-Each Helgobox instance can display its own App window, embedded into REAPER:
+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::helgobox/screenshots/app-window.png[]
-
-As an alternative, you can use the convenient btn:[Playtime] button in REAPER's main toolbar.
-If you don't see it, do this:
-
-. Select menu:Extensions[Helgobox > Show welcome screen]
-. Check "Add Playtime button to main toolbar"
+image::screenshots/app-window.png[]

doc/helgobox/modules/ROOT/partials/generated/elements/navbar/enable-disable-global-control.adoc

@@ -0,0 +1,10 @@
+[#navbar-enable-disable-global-control]
+== Enable/disable global control
+
+image:generated/screenshots/elements/navbar/enable-disable-global-control.png[Enable/disable global control, role="related thumb right"]
+
+Enables or disables the usage of global controllers for this Helgobox instance.
+
+If enabled, all connected controllers that you have equipped will load their corresponding main preset. You can configure controllers using the settings button in the window title bar.
+
+If disabled, global controllers will be ignored in this instance. You still have the freedom to create a custom control experience using ReaLearn.

doc/helgobox/modules/ROOT/partials/generated/elements/navbar/home.adoc

@@ -0,0 +1,6 @@
+[#navbar-home]
+== Home
+
+image:generated/screenshots/elements/navbar/home.png[Home, role="related thumb right"]
+
+Shows the Helgobox welcome page.

doc/helgobox/modules/ROOT/partials/generated/elements/navbar/playtime.adoc

@@ -0,0 +1,6 @@
+[#navbar-playtime]
+== Playtime
+
+image:generated/screenshots/elements/navbar/playtime.png[Playtime, role="related thumb right"]
+
+Shows the Playtime Clip Matrix associated with this Helgobox instance.

doc/helgobox/modules/ROOT/partials/generated/elements/navbar/projection.adoc

@@ -0,0 +1,8 @@
+[#navbar-projection]
+== ReaLearn Projection
+
+image:generated/screenshots/elements/navbar/projection.png[ReaLearn Projection, role="related thumb right"]
+
+Shows the ReaLearn Projection page for this Helgobox instance.
+
+The main part of ReaLearn can be found in the Helgobox plug-in! The app only contains the Projection feature of ReaLearn.

doc/helgobox/modules/ROOT/partials/generated/elements/navbar/show-helgobox-plugin.adoc

@@ -0,0 +1,6 @@
+[#navbar-show-helgobox-plugin]
+== Show Helgobox plug-in
+
+image:generated/screenshots/elements/navbar/show-helgobox-plugin.png[Show Helgobox plug-in, role="related thumb right"]
+
+Opens the Helgobox plug-in which is controlled by this app.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/dim.adoc

@@ -0,0 +1,6 @@
+[#title-bar-dim]
+== Dim
+
+image:generated/screenshots/elements/title-bar/dim.png[Dim, role="related thumb right"]
+
+Toggles between a transparent and opaque window. Useful for quickly having a look what REAPER is doing under the hood ;)

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/full-screen.adoc

@@ -0,0 +1,6 @@
+[#title-bar-full-screen]
+== Full screen
+
+image:generated/screenshots/elements/title-bar/full-screen.png[Full screen, role="related thumb right"]
+
+Toggles between full-screen and windowed mode.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/helgobox-info.adoc

@@ -0,0 +1,6 @@
+[#title-bar-helgobox-info]
+== Helgobox Info
+
+image:generated/screenshots/elements/title-bar/helgobox-info.png[Helgobox Info, role="related thumb right"]
+
+Shows the version number of this Helgobox installation as well as the ID of the Helgobox instance to which this App window is connected.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/help.adoc

@@ -0,0 +1,6 @@
+[#title-bar-help]
+== Help
+
+image:generated/screenshots/elements/title-bar/help.png[Help, role="related thumb right"]
+
+Shows a help menu

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/hide-window.adoc

@@ -0,0 +1,8 @@
+[#title-bar-hide-window]
+== Hide window
+
+image:generated/screenshots/elements/title-bar/hide-window.png[Hide window, role="related thumb right"]
+
+Hides the app window.
+
+You can show it again by pressing Shift+Cmd+P (customizable in REAPER action window, see action "Show/hide Playtime") or the Playtime button in the REAPER toolbar.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/move-window.adoc

@@ -0,0 +1,6 @@
+[#title-bar-move-window]
+== Move window
+
+image:generated/screenshots/elements/title-bar/move-window.png[Move window, role="related thumb right"]
+
+Drag this button to move the window. Useful when the window is very narrow, in which case the main drag area in the center will disappear.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/panic-midi.adoc

@@ -0,0 +1,6 @@
+[#title-bar-panic-midi]
+== Panic
+
+image:generated/screenshots/elements/title-bar/panic-midi.png[Panic, role="related thumb right"]
+
+Attempts to stop any playing or even hanging MIDI notes.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/pause-arrangement.adoc

@@ -0,0 +1,6 @@
+[#title-bar-pause-arrangement]
+== Pause arrangement
+
+image:generated/screenshots/elements/title-bar/pause-arrangement.png[Pause arrangement, role="related thumb right"]
+
+Pauses the REAPER arrangement

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/play-arrangement.adoc

@@ -0,0 +1,6 @@
+[#title-bar-play-arrangement]
+== Play arrangement
+
+image:generated/screenshots/elements/title-bar/play-arrangement.png[Play arrangement, role="related thumb right"]
+
+Starts playing the REAPER arrangement

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/redo.adoc

@@ -0,0 +1,6 @@
+[#title-bar-redo]
+== Redo
+
+image:generated/screenshots/elements/title-bar/redo.png[Redo, role="related thumb right"]
+
+

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/refresh.adoc

@@ -0,0 +1,8 @@
+[#title-bar-refresh]
+== Refresh
+
+image:generated/screenshots/elements/title-bar/refresh.png[Refresh, role="related thumb right"]
+
+Refreshes the displayed information.
+
+Pressing this button shouldn't be necessary in normal operation, but there might be bugs that prevent Helgobox from displaying the latest information automatically. In this case, this button can help.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/save-project.adoc

@@ -0,0 +1,6 @@
+[#title-bar-save-project]
+== Save project
+
+image:generated/screenshots/elements/title-bar/save-project.png[Save project, role="related thumb right"]
+
+Saves the REAPER project

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/settings.adoc

@@ -0,0 +1,6 @@
+[#title-bar-settings]
+== User interface settings
+
+image:generated/screenshots/elements/title-bar/settings.png[User interface settings, role="related thumb right"]
+
+Lets you adjust various settings related to the user interface.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/stop-arrangement.adoc

@@ -0,0 +1,6 @@
+[#title-bar-stop-arrangement]
+== Stop arrangement
+
+image:generated/screenshots/elements/title-bar/stop-arrangement.png[Stop arrangement, role="related thumb right"]
+
+Stops the REAPER arrangement

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

@@ -0,0 +1,6 @@
+[#title-bar-theme-mode]
+== Theme mode
+
+image:generated/screenshots/elements/title-bar/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/title-bar/theme-switcher.adoc

@@ -0,0 +1,6 @@
+[#title-bar-theme-switcher]
+== Quick theme switcher
+
+image:generated/screenshots/elements/title-bar/theme-switcher.png[Quick theme switcher, role="related thumb right"]
+
+This switches through a few hand-picked combinations of theme-related user interface settings.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/toggle-nav-bar.adoc

@@ -0,0 +1,6 @@
+[#title-bar-toggle-nav-bar]
+== Toggle navigation bar
+
+image:generated/screenshots/elements/title-bar/toggle-nav-bar.png[Toggle navigation bar, role="related thumb right"]
+
+Shows/hides the navigation bar on the left.

doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/undo.adoc

@@ -0,0 +1,6 @@
+[#title-bar-undo]
+== Undo
+
+image:generated/screenshots/elements/title-bar/undo.png[Undo, role="related thumb right"]
+
+

doc/playtime/modules/ROOT/nav.adoc

@@ -1,4 +1,15 @@
 * xref:introduction.adoc[]
 * xref:installation.adoc[]
 * xref:key-concepts.adoc[]
-* xref:user-interface.adoc[]
+* xref:user-interface.adoc[]
+** xref:user-interface/title-bar.adoc[]
+** xref:user-interface/navigation-bar.adoc[]
+** xref:user-interface/toolbar.adoc[]
+** xref:user-interface/matrix.adoc[]
+** xref:user-interface/track-area.adoc[]
+** xref:user-interface/inspector.adoc[]
+** xref:user-interface/info-panel.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/further-concepts.adoc

@@ -0,0 +1 @@
+= Further concepts