-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve docs until Helgobox navigation bar
- Loading branch information
Showing
88 changed files
with
342 additions
and
142 deletions.
There are no files selected for viewing
Binary file modified
BIN
+870 Bytes
(100%)
doc/helgobox/modules/ROOT/images/generated/screenshots/main/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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[] |
49 changes: 49 additions & 0 deletions
49
doc/helgobox/modules/ROOT/pages/plug-in/user-interface/menu-bar.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
doc/helgobox/modules/ROOT/partials/generated/elements/title-bar/settings.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
doc/helgobox/modules/ROOT/partials/realearn-specific-ui-elements.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
Binary file modified
BIN
-74.3 KB
(21%)
...laytime/modules/ROOT/images/generated/screenshots/elements/area/inspector-0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-98 Bytes
(98%)
...ytime/modules/ROOT/images/generated/screenshots/elements/area/matrix-area-0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-6 Bytes
(100%)
...ytime/modules/ROOT/images/generated/screenshots/elements/area/matrix-area-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-86 Bytes
(100%)
...ytime/modules/ROOT/images/generated/screenshots/elements/area/matrix-area-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+8.08 KB
(110%)
...aytime/modules/ROOT/images/generated/screenshots/elements/area/track-area-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-19 Bytes
(100%)
doc/playtime/modules/ROOT/images/generated/screenshots/elements/column-cell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-3 Bytes
(100%)
...dules/ROOT/images/generated/screenshots/elements/column-cell/exclusive-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-3 Bytes
(100%)
...odules/ROOT/images/generated/screenshots/elements/column-cell/follow-scenes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-10 Bytes
(99%)
...odules/ROOT/images/generated/screenshots/elements/column-cell/has-overrides.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-5 Bytes
(100%)
...aytime/modules/ROOT/images/generated/screenshots/elements/column-cell/label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+3 Bytes
(100%)
...laytime/modules/ROOT/images/generated/screenshots/elements/column-cell/stop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+3.58 KB
...me/modules/ROOT/images/generated/screenshots/elements/inspector/track/color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+5.83 KB
...ime/modules/ROOT/images/generated/screenshots/elements/inspector/track/name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-98 Bytes
(98%)
doc/playtime/modules/ROOT/images/generated/screenshots/elements/matrix-cell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-2 Bytes
(100%)
...ime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+4 Bytes
(100%)
...laytime/modules/ROOT/images/generated/screenshots/elements/matrix-cell/stop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-12 Bytes
(100%)
doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+5 Bytes
(100%)
doc/playtime/modules/ROOT/images/generated/screenshots/elements/row-cell/label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+0 Bytes
(100%)
...time/modules/ROOT/images/generated/screenshots/elements/row-cell/play-scene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-349 Bytes
(100%)
doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen-areas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-45.1 KB
(90%)
doc/playtime/modules/ROOT/images/generated/screenshots/main/main-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+85.6 KB
doc/playtime/modules/ROOT/images/screenshots/helgobox-welcome-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Oops, something went wrong.