Skip to content

Commit

Permalink
Improve Playtime doc structure
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 27, 2024
1 parent 1cb2e42 commit 092992f
Show file tree
Hide file tree
Showing 31 changed files with 57 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ image::generated/screenshots/main/settings.png[]
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]
* xref:playtime:ROOT:user-interface/dialogs/settings-dialog.adoc[Playtime settings]
== Appearance

Expand All @@ -17,7 +17,7 @@ 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!
TIP: If you want slot cells with rounded corners, play with the xref:playtime:ROOT:user-interface/dialogs/settings-dialog.adoc#settings-cell-color-position[] setting!

include::partial$generated/elements/settings/prefer-tidy-appearance.adoc[]

Expand Down
28 changes: 15 additions & 13 deletions doc/playtime/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
** xref:user-interface/toolbar.adoc[]
** xref:user-interface/matrix-area.adoc[]
** xref:user-interface/track-area.adoc[]
** xref:user-interface/info-panel.adoc[]
** xref:user-interface/inspector.adoc[]
*** xref:user-interface/inspector/matrix.adoc[]
*** xref:user-interface/inspector/matrix/playback.adoc[]
Expand All @@ -28,19 +29,20 @@
*** xref:user-interface/inspector/row.adoc[]
*** xref:user-interface/inspector/slot.adoc[]
*** xref:user-interface/inspector/clip.adoc[]
** xref:user-interface/info-panel.adoc[]
** 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/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/dialogs.adoc[]
*** xref:user-interface/dialogs/purchase-and-activate-dialog.adoc[]
*** xref:user-interface/dialogs/settings-dialog.adoc[]
*** xref:user-interface/dialogs/sequences-dialog.adoc[]
*** xref:user-interface/dialogs/arrangement-writing-mode-dialog.adoc[]
*** xref:user-interface/dialogs/tempo-settings-dialog.adoc[]
** xref:user-interface/menus.adoc[]
*** xref:user-interface/smart-record-menu.adoc[]
*** xref:user-interface/menus/matrix-menu.adoc[]
*** xref:user-interface/menus/column-menu.adoc[]
*** xref:user-interface/menus/row-menu.adoc[]
*** xref:user-interface/menus/slot-menu.adoc[]
*** xref:user-interface/menus/clip-menu.adoc[]
*** xref:user-interface/menus/source-menu.adoc[]
** xref:user-interface/keyboard-shortcuts.adoc[]
* xref:further-concepts.adoc[]
** xref:further-concepts/general.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Meta clips open up a whole new world of possibilities. Here are just some of the

