Document Playtime menus

doc/helgobox/modules/ROOT/nav.adoc

@@ -1,8 +1,8 @@
 * xref:introduction.adoc[]
 * xref:products.adoc[]
 * xref:installation.adoc[]
+* xref:key-concepts.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[]

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

@@ -47,6 +47,12 @@ include::partial$generated/elements/title-bar/pause-arrangement.adoc[]
 
 include::partial$generated/elements/title-bar/help.adoc[]
 
+=== Menu entries
+
+include::partial$generated/menus/help/open-helgobox-reference.adoc[]
+include::partial$generated/menus/help/open-helgobox-website.adoc[]
+include::partial$generated/menus/help/highlight-screen-areas.adoc[]
+
 include::partial$generated/elements/title-bar/helgobox-info.adoc[]
 
-See xref:plug-in/key-concepts.adoc#instance-id[].
+See xref:key-concepts.adoc#instance-id[].

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

@@ -11,5 +11,4 @@ The plug-in is fired up just like any other VST instrument in REAPER: By adding
 . Select menu:Insert virtual instrument on new track...[]
 . Double-click entry "VSTi: Helgobox - ReaLearn & Playtime (Helgoboss)"
 
-Initially, you see the plug-in window.
-From there you can open the xref:app/user-interface.adoc[Helgobox App].
+Initially, you see the xref:plug-in/user-interface.adoc[plug-in window].

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

@@ -35,7 +35,7 @@ Add firewall rule::: Attempts to add a firewall rule for making the server acces
 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.
+Copies a _complete_ dump of this xref:key-concepts.adoc#instance[] to the clipboard in JSON format.
 
 [[import-from-clipboard]]
 == Import from clipboard button

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

@@ -14,7 +14,7 @@ xref:realearn::introduction.adoc[→ Read more about ReaLearn]
 == 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 xref:playtime::key-concepts.adoc#matrix[] (by default not loaded).
+Each xref:key-concepts.adoc#instance[Helgobox Instance] may contain one xref:playtime::key-concepts.adoc#matrix[] (by default not loaded).
 
 xref:playtime::introduction.adoc[→ Read more about Playtime]
 

doc/helgobox/modules/ROOT/partials/generated/elements/area/nav-bar-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/nav-bar-0.png[Navigation bar, role="related thumb right"]
 
-null
+
 

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

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/window-title-bar-0.png[Title bar, role="related thumb right"]
 
-null
+
 

doc/helgobox/modules/ROOT/partials/generated/menus/help/highlight-screen-areas.adoc

