Skip to content

Commit

Permalink
Improve docs until Helgobox navigation bar
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 20, 2024
1 parent bc1771c commit aa068a5
Show file tree
Hide file tree
Showing 88 changed files with 342 additions and 142 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion doc/helgobox/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
* xref:introduction.adoc[]
* xref:products.adoc[]
* xref:installation.adoc[]
* xref:plug-in.adoc[]
** xref:plug-in/key-concepts.adoc[]
** xref:plug-in/user-interface.adoc[]
*** xref:plug-in/user-interface/menu-bar.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/settings-dialog.adoc[]
*** xref:app/user-interface/keyboard-shortcuts.adoc[]
* xref:reaper-actions.adoc[]
* xref:reaper-actions.adoc[]
* xref:configuration-files.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ Within the app, you can use the following keyboard shortcuts.
|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
|Toggles full-screen mode

|kbd:[Shift+Cmd/Ctrl+H]
|Executes the REAPER action xref:helgobox::reaper-actions.adoc#toggle-app-focus[].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The bar on the left is the _Navigation bar_.

Its main purpose is to switch between different user interface pages.
You can show or hide it using the xref:app/user-interface/title-bar.adoc#title-bar-toggle-nav-bar[image:generated/screenshots/elements/title-bar/toggle-nav-bar.png[Toggle navigation bar] button] in the xref:app/user-interface/title-bar.adoc[].

include::partial$generated/elements/navbar/home.adoc[]

Expand All @@ -12,4 +13,10 @@ include::partial$generated/elements/navbar/playtime.adoc[]

include::partial$generated/elements/navbar/enable-disable-global-control.adoc[]

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.

include::partial$generated/elements/navbar/show-helgobox-plugin.adoc[]
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
= Title bar

The bar on the top of the app window is the _Title bar_.
It primarily provides general functions, such as window controls, access to settings, and quick access to the REAPER transport.

image::generated/screenshots/elements/area/window-title-bar-0.png[]

include::partial$generated/elements/title-bar/hide-window.adoc[]

Hiding the window doesn't completely unload the app, it really just hides it.
In order to close it for good, use xref:helgobox::plug-in/user-interface/menu-bar.adoc#close-app[].

include::partial$generated/elements/title-bar/full-screen.adoc[]

include::partial$generated/elements/title-bar/move-window.adoc[]
Expand All @@ -16,6 +20,8 @@ include::partial$generated/elements/title-bar/theme-mode.adoc[]

include::partial$generated/elements/title-bar/dim.adoc[]

The opacity of the opaque window can be adjusted via xref:app/user-interface/settings-dialog.adoc#settings-dim-opacity[].

include::partial$generated/elements/title-bar/settings.adoc[]

include::partial$generated/elements/title-bar/refresh.adoc[]
Expand All @@ -26,6 +32,9 @@ include::partial$generated/elements/title-bar/redo.adoc[]

include::partial$generated/elements/title-bar/theme-switcher.adoc[]

Themes are simply pre-selected combinations of various appearance settings.
Once you’ve selected a theme, you can further customize it by adjusting the settings.

include::partial$generated/elements/title-bar/panic-midi.adoc[]

include::partial$generated/elements/title-bar/save-project.adoc[]
Expand All @@ -38,4 +47,6 @@ 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[]
include::partial$generated/elements/title-bar/helgobox-info.adoc[]

See xref:plug-in/key-concepts.adoc#instance-id[].
32 changes: 32 additions & 0 deletions doc/helgobox/modules/ROOT/pages/configuration-files.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
= Configuration files

Helgobox creates and/or reads a few files in REAPER's resource directory.

For product-specific configuration files, please refer to:

* xref:realearn::configuration-files.adoc[ReaLearn configuration files]
* xref:playtime::configuration-files.adoc[Playtime configuration files]
Helgobox itself maintains the following files:

`Data/helgoboss`:: Directory which contains data such as presets or resources that need to be distributed via ReaPack

`Data/helgoboss/archives`:: Directory which contains archives e.g. the compressed app, distributed via ReaPack

`Data/helgoboss/doc`:: Contains offline documentation as PDFs

`Helgoboss`:: Directory which contains user-specific or device-specific data, not touched via ReaPack

`licensing.json`:: Contains license keys

`Helgoboss/App`:: Contains the uncompressed App, if installed

`Helgoboss/Pot/previews`:: Directory which contains previews recorded by xref:products.adoc#pot-browser[Pot Browser]

`Helgoboss/Server/certificates`:: Contains a list of certificates and corresponding private keys in order to allow encrypted communication with ReaLearn Companion and App.

