Skip to content

Commit

Permalink
Further doc improvements
Browse files Browse the repository at this point in the history
until Playtime track area
  • Loading branch information
helgoboss committed Nov 21, 2024
1 parent 5e9c5a5 commit ce811ab
Show file tree
Hide file tree
Showing 254 changed files with 546 additions and 71 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.
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ 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.
See xref:realearn::further-concepts/instance.adoc#auto-units[].

include::partial$generated/elements/navbar/show-helgobox-plugin.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ The dialog allows you to adjust the majority of global settings for Helgobox and
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 a description of the product-specific settings, see:
Expand All @@ -15,22 +14,38 @@ For a description of the product-specific settings, see:
== Appearance

include::partial$generated/elements/settings/overall-size.adoc[]

include::partial$generated/elements/settings/roundness.adoc[]

.For Playtime users
TIP: If you want slot cells with rounded corners, play with the xref:playtime::user-interface/settings-dialog.adoc#settings-cell-color-position[] setting!

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

include::partial$generated/elements/settings/hide-window-when-escape-pressed.adoc[]
4 changes: 3 additions & 1 deletion doc/helgobox/modules/ROOT/pages/configuration-files.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Helgobox itself maintains the following files:

`licensing.json`:: Contains license keys

`Helgoboss/App`:: Contains the uncompressed App, if installed
`Helgoboss/App/bin`:: Contains the uncompressed xref:app.adoc[], if installed

`Helgoboss/App/etc/settings.json`:: Contains the global settings for Helgobox and all of its contained products

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/area/nav-bar-0.png[Navigation bar, role="related thumb right"]

null

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/area/window-title-bar-0.png[Title bar, role="related thumb right"]

null

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

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/navbar/home.png[Home, role="related thumb right"]

Shows the Helgobox welcome page.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/navbar/playtime.png[Playtime, role="related thumb right"]

Shows the Playtime Matrix associated with this Helgobox instance.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/navbar/projection.png[ReaLearn Projection, role="related thumb right"]

Shows the ReaLearn Projection page for this Helgobox instance.

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

Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[#settings-color-scheme]
=== Color scheme

image:generated/screenshots/elements/settings/color-scheme.png[Color scheme, role="related thumb right"]
image::generated/screenshots/elements/settings/color-scheme.png[Color scheme]

Choose the prominent color for the user interface.

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

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.
Choose how to render user-defined colors, such as for tracks and clips.

Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@

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.
Adjust how much to dim the Helgobox app window when pressing the dim button.

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

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).
If enabled, the licensee name will be displayed in the window title bar. This only affects commercial Helgobox products, such as Playtime.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
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
@@ -0,0 +1,9 @@
[#settings-hide-window-when-escape-pressed]
=== Hide window when escape pressed

image::generated/screenshots/elements/settings/hide-window-when-escape-pressed.png[Hide window when escape pressed]

If enabled, pressing escape if no dialog is open will hide the window.

This will only have an effect when running embedded within REAPER.

Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@

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.
Adjust the overall size of the user interface, including the font size.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,9 @@
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.
[NOTE]
.Development status: Feedback wanted!
====
This doesn't work particular well at the moment. On Windows, it has caused crashes in the past.
====

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

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.
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 two mouse clicks to choose an option.

If disabled, it will show all options as buttons instead.

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@

image::generated/screenshots/elements/settings/roundness.png[Roundness]

Determines whether to round off corners of various user interface elements and how much.
Choose 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!
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
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
Expand Up @@ -3,4 +3,5 @@

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.
If enabled, some inspector panels will get a special background color that reflects their purpose, such as 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
Expand Up @@ -4,3 +4,4 @@
image::generated/screenshots/elements/settings/use-host-colors.png[Use host colors (experimental)]

Borrows some color from the REAPER theme.

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

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/full-screen.png[Full screen, role="related thumb right"]

Toggles between full-screen and windowed mode.

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

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/help.png[Help, role="related thumb right"]

Shows a help menu

Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ image:generated/screenshots/elements/title-bar/hide-window.png[Hide window, role

Hides the app window.


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

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/panic-midi.png[Panic, role="related thumb right"]

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 @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/pause-arrangement.png[Pause arrangement, role="related thumb right"]

Pauses the REAPER arrangement

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/play-arrangement.png[Play arrangement, role="related thumb right"]

Starts playing the REAPER arrangement

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,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 @@ -6,3 +6,4 @@ image:generated/screenshots/elements/title-bar/refresh.png[Refresh, role="relate
Refreshes the displayed information.

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 @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/save-project.png[Save project, role="related thumb right"]

Saves the current REAPER project

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/settings.png[Settings, role="related thumb right"]

Opens the central settings dialog.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/stop-arrangement.png[Stop arrangement, role="related thumb right"]

Stops the REAPER arrangement

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/theme-mode.png[Theme mode, role="related thumb right"]

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,5 @@

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

Allows you to cycle through all available themes.
Cycle through all available themes.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/toggle-nav-bar.png[Toggle navigation bar, role="related thumb right"]

Shows or hides the navigation bar on the left.

Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
image:generated/screenshots/elements/title-bar/undo.png[Undo, role="related thumb right"]

Undoes the most recent operation performed within this Playtime matrix.

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.
1 change: 1 addition & 0 deletions doc/playtime/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
** xref:user-interface/purchase-and-activate-dialog.adoc[]
** xref:user-interface/settings-dialog.adoc[]
** xref:user-interface/sequences-dialog.adoc[]
** xref:user-interface/arrangement-writing-mode-dialog.adoc[]
** xref:user-interface/tempo-settings-dialog.adoc[]
** xref:user-interface/keyboard-shortcuts.adoc[]
* xref:further-concepts.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion doc/playtime/modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ If you don't see it, do this:
. Select menu:Extensions[Helgobox > Show welcome screen]
. Check "Add Playtime button to main toolbar"

image::screenshots/helgobox-welcome-screen.png[]
image::screenshots/helgobox-welcome-screen.png[width=500]
5 changes: 1 addition & 4 deletions doc/playtime/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@ link:https://www.helgoboss.org/projects/playtime[Playtime] is a modern session v
It is part of the link:https://www.helgoboss.org/projects/helgobox[Helgobox] plug-in.

This reference offers a comprehensive guide to Playtime's concepts and features.
Use it to dive deep into specific functionalities or to better understand how Playtime enhances your workflow.

[IMPORTANT]
====
**If you are a beginner, please use the link:https://github.com/helgoboss/helgobox/wiki/Playtime-Home[Playtime Wiki] instead!**
**If you are a beginner, you also might want to check out the link:https://github.com/helgoboss/helgobox/wiki/Playtime-Home[Playtime Wiki]!**
This reference is targeted at users who are already familiar with the Playtime basics and want to look up specific information.
The Wiki is perfect if you are just starting off.
It guides you through the very basics and contains links to easily digestible video tutorials.
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
= Arrangement writing mode dialog

image::generated/screenshots/main/arrangement-writing-mode.png[]

include::partial$generated/elements/arrangement-writing-mode/replace.adoc[]
include::partial$generated/elements/arrangement-writing-mode/merge-at-cursor.adoc[]
include::partial$generated/elements/arrangement-writing-mode/append.adoc[]
Loading

0 comments on commit ce811ab

Please sign in to comment.