@@ -0,0 +1,7 @@
+[#title-bar-highlight-screen-areas]
+== Highlight screen areas
+
+
+
+Highlights the most important areas of the main screen.
+

doc/helgobox/modules/ROOT/partials/generated/menus/help/open-helgobox-reference.adoc

@@ -0,0 +1,7 @@
+[#title-bar-open-helgobox-reference]
+== Open Helgobox reference
+
+
+
+Opens the Helgobox Reference online.
+

doc/helgobox/modules/ROOT/partials/generated/menus/help/open-helgobox-website.adoc

@@ -0,0 +1,7 @@
+[#title-bar-open-helgobox-website]
+== Open Helgobox website
+
+
+
+Opens the Helgobox product page.
+

doc/playtime/modules/ROOT/nav.adoc

@@ -1,6 +1,7 @@
 * xref:introduction.adoc[]
 * xref:installation.adoc[]
 * xref:key-concepts.adoc[]
+* xref:usage.adoc[]
 * xref:user-interface.adoc[]
 ** xref:user-interface/general.adoc[]
 ** xref:user-interface/title-bar.adoc[]
@@ -25,6 +26,13 @@
 ** xref:user-interface/sequences-dialog.adoc[]
 ** xref:user-interface/arrangement-writing-mode-dialog.adoc[]
 ** xref:user-interface/tempo-settings-dialog.adoc[]
+** xref:user-interface/smart-record-menu.adoc[]
+** xref:user-interface/matrix-menu.adoc[]
+** xref:user-interface/column-menu.adoc[]
+** xref:user-interface/row-menu.adoc[]
+** xref:user-interface/slot-menu.adoc[]
+** xref:user-interface/clip-menu.adoc[]
+** xref:user-interface/source-menu.adoc[]
 ** xref:user-interface/keyboard-shortcuts.adoc[]
 * xref:further-concepts.adoc[]
 ** xref:further-concepts/general.adoc[]

doc/playtime/modules/ROOT/pages/key-concepts.adoc

@@ -23,7 +23,7 @@ Playtime's purpose is to add one popular flavor of _non-linear_ music production
 A _session view_ or _clip launcher_ is a user interface tailored to <<non-linear-production>> where musical elements are arranged in a grid of rows and columns.
 Each cell typically holds a single musical element, and users can trigger, loop, and record these elements in real time, often for live performance or experimental composition.
 
-Playtime is described as a _session view_.
+Playtime is a session view.
 
 [[matrix]]
 == Matrix
@@ -32,7 +32,7 @@ In Playtime, a _matrix_ is the top-level structure.
 It is fundamentally a two-dimensional grid of <<slot,slots>> that hold <<clip,clips>>, arranged in <<column,columns>> and <<row,rows>>.
 On a broader level, the matrix functions as a container, comparable to a project in REAPER, and includes various settings.
 
-Each xref:helgobox::plug-in/key-concepts.adoc#instance[instance of Helgobox] can load a single Playtime matrix.
+Each xref:helgobox:ROOT:key-concepts.adoc#instance[instance of Helgobox] can load a single Playtime matrix.
 By default, it contains no matrix, so it must be created explicitly.
 This approach ensures that Helgobox instances dedicated solely to xref:realearn::introduction.adoc[ReaLearn] don't consume any Playtime-related CPU or memory resources - you only "pay for what you use".
 

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

@@ -0,0 +1,36 @@
+= Basic usage
+
+Let's get familiar with the basics!
+
+A typical usage scenario of Playtime looks like this:
+
+. <<record>>
+. <<import>>
+. <<play>>
+. <<adjust>>
+. <<structure>>
+. <<arrangement>>
+. <<render>>
+
+In the following sections, we will learn step by step how to do this.
+
+[[record]]
+== Record clips
+
+[[import]]
+== Import existing clips
+
+[[play]]
+== Play clips
+
+[[adjust]]
+== Adjust clips
+
+[[structure]]
+== Structure the song
+
+[[arrangement]]
+== Create an arrangement
+
+[[render]]
+== Render

doc/playtime/modules/ROOT/pages/user-interface/clip-menu.adoc

@@ -0,0 +1,7 @@
+= Clip menu
+
+Right-clicking one of the clips in the xref:user-interface/inspector/slot.adoc#inspector-slot-clip-picker[] opens this context menu.
+
+include::partial$generated/menus/clip/remove-from-slot.adoc[]
+include::partial$generated/menus/clip/promote-to-top.adoc[]
+

doc/playtime/modules/ROOT/pages/user-interface/column-menu.adoc

@@ -0,0 +1,13 @@
+= Column menu
+
+Right-clicking xref:user-interface/matrix-area.adoc#column-cell-label[] opens this context menu.
+
+include::partial$generated/menus/column/rename-column-or-track.adoc[]
+include::partial$generated/menus/column/duplicate.adoc[]
+include::partial$generated/menus/column/insert-column-left.adoc[]
+include::partial$generated/menus/column/insert-column-right.adoc[]
+include::partial$generated/menus/column/insert-column-for-each-selected-track.adoc[]
+include::partial$generated/menus/column/remove.adoc[]
+include::partial$generated/menus/column/remove-keep-track.adoc[]
+include::partial$generated/menus/column/export-to-arrangement.adoc[]
+include::partial$generated/menus/column/export-to-clipboard-as-lua.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/inspector/clip.adoc

@@ -38,6 +38,8 @@ include::partial$generated/elements/inspector/clip/source-info.adoc[]
 
 See xref:key-concepts.adoc#source[].
 
+TIP: Right-clicking this area opens the xref:user-interface/source-menu.adoc[].
+
 include::partial$generated/elements/inspector/clip/color.adoc[]
 
 include::partial$generated/elements/inspector/clip/start-timing.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/inspector/slot.adoc

@@ -4,4 +4,6 @@ You will see this when selecting a xref:user-interface/matrix-area.adoc#slot-cel
 
 include::partial$generated/elements/inspector/slot/clip-picker.adoc[]
 
-For details about the actual clip, see xref:user-interface/inspector/clip.adoc[].
+For details about the actual clip, see xref:user-interface/inspector/clip.adoc[].
+
+TIP: Right-clicking one of the clips opens the xref:user-interface/clip-menu.adoc[].

doc/playtime/modules/ROOT/pages/user-interface/matrix-area.adoc

@@ -32,6 +32,8 @@ include::partial$generated/elements/matrix-cell/settings.adoc[]
 
 See xref:user-interface/inspector/matrix.adoc[].
 
+TIP: Right-clicking this area opens the xref:user-interface/matrix-menu.adoc[].
+
 // Column header cell
 
 include::partial$generated/elements/column-cell.adoc[]
@@ -60,6 +62,8 @@ include::partial$generated/elements/column-cell/label.adoc[]
 
 See xref:user-interface/inspector/column.adoc[].
 
+TIP: Right-clicking this area opens the xref:user-interface/column-menu.adoc[].
+
 // Row cell
 
 include::partial$generated/elements/row-cell.adoc[]
@@ -78,6 +82,8 @@ include::partial$generated/elements/row-cell/label.adoc[]
 
 See xref:user-interface/inspector/row.adoc[].
 
+TIP: Right-clicking this area opens the xref:user-interface/row-menu.adoc[].
+
 // Slot cell
 
 include::partial$generated/elements/slot-cell.adoc[]
@@ -92,6 +98,8 @@ include::partial$generated/elements/slot-cell/content.adoc[]
 
 See xref:user-interface/inspector/slot.adoc[].
 
+TIP: Right-clicking this area opens the xref:user-interface/slot-menu.adoc[].
+
 .Drag-and-drop support
 ****
 Move slot contents::

doc/playtime/modules/ROOT/pages/user-interface/matrix-menu.adoc

@@ -0,0 +1,9 @@
+= Matrix menu
+
+Right-clicking xref:user-interface/matrix-area.adoc#matrix-cell-settings[] opens this context menu.
+
+include::partial$generated/menus/matrix/insert-column-for-each-selected-track.adoc[]
+include::partial$generated/menus/matrix/insert-column-right.adoc[]
+include::partial$generated/menus/matrix/insert-row-below.adoc[]
+include::partial$generated/menus/matrix/export-to-arrangement.adoc[]
+include::partial$generated/menus/matrix/export-to-clipboard-as-lua.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/row-menu.adoc

@@ -0,0 +1,15 @@
+= Row menu
+
+Right-clicking xref:user-interface/matrix-area.adoc#row-cell-label[] opens this context menu.
+
+include::partial$generated/menus/row/rename.adoc[]
+include::partial$generated/menus/row/build-scene-from-currently-playing-clips.adoc[]
+include::partial$generated/menus/row/copy.adoc[]
+include::partial$generated/menus/row/cut.adoc[]
+include::partial$generated/menus/row/paste.adoc[]
+include::partial$generated/menus/row/clear.adoc[]
+include::partial$generated/menus/row/duplicate.adoc[]
+include::partial$generated/menus/row/insert-row-above.adoc[]
+include::partial$generated/menus/row/insert-row-below.adoc[]
+include::partial$generated/menus/row/remove.adoc[]
+include::partial$generated/menus/row/export-to-arrangement.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/slot-menu.adoc

@@ -0,0 +1,13 @@
+= Slot menu
+
+Right-clicking xref:user-interface/matrix-area.adoc#slot-cell-content[] opens this context menu.
+
+include::partial$generated/menus/slot/rename-primary-clip.adoc[]
+include::partial$generated/menus/slot/copy.adoc[]
+include::partial$generated/menus/slot/cut.adoc[]
+include::partial$generated/menus/slot/paste.adoc[]
+include::partial$generated/menus/slot/clear.adoc[]
+include::partial$generated/menus/slot/import-selected-item.adoc[]
+include::partial$generated/menus/slot/import-files.adoc[]
+include::partial$generated/menus/slot/export-primary-clip-to-arrangement.adoc[]
+include::partial$generated/menus/slot/export-primary-clip-to-clipboard-as-lua.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/smart-record-menu.adoc

@@ -0,0 +1,7 @@
+= Smart-record menu
+
+Right-clicking xref:user-interface/toolbar.adoc#toolbar-smart-record[] opens this menu.
+
+include::partial$generated/menus/smart-record/limit-recording-length.adoc[]
+
+This is a shortcut for xref:user-interface/inspector/matrix/recording.adoc#inspector-matrix-limit-recording-length[].

doc/playtime/modules/ROOT/pages/user-interface/source-menu.adoc

@@ -0,0 +1,5 @@
+= Source menu
+
+Right-clicking xref:user-interface/inspector/clip.adoc#inspector-clip-source-info[] opens this context menu.
+
+include::partial$generated/menus/source-info/open-in-media-explorer.adoc[]

doc/playtime/modules/ROOT/pages/user-interface/toolbar.adoc

@@ -29,6 +29,8 @@ Those are different from the REAPER transport controls, as Playtime is capable o
 
 include::partial$generated/elements/toolbar/smart-record.adoc[]
 
+TIP: Right-clicking the smart-record button opens the xref:user-interface/smart-record-menu.adoc[].
+
 include::partial$generated/elements/toolbar/start-stop-playback.adoc[]
 
 If you want to start REAPER playback together with Playtime, you have two options:
@@ -76,6 +78,6 @@ include::partial$generated/elements/toolbar/show-hide-midi-triggers.adoc[]
 The purpose of this feature is to quickly create simple mappings of MIDI keys/pads/buttons to cells.
 If you want to use full-featured grid controllers, such as the Launchpad, see xref:realearn::user-interface/settings-dialog.adoc#controllers[].
 
-The MIDI triggers configured here are specific to this particular xref:helgobox::plug-in/key-concepts.adoc#instance[], not global.
+The MIDI triggers configured here are specific to this particular xref:helgobox:ROOT:key-concepts.adoc#instance[], not global.
 
 include::partial$generated/elements/toolbar/pane-toggler.adoc[]

doc/playtime/modules/ROOT/partials/generated/elements/area/content-panel-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/content-panel-0.png[Content panel, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/info-panel-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/info-panel-0.png[Info panel, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/inspector-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/inspector-0.png[Inspector, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/matrix-area-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/matrix-area-0.png[Matrix area, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/matrix-area-1.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/matrix-area-1.png[Matrix area, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/matrix-area-2.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/matrix-area-2.png[Matrix area, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/matrix-area-3.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/matrix-area-3.png[Matrix area, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/toolbar-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/toolbar-0.png[Toolbar, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/track-area-0.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/track-area-0.png[Track area, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/area/track-area-1.adoc

@@ -3,5 +3,5 @@
 
 image:generated/screenshots/elements/area/track-area-1.png[Track area, role="related thumb right"]
 
-null
+
 

doc/playtime/modules/ROOT/partials/generated/elements/inspector/matrix/recording-play-start-timing-override.adoc

@@ -3,7 +3,7 @@
 
 
 
-null
+
 [NOTE]
 .Development status: Interested?
 ====