. Prepare the matrix and set up MIDI triggers as explained in xref:advanced-usage-scenarios/control-with-items.adoc[]. This should make it possible to play clips using your MIDI keyboard. Make sure that part works.
. Select the track "Playtime" in your REAPER project (this is the track which contains the xref:helgobox::key-concepts.adoc#instance[Helgobox instance], by default the first track in the project)
. Right-click the xref:user-interface/matrix-area.adoc#column-cell-label[] of some column, for example the last column. Choose xref:user-interface/matrix-menu.adoc#matrix-insert-column-for-each-selected-track[].
. Right-click the xref:user-interface/matrix-area.adoc#column-cell-label[] of some column, for example the last column. Choose xref:user-interface/menus/matrix-menu.adoc#matrix-insert-column-for-each-selected-track[].
+
This should add a new column named "Playtime" that plays back its MIDI clips on the "Playtime" track, and can therefore be used to _play other clips_.
.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ When connecting a xref:key-concepts.adoc#grid-controller[] to Playtime, it refle

The _control unit frame_ is a rectangle in the xref:user-interface/matrix-area.adoc[] that shows which portion of the matrix is currently shown on a certain grid controller, according to the current <<control-unit-scrolling,scroll position>>.

The display of control unit frames can be switched off using xref:user-interface/settings-dialog.adoc#settings-show-control-unit-frames[].
The display of control unit frames can be switched off using xref:user-interface/dialogs/settings-dialog.adoc#settings-show-control-unit-frames[].

[[count-in-recording]]
== Count-in recording
Expand Down
8 changes: 4 additions & 4 deletions doc/playtime/modules/ROOT/pages/usage/arrangement.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ You can influence the start and length of the export on the timeline by creating

=== 2. Export the desired content

* If you want to export all clips in the matrix, right-click the xref:user-interface/matrix-area.adoc#matrix-cell[] and choose xref:user-interface/matrix-menu.adoc#matrix-export-to-arrangement[].
* If you want to export all clips in a particular column, right-click the corresponding xref:user-interface/matrix-area.adoc#column-cell[] and choose xref:user-interface/column-menu.adoc#column-export-to-arrangement[].
* If you want to export all clips in a particular row, right-click the corresponding xref:user-interface/matrix-area.adoc#row-cell[] and choose xref:user-interface/row-menu.adoc#row-export-to-arrangement[].
* If you want to export the primary clip of a slot, right-click the corresponding xref:user-interface/matrix-area.adoc#slot-cell[] and choose xref:user-interface/slot-menu.adoc#slot-export-primary-clip-to-arrangement[].
* If you want to export all clips in the matrix, right-click the xref:user-interface/matrix-area.adoc#matrix-cell[] and choose xref:user-interface/menus/matrix-menu.adoc#matrix-export-to-arrangement[].
* If you want to export all clips in a particular column, right-click the corresponding xref:user-interface/matrix-area.adoc#column-cell[] and choose xref:user-interface/menus/column-menu.adoc#column-export-to-arrangement[].
* If you want to export all clips in a particular row, right-click the corresponding xref:user-interface/matrix-area.adoc#row-cell[] and choose xref:user-interface/menus/row-menu.adoc#row-export-to-arrangement[].
* If you want to export the primary clip of a slot, right-click the corresponding xref:user-interface/matrix-area.adoc#slot-cell[] and choose xref:user-interface/menus/slot-menu.adoc#slot-export-primary-clip-to-arrangement[].

.Quickly export different parts of your song
[TIP]
Expand Down
6 changes: 3 additions & 3 deletions doc/playtime/modules/ROOT/pages/usage/create.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Use matrix templates::
Instead of creating the column manually, you could also have started with a template by pressing the xref:user-interface/matrix-area.adoc#matrix-mixed-template-button[], for example.
Import existing tracks::
Maybe you have existing tracks already that you want to use as xref:key-concepts.adoc#column-track[column tracks]. In that case, select them, right-click xref:user-interface/matrix-area.adoc#matrix-cell-settings[] and choose xref:user-interface/matrix-menu.adoc#matrix-insert-column-for-each-selected-track[].
Maybe you have existing tracks already that you want to use as xref:key-concepts.adoc#column-track[column tracks]. In that case, select them, right-click xref:user-interface/matrix-area.adoc#matrix-cell-settings[] and choose xref:user-interface/menus/matrix-menu.adoc#matrix-insert-column-for-each-selected-track[].
****

== 2. Create a clip
Expand All @@ -41,7 +41,7 @@ Maybe you have an existing audio or MIDI file somewhere on your computer. Simply
.Alternatives
****
Use file picker::
You can pick the file using Playtime's own file picker by right-clicking an empty slot and pressing xref:user-interface/slot-menu.adoc#slot-import-files[].
You can pick the file using Playtime's own file picker by right-clicking an empty slot and pressing xref:user-interface/menus/slot-menu.adoc#slot-import-files[].
****

[[import-item]]
Expand All @@ -50,7 +50,7 @@ You can pick the file using Playtime's own file picker by right-clicking an empt
Maybe you have an existing item on a REAPER track that you want to turn into a Playtime clip.

. Select the item
. Right-click an empty slot and choose xref:user-interface/slot-menu.adoc#slot-import-selected-item[]
. Right-click an empty slot and choose xref:user-interface/menus/slot-menu.adoc#slot-import-selected-item[]

This does more than just importing the audio file or MIDI data from the item! It also translates many of the item's properties, such as the item cut and pitch, to Playtime clip properties.

Expand Down
8 changes: 4 additions & 4 deletions doc/playtime/modules/ROOT/pages/usage/structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Playtime's xref:user-interface/matrix-area.adoc[] suits itself for organizing th

== Rename slots

Renaming a slot is as easy as selecting the xref:user-interface/matrix-area.adoc#slot-cell[] and pressing kbd:[F2], or right-clicking the cell and selecting xref:user-interface/slot-menu.adoc#slot-rename-primary-clip[].
Renaming a slot is as easy as selecting the xref:user-interface/matrix-area.adoc#slot-cell[] and pressing kbd:[F2], or right-clicking the cell and selecting xref:user-interface/menus/slot-menu.adoc#slot-rename-primary-clip[].

== Add more columns

You can add more columns, for example one column per instrument.

You can rename a column or its corresponding xref:key-concepts.adoc#column-track[] by selecting the xref:user-interface/matrix-area.adoc#column-cell[] and pressing kbd:[F2], or right-clicking the cell and selecting xref:user-interface/column-menu.adoc#column-rename-column-or-track[].
You can rename a column or its corresponding xref:key-concepts.adoc#column-track[] by selecting the xref:user-interface/matrix-area.adoc#column-cell[] and pressing kbd:[F2], or right-clicking the cell and selecting xref:user-interface/menus/column-menu.adoc#column-rename-column-or-track[].

== Drag and drop things

Expand All @@ -22,7 +22,7 @@ You can freely drag and drop slot contents or other things. Check out the follow

== Add more rows

You can add more rows if you are running out of vertical space for your clips. Just press the xref:user-interface/matrix-area.adoc#matrix-add-row[] button or right-click a xref:user-interface/matrix-area.adoc#row-cell[] and choose xref:user-interface/row-menu.adoc#row-insert-row-below[].
You can add more rows if you are running out of vertical space for your clips. Just press the xref:user-interface/matrix-area.adoc#matrix-add-row[] button or right-click a xref:user-interface/matrix-area.adoc#row-cell[] and choose xref:user-interface/menus/row-menu.adoc#row-insert-row-below[].

Renaming works just as with columns.

Expand All @@ -38,4 +38,4 @@ In order to change the color of an individual clip, select the xref:user-interfa

One particular way to make use of rows of the matrix is to consider a row as a xref:key-concepts.adoc#scene[] - a part within a song. By organizing your clips into scenes, the scene column on the left of the matrix basically turns into a playlist for your song, which is very convenient if you want to xref:usage/arrangement.adoc[turn the song into an arrangement].

One function which greatly helps to build scenes (apart from drag-and-drop and copy-and-paste) is xref:user-interface/row-menu.adoc#row-build-scene-from-currently-playing-clips[], which you can access by right-clicking the xref:user-interface/matrix-area.adoc#row-cell-label[] of an empty row.
One function which greatly helps to build scenes (apart from drag-and-drop and copy-and-paste) is xref:user-interface/menus/row-menu.adoc#row-build-scene-from-currently-playing-clips[], which you can access by right-clicking the xref:user-interface/matrix-area.adoc#row-cell-label[] of an empty row.
3 changes: 3 additions & 0 deletions doc/playtime/modules/ROOT/pages/user-interface/dialogs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Dialogs

Dialogs are small windows that are opened on demand.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Settings dialog

This dialog opens when pressing the xref:helgobox::app/user-interface/title-bar.adoc#title-bar-settings[] button in the title bar and navigating to the Playtime section.
This dialog opens when pressing the xref:helgobox:ROOT:app/user-interface/title-bar.adoc#title-bar-settings[] button in the title bar and navigating to the Playtime section.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This tab displays information about the current state of the Playtime engine.

include::partial$generated/elements/info-panel/stats/tempo-buffer-size.adoc[]

See xref:user-interface/settings-dialog.adoc#settings-tempo-latency[].
See xref:user-interface/dialogs/settings-dialog.adoc#settings-tempo-latency[].

include::partial$generated/elements/info-panel/stats/pre-buffered-blocks-playing-min.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ 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[].
TIP: Right-clicking this area opens the xref:user-interface/menus/source-menu.adoc[].

include::partial$generated/elements/inspector/clip/color.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::partial$generated/elements/inspector/slot/clip-picker.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[].
TIP: Right-clicking one of the clips opens the xref:user-interface/menus/clip-menu.adoc[].

[[clip-drag-and-drop]]
.Drag-and-drop support
Expand Down
12 changes: 6 additions & 6 deletions doc/playtime/modules/ROOT/pages/user-interface/matrix-area.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ 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[].
TIP: Right-clicking this area opens the xref:user-interface/menus/matrix-menu.adoc[].

// Column cell

include::partial$generated/elements/column-cell.adoc[]

If you don't see the upper part, check xref:user-interface/settings-dialog.adoc#settings-show-column-numbers[].
If you don't see the upper part, check xref:user-interface/dialogs/settings-dialog.adoc#settings-show-column-numbers[].

[[column-drag-and-drop]]
.Column drag-and-drop support
Expand All @@ -71,7 +71,7 @@ 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[].
TIP: Right-clicking this area opens the xref:user-interface/menus/column-menu.adoc[].

// Row cell

Expand All @@ -92,7 +92,7 @@ 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[].
TIP: Right-clicking this area opens the xref:user-interface/menus/row-menu.adoc[].

// Slot cell

Expand All @@ -108,7 +108,7 @@ 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[].
TIP: Right-clicking this area opens the xref:user-interface/menus/slot-menu.adoc[].

[[slot-drag-and-drop]]
.Slot drag-and-drop support
Expand All @@ -122,7 +122,7 @@ Drag this area onto another slot while holding kbd:[Cmd/Ctrl] in order to copy a
Import content::
Drag a MIDI or audio file from outside onto this area in order to import it as a clip. This should work from the REAPER media explorer, from other plug-ins that offer dragging out content as files and from most file managers.
+
NOTE: Dragging REAPER items onto the slot won't work, because REAPER items are not real files. Use xref:user-interface/slot-menu.adoc#slot-import-selected-item[] instead!
NOTE: Dragging REAPER items onto the slot won't work, because REAPER items are not real files. Use xref:user-interface/menus/slot-menu.adoc#slot-import-selected-item[] instead!
****

include::partial$generated/elements/slot-cell/clip-count.adoc[]
Expand Down
3 changes: 3 additions & 0 deletions doc/playtime/modules/ROOT/pages/user-interface/menus.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Menus

Most of the menus in Playtime are context menus that you can open by right-clicking certain areas.
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ include::partial$generated/elements/title-bar/purchase-playtime.adoc[]

This button is displayed only if your copy of Playtime has not been activated yet.

See xref:user-interface/purchase-and-activate-dialog.adoc[].
See xref:user-interface/dialogs/purchase-and-activate-dialog.adoc[].
6 changes: 3 additions & 3 deletions doc/playtime/modules/ROOT/pages/user-interface/toolbar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ include::partial$generated/elements/toolbar/tempo-section.adoc[]

include::partial$generated/elements/toolbar/metronome.adoc[]

See xref:user-interface/tempo-settings-dialog.adoc[].
See xref:user-interface/dialogs/tempo-settings-dialog.adoc[].

NOTE: The Playtime metronome is only audible when REAPER is not playing. When REAPER is playing, REAPER's normal metronome takes over. This is also the reason why Playtime automatically syncs Playtime's metronome on/off status to REAPER's metronome on/off status.

Expand Down Expand Up @@ -67,13 +67,13 @@ After recording, Playtime will automatically remove silence at the beginning of

include::partial$generated/elements/toolbar/matrix-sequence-picker.adoc[]

See xref:user-interface/sequences-dialog.adoc[].
See xref:user-interface/dialogs/sequences-dialog.adoc[].

include::partial$generated/elements/toolbar/play-stop-matrix-sequence.adoc[]

include::partial$generated/elements/toolbar/write-to-arrangement.adoc[]

If the Playtime column tracks already contain items, pressing this button will show the xref:user-interface/arrangement-writing-mode-dialog.adoc[].
If the Playtime column tracks already contain items, pressing this button will show the xref:user-interface/dialogs/arrangement-writing-mode-dialog.adoc[].

include::partial$generated/elements/toolbar/show-hide-midi-triggers.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ image::playtime::generated/screenshots/elements/info-panel/stats/pre-buffer-miss

The number of times in which any audio clip's dynamic pre-buffer couldn't provide the desired pre-rendered audio content and even the static pre-buffer failed to provide it.

If this rises from time to time, it's usually no reason to worry. Often the non-provided audio content lies within the count-in section of a clip, which is most likely silence anyway. However, if this continuously rises, it's not good and you will might experience audio dropouts or even completely silent clips. In this case, increasing REAPER's audio device buffer size and/or decreasing the sample rate might help. You can also try to increase Playtime's tempo latency.
If this rises from time to time, it's usually no reason to worry. Often the non-provided audio content lies within the count-in section of a clip, which is most likely silence anyway. However, if this continuously rises, it's not good, and you might experience audio dropouts or even completely silent clips. In this case, increasing REAPER's audio device buffer size and/or decreasing the sample rate might help. You can also try to increase Playtime's tempo latency.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ifndef::pdf-theme[[[inspector-matrix-recording-looped,Looped]]]

image::playtime::generated/screenshots/elements/inspector/matrix/recording-looped.png[Looped]

If this is enabled, a clip will immediately start playing after it has been recorded and it will be looped.
If this is enabled, a clip will immediately start playing after it has been recorded, and it will be looped.

If disabled, the clip will be stopped after its recording and it will be a **One shot**.

Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ image::playtime::generated/screenshots/elements/toolbar/matrix-start-timing.png[

Decides when a clip actually starts playing after you have triggered its playback.

This setting applies to all clips in the matrix but it can be overridden at column and clip level.
This setting applies to all clips in the matrix, but it can be overridden at column and clip level.

Loading

0 comments on commit 092992f

Please sign in to comment.