Skip to content

Commit

Permalink
Add content panel
Browse files Browse the repository at this point in the history
  • Loading branch information
helgoboss committed Nov 22, 2024
1 parent 2b85e7f commit 642b084
Show file tree
Hide file tree
Showing 43 changed files with 112 additions and 58 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.
1 change: 1 addition & 0 deletions doc/helgobox/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
*** xref:plug-in/user-interface/menu-bar.adoc[]
* xref:app.adoc[]
** xref:app/user-interface.adoc[]
*** xref:app/user-interface/general.adoc[]
*** xref:app/user-interface/title-bar.adoc[]
*** xref:app/user-interface/navigation-bar.adoc[]
*** xref:app/user-interface/settings-dialog.adoc[]
Expand Down
58 changes: 58 additions & 0 deletions doc/helgobox/modules/ROOT/pages/app/user-interface/general.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
= General usage

This page describes the basic usage of common user interface elements in the Helgobox app.

== Drag fields

image::playtime::generated/screenshots/elements/toolbar/tempo.png[]

A drag field allows you to adjust numeric values in various ways.

include::partial$app/user-interface/interactions/mouse-dragging.adoc[]
include::partial$app/user-interface/interactions/mouse-wheel-scrolling.adoc[]
include::partial$app/user-interface/interactions/touchpad-panning.adoc[]
include::partial$app/user-interface/interactions/text-entry.adoc[]
include::partial$app/user-interface/interactions/reset-to-default.adoc[]
include::partial$app/user-interface/interactions/fine-adjustment.adoc[]

== Knobs

image::playtime::generated/screenshots/elements/toolbar/play-rate.png[]

A knob allows you to adjust numeric values in various ways.

include::partial$app/user-interface/interactions/mouse-dragging.adoc[]
include::partial$app/user-interface/interactions/mouse-wheel-scrolling.adoc[]
include::partial$app/user-interface/interactions/touchpad-panning.adoc[]
include::partial$app/user-interface/interactions/text-entry.adoc[]
include::partial$app/user-interface/interactions/reset-to-default.adoc[]
include::partial$app/user-interface/interactions/fine-adjustment.adoc[]

== Sliders

image::playtime::generated/screenshots/elements/track-panel/volume.png[]

A slider allows you to adjust numeric values in various ways.

include::partial$app/user-interface/interactions/mouse-dragging.adoc[]
include::partial$app/user-interface/interactions/mouse-wheel-scrolling.adoc[]
include::partial$app/user-interface/interactions/touchpad-panning.adoc[]
include::partial$app/user-interface/interactions/reset-to-default.adoc[]

== Search lists

image::playtime::generated/screenshots/main/sequences.png[]

Search lists allow you to pick an item from a potentially large list.

icon:search[] Search::
Simply enter text to drill the list down to items matching your search text.

icon:keyboard-o[] Navigate::
Press kbd:[↑] or kbd:[↓] to navigate within the list of items.

↕ Scroll::
Scroll within the list using the scrollbar on the right or using the mousewheel.

icon:mouse-pointer[] Select::
Click the item or press kbd:[Enter] to select it.
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.
3 changes: 3 additions & 0 deletions doc/playtime/modules/ROOT/pages/user-interface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ include::partial$user-interface/nav-bar-desc.adoc[]
xref:user-interface/toolbar.adoc[]::
include::partial$user-interface/toolbar-desc.adoc[]

xref:user-interface/content-panel.adoc[]::
include::partial$user-interface/content-panel-desc.adoc[]

xref:user-interface/matrix-area.adoc[]::
include::partial$user-interface/matrix-area-desc.adoc[]

Expand Down
12 changes: 12 additions & 0 deletions doc/playtime/modules/ROOT/pages/user-interface/content-panel.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
= Content panel

include::partial$user-interface/content-panel-desc.adoc[]

You can close the content panel by pressing the icon:close[] button on the left side, which appears as soon as your mouse hovers over the area.

include::partial$generated/elements/waveform-view.adoc[]

