Skip to content

Commit

Permalink
Further doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 20, 2024
1 parent aa068a5 commit 5e9c5a5
Show file tree
Hide file tree
Showing 60 changed files with 37 additions and 29 deletions.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ Within the app, you can use the following keyboard shortcuts.
|Hides the app window.

|kbd:[F]
|Toggles full-screen mode
|Toggles full-screen mode.

|kbd:[F1]
|Opens online help for the element that is currently under the mouse cursor.

|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,7 +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[].
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[]] button in the xref:app/user-interface/title-bar.adoc[].

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
= Settings dialog

The dialog allows you to adjust the majority of global settings for Helgobox and its contained products.
You can open it by pressing the xref:app/user-interface/title-bar.adoc#title-bar-settings[
image:generated/screenshots/elements/title-bar/settings.png[]] button in the xref:app/user-interface/title-bar.adoc[].


image::generated/screenshots/main/settings.png[]

For product-specific settings, see:
For a description of the product-specific settings, see:

* xref:realearn::user-interface/settings-dialog.adoc[ReaLearn settings]
* xref:playtime::user-interface/settings-dialog.adoc[Playtime settings]
Expand Down
10 changes: 5 additions & 5 deletions doc/helgobox/modules/ROOT/pages/products.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
= Products
= Contained products

Helgobox currently provides the framework for the following products.
Helgobox 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].
xref:realearn::introduction.adoc[→ Read more about ReaLearn]

[[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).
Each xref:helgobox::plug-in/key-concepts.adoc#instance[Helgobox Instance] may contain one xref:playtime::key-concepts.adoc#matrix[] (by default not loaded).

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

[[pot-browser]]
== Pot Browser
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-contrast]
=== Contrast

image:generated/screenshots/elements/settings/contrast.png[Contrast, role="related thumb right"]
image::generated/screenshots/elements/settings/contrast.png[Contrast]

Choose between multiple color variations that influence the perceived contrast of the app's appearance.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/custom-color-rendering.png[Custom color rendering]

Determines how user-defined colors (e.g. for tracks and clips) will be rendered.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/display-development-status-hints.png[Display development status hints]

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.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/display-license-info.png[Display license info]

If enabled, the licensee name will be displayed in the window title bar (only when using a commercial component such as Playtime).
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/display-tooltip-if-help-panel-hidden.png[Display tooltip if help panel hidden]

If enabled and the help panel in the bottom right corner is not visible, a tooltip will be showed instead.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-overall-size]
=== Overall size

image:generated/screenshots/elements/settings/overall-size.png[Overall size, role="related thumb right"]
image::generated/screenshots/elements/settings/overall-size.png[Overall size]

Allows you to adjust the overall size of the user interface, including the font size.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/prefer-native-popup-menus.png[Prefer native popup menus (experimental)]

If enabled, dropdown and right-click menus will be rendered using your system's native user interface component.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-prefer-tidy-appearance]
=== Prefer tidy appearance

image:generated/screenshots/elements/settings/prefer-tidy-appearance.png[Prefer tidy appearance, role="related thumb right"]
image::generated/screenshots/elements/settings/prefer-tidy-appearance.png[Prefer tidy appearance]

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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-roundness]
=== Roundness

image:generated/screenshots/elements/settings/roundness.png[Roundness, role="related thumb right"]
image::generated/screenshots/elements/settings/roundness.png[Roundness]

Determines whether to round off corners of various user interface elements and how much.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-theme-mode]
=== Theme mode

image:generated/screenshots/elements/settings/theme-mode.png[Theme mode, role="related thumb right"]
image::generated/screenshots/elements/settings/theme-mode.png[Theme mode]

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
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/use-context-coloring.png[Use context coloring]

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.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/use-host-colors.png[Use host colors (experimental)]

Borrows some color from the REAPER theme.
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.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/cell-color-position.png[Cell color position]

Determines how a slot cell shows the color of its primary clip.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-cell-height]
=== Cell height

image:generated/screenshots/elements/settings/cell-height.png[Cell height, role="related thumb right"]
image::generated/screenshots/elements/settings/cell-height.png[Cell height]

Sets the height of all cells.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/cell-progress-position.png[Cell progress position]

Determines how a slot cell shows the playback progress of a clip.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[#settings-cell-width]
=== Cell width

image:generated/screenshots/elements/settings/cell-width.png[Cell width, role="related thumb right"]
image::generated/screenshots/elements/settings/cell-width.png[Cell width]

Sets the width of all cells relative to their height.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/show-cell-selection-as-crosshair.png[Show cell selection as cross hair]

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.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#settings-show-clip-activity]
=== Show clip activity

image:generated/screenshots/elements/settings/show-clip-activity.png[Show clip activity, role="related thumb right"]
image::generated/screenshots/elements/settings/show-clip-activity.png[Show clip activity]

Makes a slot cell light up according to the activity of its clips (e.g. when the clip plays a note).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/show-column-numbers.png[Show column numbers]

If enabled, a column number will appear on top of each column.
Original file line number Diff line number Diff line change
@@ -1,6 +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"]
image::generated/screenshots/elements/settings/show-control-unit-frames.png[Show control unit frames]

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.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[#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"]
image::generated/screenshots/elements/settings/show-hypothetical-play-cursor.png[Show hypothetical play cursor]

If enabled, Playtime will also show an additional red cursor in the waveform view that represents the hypothetical playback position.

Expand Down

0 comments on commit 5e9c5a5

Please sign in to comment.