`Helgoboss/ReaLearn/realearn.ini`:: Very basic global configuration.
The reference to ReaLearn is there just for historical reasons.
Most properties in here affect Helgobox as a whole.
+
Currently supported properties: `server_enabled`, `server_http_port`, `server_https_port`, `server_grpc_port`, `companion_web_app_url`, `showed_welcome_screen`, `background_colors_enabled`
4 changes: 2 additions & 2 deletions doc/helgobox/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Introduction

link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an add-on 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.
link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an add-on for link:https://www.reaper.fm[REAPER] that unites xref:products.adoc[a few creative tools] under one roof, most importantly link:https://www.helgoboss.org/projects/realearn[ReaLearn] and link:https://www.helgoboss.org/projects/playtime[Playtime].

It consists of two components:
It consists of two technical components:

xref:plug-in.adoc[]::
include::partial$plug-in-desc.adoc[]
Expand Down
14 changes: 14 additions & 0 deletions doc/helgobox/modules/ROOT/pages/plug-in/key-concepts.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Key concepts

[[instance]]
== Instance

Helgobox is an instrument plug-in.
That means you can add multiple instances of it, just as you would add multiple instances of a synth or effect.
For example, you could place one instance on the monitoring FX chain and two instances somewhere in your project.

[[instance-id]]
== Instance ID

A randomly assigned ID that uniquely identifies a particular <<instance>>.
Will most likely change after a restart of REAPER!
5 changes: 3 additions & 2 deletions doc/helgobox/modules/ROOT/pages/plug-in/user-interface.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
= User interface

The plug-in's native user interface features a plain and simple design.
It is home to link:https://www.helgoboss.org/projects/realearn[ReaLearn], the controller integration tool of Helgobox.
Refer to the xref:realearn::user-interface.adoc[ReaLearn user interface documentation] to learn more about it!
It mainly hosts link:https://www.helgoboss.org/projects/realearn[ReaLearn], the controller integration tool of Helgobox.

include::partial$realearn-specific-ui-elements.adoc[]

.Plug-in window
image::screenshots/plugin-window.png[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
= Menu bar

include::partial$realearn-specific-ui-elements.adoc[]

== Menu button

This opens the main menu of Helgobox/ReaLearn.
The same menu opens when you right-click an empty area.

It provides the following general entries.

[[open-pot-browser]] Open Pot Browser::
This will open Pot Browser.
See xref:products.adoc#pot-browser[] for details.

[[show-app]]
Show App::
Shows the Helgobox App associated with this Helgobox instance.

[[close-app]]
Close App::
Closes the Helgobox App associated with this Helgobox instance.

[[server]]
Server::
Helgobox features a built-in server which allows the old ReaLearn Companion App (and in the future also the Helgobox App) to connect to Helgobox.
The server runs globally, not per instance!

Enable and start!::: This starts the server and makes sure it will automatically be started next time you use Helgobox.
Disable and stop!::: This stops the server and makes sure it will not be started next time you use Helgobox.
Add firewall rule::: Attempts to add a firewall rule for making the server accessible from other devices or displays instructions how to do it.

== Export to clipboard button

Pressing the export button allows you to copy Helgobox settings to the clipboard so you can import them in another instance or edit them in a text editor.

Export instance as JSON::
Copies a _complete_ dump of this xref:helgobox::plug-in/key-concepts.adoc#instance[] to the clipboard in JSON format.

[[import-from-clipboard]]
== Import from clipboard button

Pressing the import button does the opposite: It restores whatever Helgobox dump is currently in the clipboard.
It supports JSON or Luau.

[[help]]
== Help button (?)

Provides links to the reference and other documentation.
39 changes: 39 additions & 0 deletions doc/helgobox/modules/ROOT/pages/products.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
= Products

Helgobox currently provides the framework for the following products.

[[realearn]]
== ReaLearn

link:https://www.helgoboss.org/projects/realearn[ReaLearn] is a versatile controller integration tool for REAPER.
It lies at the very core of Helgobox, as controller integration is a key aspect of all the other products it contains.

→ Read more about ReaLearn xref:realearn::introduction.adoc[here].

[[playtime]]
== Playtime

link:https://www.helgoboss.org/projects/playtime[Playtime] is a modern session view / clip launcher for REAPER, built straight into Helgobox.
Each xref:helgobox::plug-in/key-concepts.adoc#instance[Helgobox Instance] may contain one _Playtime Matrix_ (by default not loaded).

→ Read more about Playtime xref:playtime::introduction.adoc[here].

[[pot-browser]]
== Pot Browser

Pot Browser is an experimental modern preset browser built straight into Helgobox.
It's just a prototype so far.
It will probably look quite different in the future.
You can open it via menu action xref:plug-in/user-interface/menu-bar.adoc#open-pot-browser[].

It's recommended to use Pot Browser from a ReaLearn instance on the monitoring FX chain, that way you have the browser accessible from any project.

TIP: Add a toolbar button which triggers the REAPER action "ReaLearn: Open first Pot Browser" to get quick and convenient access to the browser.

Remarks:

- Pot Browser is in an experimental stage, it doesn't save any of your settings!
- Each Helgobox instance can have one _Pot Unit_ (by default not loaded).
Each Pot Unit has its own filter and preset state.
When you open the Pot Browser from an instance, it connects to the Pot Unit of that instance.
- ReaLearn's "Pot" targets such as xref:realearn::targets/pot/browse-presets.adoc[] can be used to control the Pot Unit from any controller.
4 changes: 3 additions & 1 deletion doc/helgobox/modules/ROOT/pages/reaper-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ 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]::
Helgobox/General: Toggle app focus::
Switches focus between REAPER and the xref:app.adoc[].
+
The default shortcut is kbd:[Shift+Cmd/Ctrl+H].