The waveform view shows only the relevant section of the actual audio file.
Which part is relevant, is dictated by the clip properties xref:user-interface/inspector/clip.adoc#inspector-clip-source-cut-start[] and xref:user-interface/inspector/clip.adoc#inspector-clip-source-cut-length[].

If you set the clip properties xref:user-interface/inspector/clip.adoc#inspector-clip-start-position[] or xref:user-interface/inspector/clip.adoc#inspector-clip-length[], you will see start and end markers.
57 changes: 1 addition & 56 deletions doc/playtime/modules/ROOT/pages/user-interface/general.adoc
Original file line number Diff line number Diff line change
@@ -1,58 +1,3 @@
= General usage

This page describes the basic usage of common user interface elements in Playtime.

== Drag fields

image::generated/screenshots/elements/toolbar/tempo.png[]

A drag field allows you to adjust numeric values in various ways.

include::partial$user-interface/interactions/mouse-dragging.adoc[]
include::partial$user-interface/interactions/mouse-wheel-scrolling.adoc[]
include::partial$user-interface/interactions/touchpad-panning.adoc[]
include::partial$user-interface/interactions/text-entry.adoc[]
include::partial$user-interface/interactions/reset-to-default.adoc[]
include::partial$user-interface/interactions/fine-adjustment.adoc[]

== Knobs

image::generated/screenshots/elements/toolbar/play-rate.png[]

A knob allows you to adjust numeric values in various ways.

include::partial$user-interface/interactions/mouse-dragging.adoc[]
include::partial$user-interface/interactions/mouse-wheel-scrolling.adoc[]
include::partial$user-interface/interactions/touchpad-panning.adoc[]
include::partial$user-interface/interactions/text-entry.adoc[]
include::partial$user-interface/interactions/reset-to-default.adoc[]
include::partial$user-interface/interactions/fine-adjustment.adoc[]

== Sliders

image::generated/screenshots/elements/track-panel/volume.png[]

A slider allows you to adjust numeric values in various ways.

include::partial$user-interface/interactions/mouse-dragging.adoc[]
include::partial$user-interface/interactions/mouse-wheel-scrolling.adoc[]
include::partial$user-interface/interactions/touchpad-panning.adoc[]
include::partial$user-interface/interactions/reset-to-default.adoc[]

== Search lists

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

Search lists allow you to pick an item from a potentially large list.

icon:search[] Search::
Simply enter text to drill the list down to items matching your search text.

icon:keyboard-o[] Navigate::
Press kbd:[↑] or kbd:[↓] to navigate within the list of items.

↕ Scroll::
Scroll within the list using the scrollbar on the right or using the mousewheel.

icon:mouse-pointer[] Select::
Click the item or press kbd:[Enter] to select it.
See xref:helgobox::app/user-interface/general.adoc[general usage] in the Helgobox Reference.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[#area-clip-content-panel-0]
== Clip content panel

image:generated/screenshots/elements/area/clip-content-panel-0.png[Clip content panel, role="related thumb right"]

null

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[#area-content-panel-0]
== Content panel

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

null

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[#area-waveform-viewer-0]
== Waveform viewer

image:generated/screenshots/elements/area/waveform-viewer-0.png[Waveform viewer, role="related thumb right"]

null

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

image::generated/screenshots/elements/tempo-settings/count-in.png[Count-in]

Set the number of count-in bars used when doing pre-roll recording from stopped state.
Set the number of count-in bars used when doing count-in recording from stopped state.

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

image:generated/screenshots/elements/title-bar/purchase-playtime.png[👍 Purchase & Activate, role="related thumb right"]

This shows further information on how you can purchase Playtime and lets you enter the license key. See xref:user-interface/purchase-and-activate-dialog.adoc[].
This shows further information on how you can purchase Playtime and lets you enter the license key.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[#waveform-view]
== Waveform view

image:generated/screenshots/elements/waveform-view.png[Waveform view, role="related thumb right"]

Shows the waveform and the section bounds of a clip.
[NOTE]
.Development status: To be improved
====
In the future, this will probably be enhanced with features such as zooming and editing section bounds.
====

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This area appears when you double-click an audio clip. At the moment, it only contains a waveform view.
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.

0 comments on commit 642b084

Please sign in to comment.