== Product-specific actions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,3 @@
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.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

image:generated/screenshots/elements/navbar/playtime.png[Playtime, role="related thumb right"]

Shows the Playtime Clip Matrix associated with this Helgobox instance.
Shows the Playtime Matrix associated with this Helgobox instance.
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@
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.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

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.
Switches between dark, light, and automatic theme modes. In automatic mode, the app will follow your system's theme settings.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ image:generated/screenshots/elements/title-bar/hide-window.png[Hide window, role

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.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

image:generated/screenshots/elements/title-bar/panic-midi.png[Panic, role="related thumb right"]

Attempts to stop any playing or even hanging MIDI notes.
Attempts to stops all currently playing MIDI notes. Whenever you experience hanging notes, press this button.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

image:generated/screenshots/elements/title-bar/redo.png[Redo, role="related thumb right"]


Redoes the most recent operation that was undone within this Playtime matrix.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ image:generated/screenshots/elements/title-bar/refresh.png[Refresh, role="relate

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.
Pressing this button is typically not required during normal operation. However, if there are any issues preventing Helgobox from displaying the latest information automatically, this button can help resolve the problem.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

image:generated/screenshots/elements/title-bar/save-project.png[Save project, role="related thumb right"]

Saves the REAPER project
Saves the current REAPER project
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#title-bar-settings]
== User interface settings
== Settings

image:generated/screenshots/elements/title-bar/settings.png[User interface settings, role="related thumb right"]
image:generated/screenshots/elements/title-bar/settings.png[Settings, role="related thumb right"]

Lets you adjust various settings related to the user interface.
Opens the central settings dialog.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

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.
Switches between dark, light, and automatic theme modes. In automatic mode, the app will follow your system's theme settings.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

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.
Allows you to cycle through all available themes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

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.
Shows or hides the navigation bar on the left.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

image:generated/screenshots/elements/title-bar/undo.png[Undo, role="related thumb right"]


Undoes the most recent operation performed within this Playtime matrix.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
NOTE: This section only describes the few general user interface elements that are _not_ specific to ReaLearn.
Refer to the xref:realearn::user-interface.adoc[ReaLearn user interface documentation] to learn more about all the other elements!
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions doc/playtime/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@
** 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/matrix-area.adoc[]
** xref:user-interface/track-area.adoc[]
** xref:user-interface/inspector.adoc[]
*** xref:user-interface/inspector/matrix.adoc[]
*** xref:user-interface/inspector/column.adoc[]
*** xref:user-interface/inspector/row.adoc[]
*** xref:user-interface/inspector/slot.adoc[]
*** xref:user-interface/inspector/clip.adoc[]
*** xref:user-interface/inspector/track.adoc[]
** xref:user-interface/info-panel.adoc[]
** xref:user-interface/purchase-and-activate-dialog.adoc[]
** xref:user-interface/settings-dialog.adoc[]
Expand All @@ -21,4 +22,5 @@
** xref:user-interface/keyboard-shortcuts.adoc[]
* xref:further-concepts.adoc[]
** xref:further-concepts/general.adoc[]
* xref:reaper-actions.adoc[]
* xref:reaper-actions.adoc[]
* xref:configuration-files.adoc[]
5 changes: 5 additions & 0 deletions doc/playtime/modules/ROOT/pages/configuration-files.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Configuration files

In addition to the xref:helgobox::configuration-files.adoc[general configuration files], Playtime maintains the following ones:

`Helgoboss/Playtime/settings.json`:: Contains global configuration that affects all Playtime instances.
Loading

0 comments on commit aa068a5

Please sign in to comment.