diff --git a/doc/realearn/modules/ROOT/nav.adoc b/doc/realearn/modules/ROOT/nav.adoc index cc9ee4e34..3e3a67ce0 100644 --- a/doc/realearn/modules/ROOT/nav.adoc +++ b/doc/realearn/modules/ROOT/nav.adoc @@ -127,14 +127,14 @@ *** xref:targets/realearn/browse-group-mappings.adoc[] ** xref:targets/virtual.adoc[] * xref:further-concepts.adoc[] -** xref:further-concepts/general-concepts.adoc[] -** xref:further-concepts/instance-concepts.adoc[] -** xref:further-concepts/unit-concepts.adoc[] -** xref:further-concepts/compartment-concepts.adoc[] -** xref:further-concepts/mapping-concepts.adoc[] -** xref:further-concepts/source-concepts.adoc[] -** xref:further-concepts/glue-concepts.adoc[] -** xref:further-concepts/target-concepts.adoc[] +** xref:further-concepts/general.adoc[] +** xref:further-concepts/instance.adoc[] +** xref:further-concepts/unit.adoc[] +** xref:further-concepts/compartment.adoc[] +** xref:further-concepts/mapping.adoc[] +** xref:further-concepts/source.adoc[] +** xref:further-concepts/glue.adoc[] +** xref:further-concepts/target.adoc[] * xref:best-practices.adoc[] * xref:reaper-actions.adoc[] * xref:configuration-files.adoc[] diff --git a/doc/realearn/modules/ROOT/pages/best-practices.adoc b/doc/realearn/modules/ROOT/pages/best-practices.adoc index 8118e8e2c..94d38fdb8 100644 --- a/doc/realearn/modules/ROOT/pages/best-practices.adoc +++ b/doc/realearn/modules/ROOT/pages/best-practices.adoc @@ -20,18 +20,18 @@ Second, it doesn't work if ReaLearn FX is suspended, e.g. in the following cases == Using the controller compartment The xref:key-concepts.adoc#controller-compartment[] lets you describe a xref:key-concepts.adoc#controller[] simply by adding xref:key-concepts.adoc#mapping[mappings]. -When you do that, each xref:key-concepts.adoc#controller-mapping[] represents a xref:key-concepts.adoc#control-element[] on your xref:key-concepts.adoc#controller[], e.g. a xref:further-concepts/mapping-concepts.adoc#momentary-button[] or xref:further-concepts/mapping-concepts.adoc#fader[]. +When you do that, each xref:key-concepts.adoc#controller-mapping[] represents a xref:key-concepts.adoc#control-element[] on your xref:key-concepts.adoc#controller[], e.g. a xref:further-concepts/mapping.adoc#momentary-button[] or xref:further-concepts/mapping.adoc#fader[]. Describing your controller is optional but it brings benefits: -* You can use the xref:further-concepts/unit-concepts.adoc#projection[] feature to project your controller mapping to a smartphone or tablet (link:https://www.youtube.com/watch?v=omuYBznEShk&feature=youtu.be[watch video]). -* You can use xref:further-concepts/compartment-concepts.adoc#controller-preset[controller presets] either built-in ones or those made by other users ... and thereby save precious setup time. +* You can use the xref:further-concepts/unit.adoc#projection[] feature to project your controller mapping to a smartphone or tablet (link:https://www.youtube.com/watch?v=omuYBznEShk&feature=youtu.be[watch video]). +* You can use xref:further-concepts/compartment.adoc#controller-preset[controller presets] either built-in ones or those made by other users ... and thereby save precious setup time. Or you can contribute them yourself! * You can make your xref:key-concepts.adoc#main-mapping[main mappings] independent of the actually used xref:key-concepts.adoc#controller[]. -This is done using xref:further-concepts/source-concepts.adoc#virtual-source[virtual sources] and xref:further-concepts/target-concepts.adoc#virtual-target[virtual targets]. +This is done using xref:further-concepts/source.adoc#virtual-source[virtual sources] and xref:further-concepts/target.adoc#virtual-target[virtual targets]. * It allows you to give your knobs, buttons etc. descriptive and friendly names instead of just e.g. "CC 15". * You don't need to learn your < again and again. -Although the process of learning an element is easy in ReaLearn, it can take some time in case the xref:further-concepts/source-concepts.adoc#midi-source-character[] is not guessed correctly. +Although the process of learning an element is easy in ReaLearn, it can take some time in case the xref:further-concepts/source.adoc#midi-source-character[] is not guessed correctly. Just do it once and be done with it! If you want to make ReaLearn "learn" about your nice controller device, all you need to do is to create a suitable controller mapping for each of its control elements. @@ -44,12 +44,12 @@ Let's first look at the "slow" way to do this - adding and editing each controll . Enter a descriptive name for the xref:key-concepts.adoc#control-element[]. + TIP: This name will appear in many places so you want it to be short, clear and unique! -. Assign a unique xref:further-concepts/target-concepts.adoc#virtual-target[]. -** At this point we don't want to assign a xref:further-concepts/target-concepts.adoc#real-target[] yet. -The point of xref:further-concepts/compartment-concepts.adoc#controller-preset[controller presets] is to make them as reusable as possible, that's why we choose a xref:further-concepts/target-concepts.adoc#virtual-target[]. +. Assign a unique xref:further-concepts/target.adoc#virtual-target[]. +** At this point we don't want to assign a xref:further-concepts/target.adoc#real-target[] yet. +The point of xref:further-concepts/compartment.adoc#controller-preset[controller presets] is to make them as reusable as possible, that's why we choose a xref:further-concepts/target.adoc#virtual-target[]. ** In the _Category_ dropdown, choose _Virtual_. -** As _Type_, choose xref:further-concepts/compartment-concepts.adoc#virtual-control-element-type[] if your control element is a sort of button (something which you can press) or xref:further-concepts/compartment-concepts.adoc#virtual-control-element-type-multi[] in all other cases. -** Use for each xref:key-concepts.adoc#control-element[] a unique combination of xref:further-concepts/compartment-concepts.adoc#virtual-control-element-type[] and xref:further-concepts/compartment-concepts.adoc#virtual-control-element-id[], starting with number *1* and counting. +** As _Type_, choose xref:further-concepts/compartment.adoc#virtual-control-element-type[] if your control element is a sort of button (something which you can press) or xref:further-concepts/compartment.adoc#virtual-control-element-type-multi[] in all other cases. +** Use for each xref:key-concepts.adoc#control-element[] a unique combination of xref:further-concepts/compartment.adoc#virtual-control-element-type[] and xref:further-concepts/compartment.adoc#virtual-control-element-id[], starting with number *1* and counting. + TIP: It's okay and desired to have one control element mapped to "Multi 1" and one to "Button 1". ** Just imagine the "8 generic knobs + 8 generic buttons" layout which is typical for lots of popular controllers. @@ -59,26 +59,26 @@ That opens up all kinds of possibilities. You could for example restrict the target range for a certain control element. Or make an encoder generally slower or faster. Or you could simulate a rotary encoder by making two buttons on your controller act as -/+ buttons emitting relative values. -This is possible by mapping them to the same xref:further-concepts/compartment-concepts.adoc#virtual-control-element[] in xref:user-interface/mapping-panel/glue-section.adoc#incremental-button[]. +This is possible by mapping them to the same xref:further-concepts/compartment.adoc#virtual-control-element[] in xref:user-interface/mapping-panel/glue-section.adoc#incremental-button[]. -Before you go ahead and do that for each control element, you might want to check out what this is good for: Navigate back to the xref:key-concepts.adoc#main-compartment[], learn the xref:key-concepts.adoc#source[] of some xref:key-concepts.adoc#main-mapping[] and touch the xref:key-concepts.adoc#control-element[] that you have just mapped: Take note how ReaLearn will assign a xref:further-concepts/source-concepts.adoc#virtual-source[] this time, not a xref:sources/midi.adoc[MIDI source]! -It will also display the name of the xref:further-concepts/compartment-concepts.adoc#virtual-control-element[] as source label. +Before you go ahead and do that for each control element, you might want to check out what this is good for: Navigate back to the xref:key-concepts.adoc#main-compartment[], learn the xref:key-concepts.adoc#source[] of some xref:key-concepts.adoc#main-mapping[] and touch the xref:key-concepts.adoc#control-element[] that you have just mapped: Take note how ReaLearn will assign a xref:further-concepts/source.adoc#virtual-source[] this time, not a xref:sources/midi.adoc[MIDI source]! +It will also display the name of the xref:further-concepts/compartment.adoc#virtual-control-element[] as source label. -Now, let's say at some point you swap your xref:key-concepts.adoc#controller[] with another one that has a similar layout, all you need to do is to switch the xref:further-concepts/compartment-concepts.adoc#controller-preset[] and you are golden! +Now, let's say at some point you swap your xref:key-concepts.adoc#controller[] with another one that has a similar layout, all you need to do is to switch the xref:further-concepts/compartment.adoc#controller-preset[] and you are golden! You have decoupled your xref:key-concepts.adoc#main-mapping[] from the actual xref:key-concepts.adoc#controller[]. -Plus, you can now take full advantage of the xref:further-concepts/unit-concepts.adoc#projection[] feature. +Plus, you can now take full advantage of the xref:further-concepts/unit.adoc#projection[] feature. All of this might be a bit of an effort, but it's well worth it! Plus, there's a way to do this _a lot_ faster by using _batch learning_: . Press the xref:user-interface/main-panel/mappings-toolbar.adoc#learn-many[]. -. Choose whether you want to learn all the xref:further-concepts/compartment-concepts.adoc#virtual-control-element-type-multi[] elements on your xref:key-concepts.adoc#controller[] or all the xref:further-concepts/compartment-concepts.adoc#virtual-control-element-type[] elements. +. Choose whether you want to learn all the xref:further-concepts/compartment.adoc#virtual-control-element-type-multi[] elements on your xref:key-concepts.adoc#controller[] or all the xref:further-concepts/compartment.adoc#virtual-control-element-type[] elements. . Simply touch all relevant xref:key-concepts.adoc#control-element[control elements] in the desired order. -ReaLearn will take care of automatically incrementing the xref:further-concepts/compartment-concepts.adoc#virtual-control-element-id[]. +ReaLearn will take care of automatically incrementing the xref:further-concepts/compartment.adoc#virtual-control-element-id[]. . Press btn:[Stop]. . Done! ** At this point it's recommended to recheck the learned mappings. -** ReaLearn's xref:further-concepts/source-concepts.adoc#midi-source-character[] detection for MIDI CCs is naturally just a guess, so it can be wrong. +** ReaLearn's xref:further-concepts/source.adoc#midi-source-character[] detection for MIDI CCs is naturally just a guess, so it can be wrong. If so, just adjust the character in the corresponding xref:user-interface/mapping-panel.adoc[]. You can share your preset with other users by sending them to link:mailto:info@helgoboss.org[info@helgoboss.org]. @@ -87,7 +87,7 @@ list]. == Naming compartment parameters -Because ReaLearn's xref:further-concepts/compartment-concepts.adoc#compartment-parameter[compartment parameters] are freely assignable, they have very generic names by default. +Because ReaLearn's xref:further-concepts/compartment.adoc#compartment-parameter[compartment parameters] are freely assignable, they have very generic names by default. However, as soon as you give them meaning by using them in a specific way, it can be very helpful to give them a name by using the xref:user-interface/main-panel/menu-bar.adoc#compartment-parameters[]. == Troubleshooting Luau import diff --git a/doc/realearn/modules/ROOT/pages/configuration-files.adoc b/doc/realearn/modules/ROOT/pages/configuration-files.adoc index 97cf8b592..6b56db697 100644 --- a/doc/realearn/modules/ROOT/pages/configuration-files.adoc +++ b/doc/realearn/modules/ROOT/pages/configuration-files.adoc @@ -4,7 +4,7 @@ ReaLearn creates and/or reads a few files in REAPER's resource directory. `Data/helgoboss`:: Directory which contains data such as presets or resources that need to be distributed via ReaPack -`Data/helgoboss/auto-load-configs/fx.json`:: Contains global FX-to-preset links, see xref:further-concepts/unit-concepts.adoc#auto-load[] +`Data/helgoboss/auto-load-configs/fx.json`:: Contains global FX-to-preset links, see xref:further-concepts/unit.adoc#auto-load[] `Data/helgoboss/archives`:: Directory which contains archives e.g. the compressed app, distributed via ReaPack @@ -20,7 +20,7 @@ ReaLearn creates and/or reads a few files in REAPER's resource directory. `Helgoboss/App`:: Contains the uncompressed App, if installed -`Helgoboss/Pot/previews`:: Directory which contains previews recorded by xref:further-concepts/instance-concepts.adoc#pot-browser[Pot Browser] +`Helgoboss/Pot/previews`:: Directory which contains previews recorded by xref:further-concepts/instance.adoc#pot-browser[Pot Browser] `Helgoboss/ReaLearn/osc.json`:: Global OSC device configurations, see xref:user-interface/main-panel/input-output-section.adoc#manage-osc-devices[] diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/compartment-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/compartment.adoc similarity index 95% rename from doc/realearn/modules/ROOT/pages/further-concepts/compartment-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/compartment.adoc index 82ef72f9a..99b46c44b 100644 --- a/doc/realearn/modules/ROOT/pages/further-concepts/compartment-concepts.adoc +++ b/doc/realearn/modules/ROOT/pages/further-concepts/compartment.adoc @@ -32,7 +32,7 @@ User presets are made by users, for example by you. * Saving your mappings as a preset is optional. All controller mappings are saved together with your current ReaLearn unit anyway, no worries. -But as soon as you want to reuse these mappings in other ReaLearn unit or for xref:further-concepts/unit-concepts.adoc#auto-load[], it makes of course sense to save them as a preset! +But as soon as you want to reuse these mappings in other ReaLearn unit or for xref:further-concepts/unit.adoc#auto-load[], it makes of course sense to save them as a preset! * All of your presets end up in the REAPER resource directory (REAPER → Options → Show REAPER resource path in explorer/finder) at `Data/helgoboss/realearn/presets` followed by `main` (for main compartment presets) or `controller` (for controller compartment presets). They are JSON files and very similar to what you get when you press @@ -60,7 +60,7 @@ For example, if the subdirectory name is `helgoboss` and it contains a preset fi * That also means that presets from different workspaces never conflict with each other. * Therefore, a preset "workspace" is at the same time a preset "namespace". Those terms are sometimes used interchangeably. -* It's important that the ID of a preset doesn't change, especially if you want to use that preset with xref:further-concepts/unit-concepts.adoc#auto-load[]. +* It's important that the ID of a preset doesn't change, especially if you want to use that preset with xref:further-concepts/unit.adoc#auto-load[]. If you change the ID, it's another preset from ReaLearn's perspective! * Conversely, the name of the workspace directory and the name/path of the preset file within the workspace directory should not change! * The only thing that is allowed to change is the file extension. @@ -228,8 +228,8 @@ Currently, only feature `playtime` is supported, which matches if the Helgobox i Each ReaLearn compartment contains 100 freely assignable parameters. Compartment parameters can be used in the following ways: -* For xref:further-concepts/mapping-concepts.adoc#conditional-activation[] (lets the parameter value influence which mappings are active) -* For xref:further-concepts/target-concepts.adoc#dynamic-selector[] (lets the parameter value influence which object (track, FX etc.) is targeted for a specific mapping) +* For xref:further-concepts/mapping.adoc#conditional-activation[] (lets the parameter value influence which mappings are active) +* For xref:further-concepts/target.adoc#dynamic-selector[] (lets the parameter value influence which object (track, FX etc.) is targeted for a specific mapping) * As xref:sources/reaper/realearn-parameter.adoc[] (lets the parameter value control any ReaLearn target) They can be customized as described in xref:user-interface/main-panel/menu-bar.adoc#compartment-parameters[]. @@ -239,10 +239,10 @@ Parameter values will be reset whenever you load a preset (just the ones in that [[continuous-vs-discrete-compartment-parameters]] === Continuous vs. discrete compartment parameters -By default, <> have a xref:further-concepts/target-concepts.adoc#continuous-value-range[]. -Although that makes them very versatile, it's often easier to work with a xref:further-concepts/target-concepts.adoc#discrete-value-range[]. +By default, <> have a xref:further-concepts/target.adoc#continuous-value-range[]. +Although that makes them very versatile, it's often easier to work with a xref:further-concepts/target.adoc#discrete-value-range[]. -Entering a value count (see xref:user-interface/main-panel/menu-bar.adoc#set-compartment-parameter-value-count[]) makes the parameter have a xref:further-concepts/target-concepts.adoc#discrete-value-range[] with the given number of integer values. +Entering a value count (see xref:user-interface/main-panel/menu-bar.adoc#set-compartment-parameter-value-count[]) makes the parameter have a xref:further-concepts/target.adoc#discrete-value-range[] with the given number of integer values. For example, a value count of 10 means that the parameter can represent exactly 10 values (0 to 9). [CAUTION] @@ -308,8 +308,8 @@ that can be reused with many different xref:key-concepts.adoc#controller[control The idea is simple: -1. You define a <> for a DAW controller, mapping each <> (e.g. its first fader, which emits MIDI CC7 messages) to a corresponding <> (e.g. named `ch1/fader`) by using a xref:further-concepts/target-concepts.adoc#virtual-target[]. -2. You define a <>, mapping each <> to some xref:further-concepts/target-concepts.adoc#real-target[] by using a xref:further-concepts/source-concepts.adoc#virtual-source[]. +1. You define a <> for a DAW controller, mapping each <> (e.g. its first fader, which emits MIDI CC7 messages) to a corresponding <> (e.g. named `ch1/fader`) by using a xref:further-concepts/target.adoc#virtual-target[]. +2. You define a <>, mapping each <> to some xref:further-concepts/target.adoc#real-target[] by using a xref:further-concepts/source.adoc#virtual-source[]. For example, you map `ch1/fader` to the xref:targets/track/set-volume.adoc[]. 3. ReaLearn creates a sort of wire between the xref:key-concepts.adoc#controller-compartment[] and the xref:key-concepts.adoc#main-compartment[]. So you can now control the track volume by moving the first fader. diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/general-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/general.adoc similarity index 100% rename from doc/realearn/modules/ROOT/pages/further-concepts/general-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/general.adoc diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/glue-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/glue.adoc similarity index 92% rename from doc/realearn/modules/ROOT/pages/further-concepts/glue-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/glue.adoc index c1b9ef705..ce8c4c88d 100644 --- a/doc/realearn/modules/ROOT/pages/further-concepts/glue-concepts.adoc +++ b/doc/realearn/modules/ROOT/pages/further-concepts/glue.adoc @@ -39,10 +39,10 @@ Let's look at this sequence: It's non-monotonic: It decreases, and then increases again. Even if it would just decrease, it would be non-strict monotonic because it contains duplicates (value 10). -When using xref:further-concepts/mapping-concepts.adoc#absolute-control[], it's no problem stepping through such sequences. +When using xref:further-concepts/mapping.adoc#absolute-control[], it's no problem stepping through such sequences. -However, xref:further-concepts/mapping-concepts.adoc#relative-control[] only supports strictly increasing or strictly decreasing sequences. -So if you control this sequence e.g. via xref:further-concepts/mapping-concepts.adoc#rotary-endless-encoder[] or via xref:user-interface/mapping-panel/glue-section.adoc#incremental-button[], the sequence will be stepped through like this: -5, 8, 10, 20. +However, xref:further-concepts/mapping.adoc#relative-control[] only supports strictly increasing or strictly decreasing sequences. +So if you control this sequence e.g. via xref:further-concepts/mapping.adoc#rotary-endless-encoder[] or via xref:user-interface/mapping-panel/glue-section.adoc#incremental-button[], the sequence will be stepped through like this: -5, 8, 10, 20. Alternative: Use xref:user-interface/mapping-panel/glue-section.adoc#make-absolute[]! ==== @@ -94,7 +94,7 @@ You can do that by using placeholders, delimited by double braces. `{{target.text_value}}` ==== -See xref:further-concepts/target-concepts.adoc#target-property[] for a list of properties that you can use in placeholders. +See xref:further-concepts/target.adoc#target-property[] for a list of properties that you can use in placeholders. [#dynamic-feedback] === Dynamic feedback: Lua script @@ -248,7 +248,7 @@ return { This example is not realistic, it just shows how you can access the value table returned by the glue section feedback script. ==== -You can share code between multiple feedback scripts by using xref:further-concepts/compartment-concepts.adoc#compartment-wide-lua-code[], with the following limitations (which hopefully will be lifted over time): +You can share code between multiple feedback scripts by using xref:further-concepts/compartment.adoc#compartment-wide-lua-code[], with the following limitations (which hopefully will be lifted over time): * The shared code is not yet available to the Lua code editor window. That means writing `require("compartment")` will evaluate to `nil` in the editor. diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/instance-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/instance.adoc similarity index 100% rename from doc/realearn/modules/ROOT/pages/further-concepts/instance-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/instance.adoc diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/mapping-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/mapping.adoc similarity index 96% rename from doc/realearn/modules/ROOT/pages/further-concepts/mapping-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/mapping.adoc index 3c3c6a10c..16fcbab49 100644 --- a/doc/realearn/modules/ROOT/pages/further-concepts/mapping-concepts.adoc +++ b/doc/realearn/modules/ROOT/pages/further-concepts/mapping.adoc @@ -69,7 +69,7 @@ A toggle button is a button that emits 100% when pressed and 0% when pressed aga IMPORTANT: You don't want toggle buttons on the hardware side! They are much less flexible than momentary buttons! Momentary buttons can be turned into toggle buttons by ReaLearn, but not vice versa! -If you have to put up with a hardware toggle button, use xref:further-concepts/source-concepts.adoc#midi-source-character[] xref:further-concepts/source-concepts.adoc#toggle-only-button[]. +If you have to put up with a hardware toggle button, use xref:further-concepts/source.adoc#midi-source-character[] xref:further-concepts/source.adoc#toggle-only-button[]. [[velocity-sensitive-key]] Velocity-sensitive key:: A key emits a value between 0% and 100% when pressed, depending on the velocity with which the key was hit. When released, it will emit 0%. @@ -168,17 +168,17 @@ A mapping is considered as *on* or *active* (terms are used interchangeably) onl . The mapping is enabled as a whole . The mapping has control and/or feedback enabled . The <> is fulfilled -. The xref:further-concepts/target-concepts.adoc#target-activation-condition[] is fulfilled +. The xref:further-concepts/target.adoc#target-activation-condition[] is fulfilled . The target is valid + ==== -Example: A track target can be invalid when it's using xref:further-concepts/target-concepts.adoc#selected-selector[] but no track is currently selected). +Example: A track target can be invalid when it's using xref:further-concepts/target.adoc#selected-selector[] but no track is currently selected). ==== In all other cases, mapping is *off* or *inactive*. In that case, it doesn't have any effect! -(Controller) mappings with xref:further-concepts/target-concepts.adoc#virtual-target[] are always considered active as long as the feedback checkbox is ticked. +(Controller) mappings with xref:further-concepts/target.adoc#virtual-target[] are always considered active as long as the feedback checkbox is ticked. [[mapping-signal-flow]] == Mapping signal flow @@ -226,7 +226,7 @@ Please activate this mapping only if ReaLearn Parameter 1 is *on*!" [[mapping-activation-condition]] == Mapping activation condition -The activation condition of a mapping determines under which circumstances a mapping is active or inactive, based on the value of a xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] or based on the state of arbitrary xref:key-concepts.adoc#target[targets]. +The activation condition of a mapping determines under which circumstances a mapping is active or inactive, based on the value of a xref:further-concepts/compartment.adoc#compartment-parameter[] or based on the state of arbitrary xref:key-concepts.adoc#target[targets]. It is especially practical if your controller has a limited amount of control elements and you want to give control elements several responsibilities. It lets you easily implement use cases such as: @@ -321,7 +321,7 @@ However, that method is pretty limited and hard to maintain because presets are With _Conditional activation_ you can do the same (and more) within just one ReaLearn unit. -TIP: If you want to adjust the number of banks and improve bank handling in general, set a discrete value count for the corresponding bank parameter (see xref:further-concepts/compartment-concepts.adoc#compartment-parameter[]). +TIP: If you want to adjust the number of banks and improve bank handling in general, set a discrete value count for the corresponding bank parameter (see xref:further-concepts/compartment.adoc#compartment-parameter[]). === When EEL met @@ -348,7 +348,7 @@ TIP: For most activation conditions which need this amount of freedom, the newer === When expression met This is very similar to the previous EEL activation mode. -But instead of EEL, it lets you use the same expression language as used in xref:further-concepts/target-concepts.adoc#dynamic-selector[dynamic selectors] to express the activation condition. +But instead of EEL, it lets you use the same expression language as used in xref:further-concepts/target.adoc#dynamic-selector[dynamic selectors] to express the activation condition. The equivalent expression to above EEL example is: @@ -393,7 +393,7 @@ If feedback is set up correctly, this message will be sent to the device wheneve Remarks: -* You can check if the correct feedback messages are sent to the device by enabling xref:further-concepts/unit-concepts.adoc#logging-of-real-feedback-messages[]. +* You can check if the correct feedback messages are sent to the device by enabling xref:further-concepts/unit.adoc#logging-of-real-feedback-messages[]. * Each byte is written using 2 hexadecimal digits. * Spaces between the bytes can be omitted. * You can express all types of MIDI messages using this raw notation (e.g. pitch wheel), not just system-exclusive ones. diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/source-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/source.adoc similarity index 96% rename from doc/realearn/modules/ROOT/pages/further-concepts/source-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/source.adoc index 3ea6d2e9d..ef67df373 100644 --- a/doc/realearn/modules/ROOT/pages/further-concepts/source-concepts.adoc +++ b/doc/realearn/modules/ROOT/pages/further-concepts/source.adoc @@ -7,14 +7,14 @@ We distinguish between _virtual_ and _real_ sources. [[virtual-source]] === Virtual source -A _virtual_ source refers to a xref:further-concepts/compartment-concepts.adoc#virtual-control-element[] and can only be used in the xref:key-concepts.adoc#main-compartment[]. +A _virtual_ source refers to a xref:further-concepts/compartment.adoc#virtual-control-element[] and can only be used in the xref:key-concepts.adoc#main-compartment[]. Examples: `ch1/fader` [[real-source]] === Real source -A _real_ source refers to a xref:further-concepts/compartment-concepts.adoc#real-control-element[]. +A _real_ source refers to a xref:further-concepts/compartment.adoc#real-control-element[]. [[midi-source-character]] == MIDI source character @@ -208,7 +208,7 @@ You can use the `feedback_value_table` xref:user-interface/mapping-panel/glue-se Do a full-text search for `feedback_value_table` in directory `resources/controller-presets` of the link:https://github.com/helgoboss/realearn[ReaLearn source code] to find usage examples. ==== -You can share code between multiple MIDI scripts by using xref:further-concepts/compartment-concepts.adoc#compartment-wide-lua-code[], with the following limitations (which hopefully will be lifted over time): +You can share code between multiple MIDI scripts by using xref:further-concepts/compartment.adoc#compartment-wide-lua-code[], with the following limitations (which hopefully will be lifted over time): * The shared code is not yet available to the Lua code editor window. That means writing `require("compartment")` will evaluate to `nil` in the editor. diff --git a/doc/realearn/modules/ROOT/pages/further-concepts/target-concepts.adoc b/doc/realearn/modules/ROOT/pages/further-concepts/target.adoc similarity index 91% rename from doc/realearn/modules/ROOT/pages/further-concepts/target-concepts.adoc rename to doc/realearn/modules/ROOT/pages/further-concepts/target.adoc index e86f20f75..14d18dd08 100644 --- a/doc/realearn/modules/ROOT/pages/further-concepts/target-concepts.adoc +++ b/doc/realearn/modules/ROOT/pages/further-concepts/target.adoc @@ -7,11 +7,11 @@ We distinguish between _virtual_ and _real_ targets. [[virtual-target]] === Virtual target -A _virtual_ target controls a xref:further-concepts/compartment-concepts.adoc#virtual-control-element[] and can only be used in the xref:key-concepts.adoc#controller-compartment[]. +A _virtual_ target controls a xref:further-concepts/compartment.adoc#virtual-control-element[] and can only be used in the xref:key-concepts.adoc#controller-compartment[]. Example: `ch1/fader` -It's then picked up by a xref:further-concepts/source-concepts.adoc#virtual-source[]] in the xref:key-concepts.adoc#main-compartment[]. +It's then picked up by a xref:further-concepts/source.adoc#virtual-source[]] in the xref:key-concepts.adoc#main-compartment[]. [[real-target]] === Real target @@ -43,7 +43,7 @@ However, the same concepts can easily be applied to other objects that support t [#unit-selector] ==== Unit selector -This selector makes the target work on the current xref:further-concepts/unit-concepts.adoc#unit-track[] or current xref:further-concepts/unit-concepts.adoc#unit-fx[] of this particular ReaLearn xref:key-concepts.adoc#unit[]. +This selector makes the target work on the current xref:further-concepts/unit.adoc#unit-track[] or current xref:further-concepts/unit.adoc#unit-fx[] of this particular ReaLearn xref:key-concepts.adoc#unit[]. [#particular-selector] ==== Particular selector @@ -115,7 +115,7 @@ Special value that represents a "not set" value. See below for examples. | p | Array of floating-point numbers | All selectors | Allows you to access the values of ReaLearn's internal parameters. E.g. you can get the number of the first parameter by writing `p[0]`. -By default, parameter values are normalized floating point values, that means they are decimal numbers between 0.0 and 1.0. This can be changed by customizing the parameter with a specific integer value count (see xref:further-concepts/compartment-concepts.adoc#compartment-parameter[]). +By default, parameter values are normalized floating point values, that means they are decimal numbers between 0.0 and 1.0. This can be changed by customizing the parameter with a specific integer value count (see xref:further-concepts/compartment.adoc#compartment-parameter[]). | p1 ... p100 | Floating-point numbers | All selectors | Values of ReaLearn's internal parameters as single variables. @@ -182,8 +182,8 @@ This only makes sense if used in conjunction with `tcp_fx_indexes`. ==== `p1 * 99` -* Will point to track with index 0 (first track) if xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] 1 is set to the minimum and to track with index 99 (= track number 100) if it's set to the maximum. -* If you use a formula like that, you should make sure that xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] 1 is controlled with a step size that allows for exactly 100 different values. +* Will point to track with index 0 (first track) if xref:further-concepts/compartment.adoc#compartment-parameter[] 1 is set to the minimum and to track with index 99 (= track number 100) if it's set to the maximum. +* If you use a formula like that, you should make sure that xref:further-concepts/compartment.adoc#compartment-parameter[] 1 is controlled with a step size that allows for exactly 100 different values. This conforms to ReaLearn's default step size 0.01 = 1%. * Since ReaLearn 2.13, this is easier because it adds support for integer parameters: ** Set the xref:user-interface/main-panel/menu-bar.adoc#set-compartment-parameter-value-count[] of the parameter to 100 @@ -195,8 +195,8 @@ This conforms to ReaLearn's default step size 0.01 = 1%. ==== `p1 * 3 * 100 + p2 * 99` -This will treat xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] 1 as a kind of bank selector that allows you to choose between exactly 4 banks (0, 1, 2, 3) of 100 tracks each. -xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] 2 will select the track number within the bank. +This will treat xref:further-concepts/compartment.adoc#compartment-parameter[] 1 as a kind of bank selector that allows you to choose between exactly 4 banks (0, 1, 2, 3) of 100 tracks each. +xref:further-concepts/compartment.adoc#compartment-parameter[] 2 will select the track number within the bank. You see, this is very flexible. ==== @@ -305,7 +305,7 @@ Non-sticky selectors:: ``, ``, ``, ``, `> of this ReaLearn unit and keep loading xref:further-concepts/compartment-concepts.adoc#main-preset[main presets] according to which <> you have defined. +If you activate xref:user-interface/main-panel/preset-section.adoc#auto-load-based-on-unit-fx[], ReaLearn will start to observe the <> of this ReaLearn unit and keep loading xref:further-concepts/compartment.adoc#main-preset[main presets] according to which <> you have defined. By default, the unit FX is set to ``, which means, it will reflect whatever FX is currently focused. Whenever the unit FX changes, it will check if you have linked a compartment preset to it and will automatically load it. Whenever the unit FX switches to an unlinked FX or the FX loses focus, ReaLearn falls back to the mapping list or preset that was active before activating auto-load. @@ -43,7 +43,7 @@ Section <> describes how to do that. [[fx-to-preset-link]] == FX-to-preset link -A link between a FX and a xref:further-concepts/compartment-concepts.adoc#main-preset[]. +A link between a FX and a xref:further-concepts/compartment.adoc#main-preset[]. Used in <>. [[unit-fx-to-preset-link]] @@ -91,7 +91,7 @@ This might change in future in favor of a more nuanced approach! The second line of the bottom panel shows the current track chosen as **Unit track** for this unit of ReaLearn. This can be something like "Track 3" or "The currently selected track". -Mappings in this ReaLearn unit can refer to this track by choosing the track selector xref:further-concepts/target-concepts.adoc#unit-selector[]. +Mappings in this ReaLearn unit can refer to this track by choosing the track selector xref:further-concepts/target.adoc#unit-selector[]. The unit track can be changed via xref:targets/track/track.adoc[]. @@ -100,7 +100,7 @@ The unit track can be changed via xref:targets/track/track.adoc[]. The second line of the bottom panel also shows the current FX chosen as **Unit FX** for this unit of ReaLearn. This can be something like "FX 5 on track 3" or "The currently focused track". -Mappings in this ReaLearn unit can refer to this FX by choosing the FX selector xref:further-concepts/target-concepts.adoc#unit-selector[]. +Mappings in this ReaLearn unit can refer to this FX by choosing the FX selector xref:further-concepts/target.adoc#unit-selector[]. The unit FX can be changed via xref:targets/fx/fx.adoc[]. @@ -128,7 +128,7 @@ Logging can be enabled or disabled via xref:user-interface/main-panel/menu-bar.a Each log entry contains the following information: * Timestamp in seconds -* Helgobox xref:further-concepts/instance-concepts.adoc#instance-id[] +* Helgobox xref:further-concepts/instance.adoc#instance-id[] * Message purpose ** *Real control:* A message used for controlling targets. ** *Real learn:* A message used for learning a source. diff --git a/doc/realearn/modules/ROOT/pages/key-concepts.adoc b/doc/realearn/modules/ROOT/pages/key-concepts.adoc index 4ea0a9892..c16519908 100644 --- a/doc/realearn/modules/ROOT/pages/key-concepts.adoc +++ b/doc/realearn/modules/ROOT/pages/key-concepts.adoc @@ -88,7 +88,7 @@ For example, you could place one instance on the monitoring FX chain and two ins Each ReaLearn <> contains at least one _unit_, known as the _main unit_, but it can also contain an arbitrary number of additional units. Units function like "mini instances" within a single ReaLearn <>, allowing that instance to manage multiple controllers simultaneously. -Each unit has its own <>, <>, <>, <>, xref:further-concepts/compartment-concepts.adoc#controller-preset[], xref:further-concepts/compartment-concepts.adoc#main-preset[], and more. +Each unit has its own <>, <>, <>, <>, xref:further-concepts/compartment.adoc#controller-preset[], xref:further-concepts/compartment.adoc#main-preset[], and more. [[compartment]] == Compartment @@ -104,7 +104,7 @@ Its purpose is to define what the controller device should do, e.g., allowing a We refer to the mappings in this compartment as [[main-mapping,Main mapping]] _main mappings_ and to the presets as _main presets_. [[controller-compartment]] Controller compartment:: -The controller compartment is optional and serves two main purposes: Describing all control elements of the controller, assigning them descriptive names and enabling xref:further-concepts/compartment-concepts.adoc#virtual-control[]. +The controller compartment is optional and serves two main purposes: Describing all control elements of the controller, assigning them descriptive names and enabling xref:further-concepts/compartment.adoc#virtual-control[]. + We refer to the mappings in this compartment as [[controller-mapping,Controller mapping]] _controller mappings_ and to the presets as _controller presets_. @@ -121,7 +121,7 @@ Each mapping consists of <>, <> and <>. == Source A _source_ is the part of a <> that typically describes a <> and/or <> on the <>. -More generally, it can be anything that emits xref:further-concepts/mapping-concepts.adoc#control-value[control values]. +More generally, it can be anything that emits xref:further-concepts/mapping.adoc#control-value[control values]. Examples: MIDI source, OSC source @@ -155,4 +155,4 @@ This saves you from the tedious job of setting up MIDI or OSC sources manually. === Learn target Targets can be learned by pressing the xref:user-interface/main-panel/mapping-row.adoc#learn-target[] and then invoking a <> within REAPER. -This saves you from choosing xref:further-concepts/target-concepts.adoc#target-object-selectors[] and other stuff manually. +This saves you from choosing xref:further-concepts/target.adoc#target-object-selectors[] and other stuff manually. diff --git a/doc/realearn/modules/ROOT/pages/sources/keyboard.adoc b/doc/realearn/modules/ROOT/pages/sources/keyboard.adoc index da3716e6d..5b7231b46 100644 --- a/doc/realearn/modules/ROOT/pages/sources/keyboard.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/keyboard.adoc @@ -17,5 +17,5 @@ This is by design! Use xref:user-interface/mapping-panel/glue-section.adoc#fire-after-timeout-keep-firing[] instead. * Key combinations are not supported. This is by design! -Use xref:further-concepts/mapping-concepts.adoc#conditional-activation[] instead. +Use xref:further-concepts/mapping.adoc#conditional-activation[] instead. ==== diff --git a/doc/realearn/modules/ROOT/pages/sources/midi/cc-value.adoc b/doc/realearn/modules/ROOT/pages/sources/midi/cc-value.adoc index 48708c2db..bbf71b3a6 100644 --- a/doc/realearn/modules/ROOT/pages/sources/midi/cc-value.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/midi/cc-value.adoc @@ -8,7 +8,7 @@ Optionally restricts this source to messages with a certain MIDI control-change == Character menu -See xref:further-concepts/source-concepts.adoc#midi-source-character[]. +See xref:further-concepts/source.adoc#midi-source-character[]. == 14-bit values checkbox diff --git a/doc/realearn/modules/ROOT/pages/sources/midi/display.adoc b/doc/realearn/modules/ROOT/pages/sources/midi/display.adoc index df24fee4b..cbc8b0f14 100644 --- a/doc/realearn/modules/ROOT/pages/sources/midi/display.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/midi/display.adoc @@ -28,6 +28,6 @@ Choose the line number. CAUTION: For controllers with multiple displays and lines, ReaLearn allows you to spread your text over all available displays and lines. This is great if you need to display a lot of text but one display doesn't provide enough space. -But be aware: xref:further-concepts/general-concepts.adoc#feedback-relay[] doesn't work nicely anymore if you make use of this feature. +But be aware: xref:further-concepts/general.adoc#feedback-relay[] doesn't work nicely anymore if you make use of this feature. -If you want to know how to define which text shall be sent to the displays, please see xref:further-concepts/glue-concepts.adoc#text-feedback[textual feedback] in the xref:user-interface/mapping-panel/glue-section.adoc[]. \ No newline at end of file +If you want to know how to define which text shall be sent to the displays, please see xref:further-concepts/glue.adoc#text-feedback[textual feedback] in the xref:user-interface/mapping-panel/glue-section.adoc[]. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/sources/midi/midi-script.adoc b/doc/realearn/modules/ROOT/pages/sources/midi/midi-script.adoc index fad1496a2..6569a9d82 100644 --- a/doc/realearn/modules/ROOT/pages/sources/midi/midi-script.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/midi/midi-script.adoc @@ -12,7 +12,7 @@ Whether to use the EEL or Luau language. The script. Is disabled if the script contains more than one line. -See xref:further-concepts/source-concepts.adoc#midi-source-script[] for details. +See xref:further-concepts/source.adoc#midi-source-script[] for details. == More button (…) diff --git a/doc/realearn/modules/ROOT/pages/sources/midi/nrpn-value.adoc b/doc/realearn/modules/ROOT/pages/sources/midi/nrpn-value.adoc index 0f07a293b..026138a8b 100644 --- a/doc/realearn/modules/ROOT/pages/sources/midi/nrpn-value.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/midi/nrpn-value.adoc @@ -25,4 +25,4 @@ In practice, this if often checked. == Character menu -See xref:further-concepts/source-concepts.adoc#midi-source-character[]. \ No newline at end of file +See xref:further-concepts/source.adoc#midi-source-character[]. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/sources/midi/raw-midi-sysex.adoc b/doc/realearn/modules/ROOT/pages/sources/midi/raw-midi-sysex.adoc index 7b7249cb9..4114d6b51 100644 --- a/doc/realearn/modules/ROOT/pages/sources/midi/raw-midi-sysex.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/midi/raw-midi-sysex.adoc @@ -6,4 +6,4 @@ It supports both control and feedback direction! == Pattern field Pattern describing the raw MIDI message. -See xref:further-concepts/mapping-concepts.adoc#raw-midi-pattern[]. +See xref:further-concepts/mapping.adoc#raw-midi-pattern[]. diff --git a/doc/realearn/modules/ROOT/pages/sources/osc.adoc b/doc/realearn/modules/ROOT/pages/sources/osc.adoc index c3c30c6b5..757c45d6f 100644 --- a/doc/realearn/modules/ROOT/pages/sources/osc.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/osc.adoc @@ -63,4 +63,4 @@ When you enable this checkbox, ReaLearn will treat each received _1_ value as an [#feedback-arguments] == Feedback arguments field -Allows you to modify the xref:further-concepts/source-concepts.adoc#osc-feedback-arguments-expression[]. \ No newline at end of file +Allows you to modify the xref:further-concepts/source.adoc#osc-feedback-arguments-expression[]. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/sources/reaper/realearn-parameter.adoc b/doc/realearn/modules/ROOT/pages/sources/reaper/realearn-parameter.adoc index a9140651c..2b3b0fb3c 100644 --- a/doc/realearn/modules/ROOT/pages/sources/reaper/realearn-parameter.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/reaper/realearn-parameter.adoc @@ -1,6 +1,6 @@ = Source "ReaLearn parameter" -This source fires whenever a selected xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] changes its value. +This source fires whenever a selected xref:further-concepts/compartment.adoc#compartment-parameter[] changes its value. One of many ways to use this is to create macro parameters which control multiple parameters of multiple other plug-ins. diff --git a/doc/realearn/modules/ROOT/pages/sources/virtual.adoc b/doc/realearn/modules/ROOT/pages/sources/virtual.adoc index 1441b6c72..6d8fc2837 100644 --- a/doc/realearn/modules/ROOT/pages/sources/virtual.adoc +++ b/doc/realearn/modules/ROOT/pages/sources/virtual.adoc @@ -1,18 +1,18 @@ = Source "Virtual" -See xref:further-concepts/source-concepts.adoc#virtual-source[]. +See xref:further-concepts/source.adoc#virtual-source[]. == Type menu -See xref:further-concepts/compartment-concepts.adoc#virtual-control-element-type[]. +See xref:further-concepts/compartment.adoc#virtual-control-element-type[]. == ID section -See xref:further-concepts/compartment-concepts.adoc#virtual-control-element-id[]. +See xref:further-concepts/compartment.adoc#virtual-control-element-id[]. === Pick menu -The convenient picker provides IDs from standardized xref:further-concepts/compartment-concepts.adoc#virtual-control-scheme[virtual control schemes]: +The convenient picker provides IDs from standardized xref:further-concepts/compartment.adoc#virtual-control-scheme[virtual control schemes]: === ID field diff --git a/doc/realearn/modules/ROOT/pages/targets/fx-parameter/set-value.adoc b/doc/realearn/modules/ROOT/pages/targets/fx-parameter/set-value.adoc index e86dff795..37e7baf12 100644 --- a/doc/realearn/modules/ROOT/pages/targets/fx-parameter/set-value.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/fx-parameter/set-value.adoc @@ -6,13 +6,13 @@ Sets the value of a particular track FX parameter. The parameter to be controlled. -Please note that both xref:further-concepts/target-concepts.adoc#particular-fx-selector[] and xref:further-concepts/target-concepts.adoc#at-position-selector[] address the FX by its position in the FX chain. -The difference between the two is that xref:further-concepts/target-concepts.adoc#particular-selector[] shows a dropdown containing the available parameters and xref:further-concepts/target-concepts.adoc#at-position-selector[] lets you enter the position as a number in a text field. +Please note that both xref:further-concepts/target.adoc#particular-fx-selector[] and xref:further-concepts/target.adoc#at-position-selector[] address the FX by its position in the FX chain. +The difference between the two is that xref:further-concepts/target.adoc#particular-selector[] shows a dropdown containing the available parameters and xref:further-concepts/target.adoc#at-position-selector[] lets you enter the position as a number in a text field. Latter is useful if at the time of choosing the position, the FX is not available. == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/fx/browse-presets.adoc b/doc/realearn/modules/ROOT/pages/targets/fx/browse-presets.adoc index 4d9a9f15f..3eaa324ef 100644 --- a/doc/realearn/modules/ROOT/pages/targets/fx/browse-presets.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/fx/browse-presets.adoc @@ -2,7 +2,7 @@ Steps through FX presets. -This target is suited for use with xref:further-concepts/mapping-concepts.adoc#knob[knobs], xref:further-concepts/mapping-concepts.adoc#rotary-endless-encoder[encoders] and xref:user-interface/mapping-panel/glue-section.adoc#incremental-button[] because it allows you to step through the complete preset list. +This target is suited for use with xref:further-concepts/mapping.adoc#knob[knobs], xref:further-concepts/mapping.adoc#rotary-endless-encoder[encoders] and xref:user-interface/mapping-panel/glue-section.adoc#incremental-button[] because it allows you to step through the complete preset list. The minimum value always represents _No preset_ whereas the maximum value always represents the last available preset. It's _not_ suited for activating a particular preset (e.g. by setting xref:user-interface/mapping-panel/glue-section.adoc#target-min-max[] to the same value), because the preset list of an FX is usually not constant. diff --git a/doc/realearn/modules/ROOT/pages/targets/fx/fx.adoc b/doc/realearn/modules/ROOT/pages/targets/fx/fx.adoc index a67795016..1499688f8 100644 --- a/doc/realearn/modules/ROOT/pages/targets/fx/fx.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/fx/fx.adoc @@ -4,5 +4,5 @@ A target that allows you to define an FX, in its basic variant perfect for acqui == Act/Tags controls -The setting **Act/Tags** allows you to optionally set/pin the declared FX as xref:further-concepts/unit-concepts.adoc#unit-fx[]. +The setting **Act/Tags** allows you to optionally set/pin the declared FX as xref:further-concepts/unit.adoc#unit-fx[]. This works pretty much the same as described in xref:targets/track/track.adoc[]. diff --git a/doc/realearn/modules/ROOT/pages/targets/marker-region/go-to.adoc b/doc/realearn/modules/ROOT/pages/targets/marker-region/go-to.adoc index 936b7e51b..5a9ba41ef 100644 --- a/doc/realearn/modules/ROOT/pages/targets/marker-region/go-to.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/marker-region/go-to.adoc @@ -48,7 +48,7 @@ For regions, this will additionally set the time selection to the region start a == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/midi/send-message.adoc b/doc/realearn/modules/ROOT/pages/targets/midi/send-message.adoc index 89c450822..51bb09128 100644 --- a/doc/realearn/modules/ROOT/pages/targets/midi/send-message.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/midi/send-message.adoc @@ -26,7 +26,7 @@ A practical example is shown in link:https://www.youtube.com/watch?v=WJiwmlJSsi8 == Pattern field -Defines the MIDI message to be sent as xref:further-concepts/mapping-concepts.adoc#raw-midi-pattern[]. +Defines the MIDI message to be sent as xref:further-concepts/mapping.adoc#raw-midi-pattern[]. It allows you to encode the incoming _absolute_ control value as part of the message (after it has been processed by xref:key-concepts.adoc#glue[]). == Pre-defined patterns menu (...) diff --git a/doc/realearn/modules/ROOT/pages/targets/pot/browse-filter-items.adoc b/doc/realearn/modules/ROOT/pages/targets/pot/browse-filter-items.adoc index 7b8f6c100..43c7cbac7 100644 --- a/doc/realearn/modules/ROOT/pages/targets/pot/browse-filter-items.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/pot/browse-filter-items.adoc @@ -6,11 +6,11 @@ The idea is to map this target to an endless rotary encoder or previous/next but == Kind menu Choose the kind of filter items that you want to browse. -They correspond to the filters available in xref:further-concepts/instance-concepts.adoc#pot-browser[]. +They correspond to the filters available in xref:further-concepts/instance.adoc#pot-browser[]. == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/pot/browse-presets.adoc b/doc/realearn/modules/ROOT/pages/targets/pot/browse-presets.adoc index 6362d2717..251a06d6a 100644 --- a/doc/realearn/modules/ROOT/pages/targets/pot/browse-presets.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/pot/browse-presets.adoc @@ -9,7 +9,7 @@ Once you have selected a preset, you can audition it via xref:targets/pot/previe == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/pot/load-preset.adoc b/doc/realearn/modules/ROOT/pages/targets/pot/load-preset.adoc index 0c4e9679e..a1ceb95db 100644 --- a/doc/realearn/modules/ROOT/pages/targets/pot/load-preset.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/pot/load-preset.adoc @@ -8,11 +8,11 @@ NOTE: This needs at least REAPER version 6.69+dev1030! Also, it only works if yo == Track/FX controls You must tell the target at which FX slot to load the corresponding plug-in. -The best idea is to use FX selector xref:further-concepts/target-concepts.adoc#at-position-selector[]. -Selectors such as xref:further-concepts/target-concepts.adoc#particular-fx-selector[] or xref:further-concepts/target-concepts.adoc#named-fx-selector[] are not suited because the target might replace the plug-in with another one, in which the unique FX ID and the FX name can change. +The best idea is to use FX selector xref:further-concepts/target.adoc#at-position-selector[]. +Selectors such as xref:further-concepts/target.adoc#particular-fx-selector[] or xref:further-concepts/target.adoc#named-fx-selector[] are not suited because the target might replace the plug-in with another one, in which the unique FX ID and the FX name can change. Then the target would turn inactive and stop working. == Target-specific properties -This target supports the same additional xref:further-concepts/target-concepts.adoc#target-property[target properties] as xref:targets/pot/browse-presets.adoc[]. +This target supports the same additional xref:further-concepts/target.adoc#target-property[target properties] as xref:targets/pot/browse-presets.adoc[]. The only difference is that the ones in this one relate to the currently loaded preset, not the one that's selected in the preset browser. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/targets/project/seek.adoc b/doc/realearn/modules/ROOT/pages/targets/project/seek.adoc index 6c981c547..86cd34b3e 100644 --- a/doc/realearn/modules/ROOT/pages/targets/project/seek.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/project/seek.adoc @@ -53,7 +53,7 @@ Can use the complete project as reference, from start to end. == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/realearn/browse-group-mappings.adoc b/doc/realearn/modules/ROOT/pages/targets/realearn/browse-group-mappings.adoc index 33e1de538..07dbd53d9 100644 --- a/doc/realearn/modules/ROOT/pages/targets/realearn/browse-group-mappings.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/realearn/browse-group-mappings.adoc @@ -27,7 +27,7 @@ This target allows you to take advantage of that! - Combine it with xref:targets/realearn/enable-disable-mappings.adoc[] to browse different banks. - Combine it with xref:targets/realearn/enable-disable-instances.adoc[] to browse completely different controller setups (or banks). - Combine it with targets that don't provide a "Browse ..." variant themselves. -- Use it as an alternative to xref:further-concepts/glue-concepts.adoc#target-value-sequence[target value sequences] that allows you to have completely different targets within one sequence. +- Use it as an alternative to xref:further-concepts/glue.adoc#target-value-sequence[target value sequences] that allows you to have completely different targets within one sequence. ==== [split=0] \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-instances.adoc b/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-instances.adoc index 9d825927f..c0225e394 100644 --- a/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-instances.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-instances.adoc @@ -14,7 +14,7 @@ Exclusive (on only):: Variation of _Exclusive_ that applies exclusivity only if == Tags field -A ReaLearn instance matches when at least one of its units is tagged with any of the xref:further-concepts/unit-concepts.adoc#unit-tag[unit tags] entered into this field (comma-separated). +A ReaLearn instance matches when at least one of its units is tagged with any of the xref:further-concepts/unit.adoc#unit-tag[unit tags] entered into this field (comma-separated). == Remarks @@ -26,7 +26,7 @@ If _this_ ReaLearn instance is on the monitoring FX chain, it only affects other TIP: This target is great for switching between completely different controller setups! -CAUTION: You enter xref:further-concepts/unit-concepts.adoc#unit-tag[unit tags] here, but it will enable/disable whole xref:key-concepts.adoc#instance[instances]! +CAUTION: You enter xref:further-concepts/unit.adoc#unit-tag[unit tags] here, but it will enable/disable whole xref:key-concepts.adoc#instance[instances]! I know, this is counter-intuitive. In some cases, it would be good to have a way to enable/disable units. However, that doesn't exist yet. diff --git a/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-mappings.adoc b/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-mappings.adoc index d3d5fd343..234e3866c 100644 --- a/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-mappings.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/realearn/enable-disable-mappings.adoc @@ -14,11 +14,11 @@ Exclusive (on only):: Variation of _Exclusive_ that applies exclusivity only if == Tags field -A mapping matches when it is tagged with any of the xref:further-concepts/mapping-concepts.adoc#mapping-tag[mapping tags] entered into this field (comma-separated). +A mapping matches when it is tagged with any of the xref:further-concepts/mapping.adoc#mapping-tag[mapping tags] entered into this field (comma-separated). == Remarks * This affects other mappings only, not _this_ mapping. * Mappings without tags won't be affected at all. -TIP: This target is a straightforward alternative to xref:further-concepts/mapping-concepts.adoc#conditional-activation[] when it comes to bank switching! +TIP: This target is a straightforward alternative to xref:further-concepts/mapping.adoc#conditional-activation[] when it comes to bank switching! diff --git a/doc/realearn/modules/ROOT/pages/targets/track/set-pan.adoc b/doc/realearn/modules/ROOT/pages/targets/track/set-pan.adoc index 747b63158..029e6ced7 100644 --- a/doc/realearn/modules/ROOT/pages/targets/track/set-pan.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/track/set-pan.adoc @@ -4,7 +4,7 @@ Sets the track's pan value. == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/track/set-stereo-pan-width.adoc b/doc/realearn/modules/ROOT/pages/targets/track/set-stereo-pan-width.adoc index 0e731faea..542ff98a0 100644 --- a/doc/realearn/modules/ROOT/pages/targets/track/set-stereo-pan-width.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/track/set-stereo-pan-width.adoc @@ -4,7 +4,7 @@ Sets the track's width value (applicable if the track is in stereo pan mode). == Target-specific properties -This target supports the following additional xref:further-concepts/target-concepts.adoc#target-property[target properties]. +This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties]. [cols="m,1,3"] |=== diff --git a/doc/realearn/modules/ROOT/pages/targets/track/track.adoc b/doc/realearn/modules/ROOT/pages/targets/track/track.adoc index b96b09d90..66d03b89b 100644 --- a/doc/realearn/modules/ROOT/pages/targets/track/track.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/track/track.adoc @@ -11,14 +11,14 @@ A target that allows you to define a track. None (feedback only):: With this setting, nothing will happen. It's suited very well as neutral target for textual feedback with an expression that contains a track property, e.g. `{{ target.track.name }}`. -Set (as unit track):: The button press will set the track defined in this target as xref:further-concepts/unit-concepts.adoc#unit-track[] _without resolving it before_. -For example, if this target defines to use the currently selected track (xref:further-concepts/target-concepts.adoc#selected-selector[]), pressing the button will make the unit track dynamically reflect whatever track is selected. +Set (as unit track):: The button press will set the track defined in this target as xref:further-concepts/unit.adoc#unit-track[] _without resolving it before_. +For example, if this target defines to use the currently selected track (xref:further-concepts/target.adoc#selected-selector[]), pressing the button will make the unit track dynamically reflect whatever track is selected. -Pin (as unit track):: The button press will resolve the track defined in this target and set the result as xref:further-concepts/unit-concepts.adoc#unit-track[]. +Pin (as unit track):: The button press will resolve the track defined in this target and set the result as xref:further-concepts/unit.adoc#unit-track[]. For example, if this target defines to use the currently selected track, pressing the button will check which track is currently selected and set the unit track to exactly this track. It will stay that way even if the user selects another track. === Unit tags field -The text field lets you define xref:further-concepts/unit-concepts.adoc#unit-tag[unit tags] to determine for which xref:key-concepts.adoc#unit[units] the xref:further-concepts/unit-concepts.adoc#unit-track[] should be changed. +The text field lets you define xref:further-concepts/unit.adoc#unit-tag[unit tags] to determine for which xref:key-concepts.adoc#unit[units] the xref:further-concepts/unit.adoc#unit-track[] should be changed. If it's empty, the current unit will be affected. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/targets/virtual.adoc b/doc/realearn/modules/ROOT/pages/targets/virtual.adoc index cecd801f7..01377ea95 100644 --- a/doc/realearn/modules/ROOT/pages/targets/virtual.adoc +++ b/doc/realearn/modules/ROOT/pages/targets/virtual.adoc @@ -1,7 +1,7 @@ = Target "Virtual" -This is exactly the counterpart of the possible xref:further-concepts/source-concepts.adoc#virtual-source[virtual sources] in the xref:key-concepts.adoc#main-compartment[]. -Choosing a xref:further-concepts/target-concepts.adoc#virtual-target[] here is like placing cables between a xref:further-concepts/compartment-concepts.adoc#real-control-element[] and all corresponding main mappings that use this xref:further-concepts/compartment-concepts.adoc#virtual-control-element[] as source. +This is exactly the counterpart of the possible xref:further-concepts/source.adoc#virtual-source[virtual sources] in the xref:key-concepts.adoc#main-compartment[]. +Choosing a xref:further-concepts/target.adoc#virtual-target[] here is like placing cables between a xref:further-concepts/compartment.adoc#real-control-element[] and all corresponding main mappings that use this xref:further-concepts/compartment.adoc#virtual-control-element[] as source. == Learnable checkbox diff --git a/doc/realearn/modules/ROOT/pages/user-interface.adoc b/doc/realearn/modules/ROOT/pages/user-interface.adoc index 3ff481034..4d598187c 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface.adoc @@ -14,4 +14,4 @@ Most of the information in this section focuses on the instrument plug-in. Helgobox App:: This interface is accessible via menu:Menu[Show app] in the plug-in. In the future, the app will also be available for mobile devices and offer remote connections to REAPER. -Currently, the app only provides the interface for Playtime with one exception: ReaLearn's xref:further-concepts/unit-concepts.adoc#projection[] feature. \ No newline at end of file +Currently, the app only provides the interface for Playtime with one exception: ReaLearn's xref:further-concepts/unit.adoc#projection[] feature. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/bottom-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/bottom-section.adoc index 83c9eb332..c72e628b5 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/bottom-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/bottom-section.adoc @@ -1,4 +1,3 @@ - = Bottom section image:realearn/screenshots/main-panel-bottom.png[Screenshot] @@ -20,12 +19,12 @@ In the center you can see the info area, made up of 3 rows: Row 1:: * The current scroll position. -* The xref:further-concepts/instance-concepts.adoc#instance-id[] of this Helgobox xref:key-concepts.adoc#instance[]. -* The xref:further-concepts/unit-concepts.adoc#unit-key[] of the currently visible ReaLearn xref:key-concepts.adoc#unit[]. -* xref:further-concepts/unit-concepts.adoc#unit-tag[] assigned to this ReaLearn xref:key-concepts.adoc#unit[]. +* The xref:further-concepts/instance.adoc#instance-id[] of this Helgobox xref:key-concepts.adoc#instance[]. +* The xref:further-concepts/unit.adoc#unit-key[] of the currently visible ReaLearn xref:key-concepts.adoc#unit[]. +* xref:further-concepts/unit.adoc#unit-tag[] assigned to this ReaLearn xref:key-concepts.adoc#unit[]. Row 2:: -* Information about the current xref:further-concepts/unit-concepts.adoc#unit-track[] and xref:further-concepts/unit-concepts.adoc#unit-fx[]. +* Information about the current xref:further-concepts/unit.adoc#unit-track[] and xref:further-concepts/unit.adoc#unit-fx[]. * Information whether control and/or feedback is currently inactive unit-wide. Row 3:: @@ -36,6 +35,6 @@ Row 3:: Press this button to change various key-value data of this ReaLearn unit as a whole. -Unit key…:: Allows you to change the xref:further-concepts/unit-concepts.adoc#unit-key[] of this xref:key-concepts.adoc#unit[]. +Unit key…:: Allows you to change the xref:further-concepts/unit.adoc#unit-key[] of this xref:key-concepts.adoc#unit[]. Unit name:: The display name of this xref:key-concepts.adoc#unit[]. -Tags:: Lets you assign xref:further-concepts/unit-concepts.adoc#unit-tag[] to this xref:key-concepts.adoc#unit[] as a comma-separated list. +Tags:: Lets you assign xref:further-concepts/unit.adoc#unit-tag[] to this xref:key-concepts.adoc#unit[] as a comma-separated list. diff --git a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/input-output-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/input-output-section.adoc index c816b2561..910d1dbf0 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/input-output-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/input-output-section.adoc @@ -111,7 +111,7 @@ When targeting an OSC software that runs on the same computer as REAPER and ReaL + When you configure your OSC connection on the device side, you must provide a _host_ as well. There you should enter the IP address of the computer which runs REAPER and ReaLearn. -You can easily find it by pressing the xref:further-concepts/unit-concepts.adoc#projection[] button in ReaLearn, choosing the old browser-based projection and scrolling down a bit. +You can easily find it by pressing the xref:further-concepts/unit.adoc#projection[] button in ReaLearn, choosing the old browser-based projection and scrolling down a bit. It's the value next to *Host* and should start with `192.168.`. Device port:: Required for feedback only. diff --git a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/let-through-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/let-through-section.adoc index 059f361f2..a3318f6d2 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/let-through-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/let-through-section.adoc @@ -2,7 +2,7 @@ image:realearn/screenshots/main-panel-let-through-checkboxes.png[Screenshot] -See xref:further-concepts/unit-concepts.adoc#letting-through-events[]. +See xref:further-concepts/unit.adoc#letting-through-events[]. Matched:: If checked, even events matched by at least one mapping are let through. If unchecked (default), such events are filtered out. diff --git a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/mapping-group-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/mapping-group-section.adoc index 076bfa63b..2e068868a 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/mapping-group-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/mapping-group-section.adoc @@ -5,7 +5,7 @@ image:realearn/screenshots/main-panel-group.png[Screenshot] [[mapping-group]] == Group menu -See xref:further-concepts/mapping-concepts.adoc#group[]. +See xref:further-concepts/mapping.adoc#group[]. The group menu contains the following options: @@ -31,6 +31,6 @@ Alternatively they will automatically be moved to the default group. == Edit button -Opens the group panel, which allows you to change xref:further-concepts/target-concepts.adoc#group-properties[]. +Opens the group panel, which allows you to change xref:further-concepts/target.adoc#group-properties[]. image:realearn/screenshots/group-panel.png[Group panel] \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/menu-bar.adoc b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/menu-bar.adoc index 1c70f2351..478cb19f7 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/menu-bar.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/menu-bar.adoc @@ -31,7 +31,7 @@ This is useful if you already learned a bunch of MIDI/OSC/keyboard sources in th Make targets of listed mappings sticky::: Changes the targets of all currently listed mappings so that they use _sticky_ object selectors by attempting to resolve the objects from non-sticky selectors. -See xref:further-concepts/target-concepts.adoc#sticky-selectors[]. +See xref:further-concepts/target.adoc#sticky-selectors[]. Make targets of listed mappings non-sticky::: Changes the targets of all currently listed mappings so that they use the desired non-sticky object selectors. @@ -68,7 +68,7 @@ Don't use this, this feature is not ready yet! [[compartment-parameters,Compartment parameters menu]] Compartment parameters:: This shows all parameters of the current compartment and makes it possible to customize them. -See xref:further-concepts/compartment-concepts.adoc#compartment-parameter[] to learn what such parameters are good for. +See xref:further-concepts/compartment.adoc#compartment-parameter[] to learn what such parameters are good for. + Each parameter provides the following customization options: @@ -78,17 +78,17 @@ Changes the name of this parameter. [[set-compartment-parameter-value-count]]Value count::: Lets you enter the maximum number of values. This automatically turn this parameter into a discrete parameter. -See xref:further-concepts/compartment-concepts.adoc#continuous-vs-discrete-compartment-parameters[]. +See xref:further-concepts/compartment.adoc#continuous-vs-discrete-compartment-parameters[]. Compartment presets:: Create compartment preset workspace::: Exports the Luau SDK files of this ReaLearn version into a new compartment preset workspace directory with a random name. -See section xref:further-concepts/compartment-concepts.adoc#writing-presets-with-luau[] for details. +See section xref:further-concepts/compartment.adoc#writing-presets-with-luau[] for details. Create compartment preset workspace (including factory presets)::: Exports the Luau SDK files of this ReaLearn version and all factory presets for this compartment into a new compartment preset workspace directory with a random name. -See section xref:further-concepts/compartment-concepts.adoc#writing-presets-with-luau[] for details. +See section xref:further-concepts/compartment.adoc#writing-presets-with-luau[] for details. Open compartment preset folder::: Opens the ReaLearn preset folder for this compartment in a file manager. @@ -101,7 +101,7 @@ If you want to apply a preset that has been changed on disk, you need to reload Edit compartment-wide Lua code::: Allows you to edit the compartment-wide Lua code. -See section xref:further-concepts/compartment-concepts.adoc#compartment-wide-lua-code[]. +See section xref:further-concepts/compartment.adoc#compartment-wide-lua-code[]. [[unit-options]] Unit options:: @@ -131,7 +131,7 @@ This can be useful e.g. when using REAPER/ReaLearn just in feedback direction, i [[make-unit-superior]] Make unit superior::: Makes this unit superior. -See xref:further-concepts/unit-concepts.adoc#superior-units[] to learn more about this feature. +See xref:further-concepts/unit.adoc#superior-units[] to learn more about this feature. Use unit-wide FX-to-preset links only::: By default, unit-wide links are applied _in addition_ to the global links and take precedence over the global ones. @@ -177,12 +177,12 @@ You can change the linked preset by clicking another one. Log debug info (now)::: Logs some information about ReaLearn's internal state. Can be interesting for investigating bugs or understanding how this plug-in works. Log real control messages::: When enabled, all incoming MIDI messages, OSC messages or key pressed will be logged to the console. -See xref:further-concepts/unit-concepts.adoc#logging-of-real-control-messages[]. +See xref:further-concepts/unit.adoc#logging-of-real-control-messages[]. Log virtual control messages::: When enabled, all triggered virtual control elements and their values will be logged (see xref:key-concepts.adoc#controller-compartment[]). Log target control::: When enabled, all target invocations (parameter changes etc.) will be logged. Log virtual feedback messages::: When enabled, all feedback events to virtual control elements will be logged (see xref:key-concepts.adoc#controller-compartment[]). Log real feedback messages::: When enabled, all outgoing MIDI or OSC messages will be logged to the console. -See xref:further-concepts/unit-concepts.adoc#logging-of-real-feedback-messages[]. +See xref:further-concepts/unit.adoc#logging-of-real-feedback-messages[]. Send feedback now:: Usually ReaLearn sends feedback whenever something changed to keep the LEDs or motorized faders of your controller in sync with REAPER at all times. @@ -193,11 +193,11 @@ Instance options:: [[enable-global-control]] Enable global control::: If you enable this option, this Helgobox instance will start to automatically add/remove units based on connected controllers. -See xref:further-concepts/instance-concepts.adoc#auto-units[]. +See xref:further-concepts/instance.adoc#auto-units[]. [[open-pot-browser]] Open Pot Browser:: This will open Pot Browser. -See xref:further-concepts/instance-concepts.adoc#pot-browser[] for details. +See xref:further-concepts/instance.adoc#pot-browser[] for details. Show App:: Shows the Helgobox App associated with this Helgobox instance. @@ -219,7 +219,7 @@ Disable and stop!::: This stops the server and makes sure it will not be started Add firewall rule::: Attempts to add a firewall rule for making the server accessible from other devices or displays instructions how to do it. [[global-fx-to-preset-links]] Global FX-to-preset links:: -Allows you to manage xref:further-concepts/unit-concepts.adoc#global-fx-to-preset-link[global FX-to-preset links]. +Allows you to manage xref:further-concepts/unit.adoc#global-fx-to-preset-link[global FX-to-preset links]. Works exactly as the <> menu. [[fx-id-dialog]] @@ -255,7 +255,7 @@ Instead of relying on the original plug-in name you could match plug-ins with si == Export to clipboard button Pressing the export button allows you to copy ReaLearn's settings to the clipboard so you can import them in another instance/unit or edit them in a text editor. -See xref:further-concepts/general-concepts.adoc#import-export[]. +See xref:further-concepts/general.adoc#import-export[]. Export instance as JSON:: Copies a _complete_ dump of this xref:key-concepts.adoc#instance[] to the clipboard in JSON format. @@ -278,12 +278,12 @@ This gives you the perfect starting point if you want to extensively modify the Pressing the import button does the opposite: It restores whatever ReaLearn dump is currently in the clipboard. It supports JSON or Luau. -See xref:further-concepts/general-concepts.adoc#import-export[]. +See xref:further-concepts/general.adoc#import-export[]. [#projection] == Projection button -Click this button to enter ReaLearn's xref:further-concepts/unit-concepts.adoc#projection[] feature. +Click this button to enter ReaLearn's xref:further-concepts/unit.adoc#projection[] feature. You can choose between the old browser-based projection (which is going to disappear soon) and the new projection that is part of the Helgobox App (but not yet fully functional). Hopefully, the transition to the Helgobox App, including mobile versions of that App, will soon be finished. diff --git a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/preset-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/preset-section.adoc index 55b299d1d..4cafd9ff9 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/main-panel/preset-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/main-panel/preset-section.adoc @@ -1,4 +1,3 @@ - = Preset section image:realearn/screenshots/main-panel-preset.png[Screenshot] @@ -16,15 +15,15 @@ It means that no particular preset is active. + Selecting this will always clear the complete compartment, including all mappings! -Factory:: Contains available xref:further-concepts/compartment-concepts.adoc#factory-compartment-preset[factory presets]. +Factory:: Contains available xref:further-concepts/compartment.adoc#factory-compartment-preset[factory presets]. -User (...):: Contains available xref:further-concepts/compartment-concepts.adoc#user-compartment-preset[user presets]. +User (...):: Contains available xref:further-concepts/compartment.adoc#user-compartment-preset[user presets]. Multiple of such submenus may exist. Each one represents a different preset namespace/workspace. The namespace named after you (macOS/Linux/Windows username) is your personal user namespace. + For more information about preset workspaces/namespaces, see -xref:further-concepts/compartment-concepts.adoc#writing-presets-with-luau[]. +xref:further-concepts/compartment.adoc#writing-presets-with-luau[]. User (Unsorted):: This submenu contains top-level presets which are not part of a particular preset namespace/workspace. @@ -45,10 +44,10 @@ This permanently deletes the currently chosen user preset. == Auto-load button -Activates or deactivates xref:further-concepts/unit-concepts.adoc#auto-load[] mode for this ReaLearn unit. -This button is only available for the xref:key-concepts.adoc#main-compartment[] because auto-load is only about loading xref:further-concepts/compartment-concepts.adoc#main-preset[main presets]. +Activates or deactivates xref:further-concepts/unit.adoc#auto-load[] mode for this ReaLearn unit. +This button is only available for the xref:key-concepts.adoc#main-compartment[] because auto-load is only about loading xref:further-concepts/compartment.adoc#main-preset[main presets]. Off:: Disables auto-load mode (the default). [[auto-load-based-on-unit-fx,Auto-load based on unit FX]] Based on unit FX:: -Switches auto-load mode on, letting ReaLearn decide about which main preset to load depending on the currently active xref:further-concepts/unit-concepts.adoc#unit-fx[]. \ No newline at end of file +Switches auto-load mode on, letting ReaLearn decide about which main preset to load depending on the currently active xref:further-concepts/unit.adoc#unit-fx[]. \ No newline at end of file diff --git a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/advanced-settings-dialog.adoc b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/advanced-settings-dialog.adoc index f7f2622e8..75b4489d0 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/advanced-settings-dialog.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/advanced-settings-dialog.adoc @@ -45,7 +45,7 @@ Comments (lines starting with `#`) will be removed automatically. === Mapping lifecycle actions ReaLearn allows you to define MIDI messages to be sent to the output whenever a mapping turns active or inactive. -See xref:further-concepts/mapping-concepts.adoc#mapping-activation-state[]. +See xref:further-concepts/mapping.adoc#mapping-activation-state[]. Example use cases: diff --git a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/glue-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/glue-section.adoc index 00abda13e..d18cb8b42 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/glue-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/glue-section.adoc @@ -78,7 +78,7 @@ If you set this to "-6 dB to 0 dB" for a _Track volume_ target, the volume will However, it wouldn't prevent the volume from exceeding that range if changed e.g. in REAPER itself. ==== -This setting can be used with all targets that work with xref:further-concepts/mapping-concepts.adoc#absolute-control-value[absolute control values] (all targets except xref:targets/project/invoke-reaper-action.adoc[] with relative xref:targets/project/invoke-reaper-action.adoc#invocation-type[]). +This setting can be used with all targets that work with xref:further-concepts/mapping.adoc#absolute-control-value[absolute control values] (all targets except xref:targets/project/invoke-reaper-action.adoc[] with relative xref:targets/project/invoke-reaper-action.adoc#invocation-type[]). [#value-sequence] == Value sequence field @@ -86,7 +86,7 @@ This setting can be used with all targets that work with xref:further-concepts/m {control}:: include::partial$glue/value-sequence/control.txt[] -Allows you to define a xref:further-concepts/glue-concepts.adoc#target-value-sequence[]. +Allows you to define a xref:further-concepts/glue.adoc#target-value-sequence[]. All values are entered comma-separated using the target unit specified with the xref:user-interface/mapping-panel/target-section.adoc#display-unit[]. You can provide only one of <> or <>. @@ -97,7 +97,7 @@ You can provide only one of <> or <>. {control}:: include::partial$glue/group-interaction/control.txt[] -See xref:further-concepts/mapping-concepts.adoc#group[]. +See xref:further-concepts/mapping.adoc#group[]. TIP: If you want to control _other_ mappings only and not _this_ mapping, just pick a target that doesn't have any effect, for example the xref:targets/realearn/dummy.adoc[]. @@ -142,7 +142,7 @@ Variation of <> that applies the inverse only when the tar {feedback}:: include::partial$glue/feedback-type/feedback.txt[] -See xref:further-concepts/glue-concepts.adoc#feedback-type[]. +See xref:further-concepts/glue.adoc#feedback-type[]. [#feedback-style] == Feedback style menu (...) @@ -150,7 +150,7 @@ See xref:further-concepts/glue-concepts.adoc#feedback-type[]. The ... button provides options to change the _feedback style_. At the moment, it's all about setting colors. -TIP: If you use xref:further-concepts/glue-concepts.adoc#dynamic-feedback[], changes made here don't have any effect because you are supposed to provide style properties as part of the Luau script result (which is much more flexible). +TIP: If you use xref:further-concepts/glue.adoc#dynamic-feedback[], changes made here don't have any effect because you are supposed to provide style properties as part of the Luau script result (which is much more flexible). Color / Background color:: With this you can define the color and background color of the displayed text. @@ -175,7 +175,7 @@ include::partial$glue/source-min-max/control.txt[] {feedback}:: include::partial$glue/source-min-max/feedback.txt[] -Doesn't have an effect on xref:further-concepts/mapping-concepts.adoc#relative-control-value[relative control values]. +Doesn't have an effect on xref:further-concepts/mapping.adoc#relative-control-value[relative control values]. include::partial$glue/usage-dependent-effect.adoc[] @@ -290,7 +290,7 @@ It somewhat resembles takeover mode <> but has important - It's guaranteed that a full fader/knob swipe from 0% to 100% always results in a swipe over the full target range (assuming the target was at 0% initially). - It doesn't need to know the current target value. -Which means it also works for mappings with xref:further-concepts/target-concepts.adoc#virtual-target[virtual targets]. +Which means it also works for mappings with xref:further-concepts/target.adoc#virtual-target[virtual targets]. [[performance-control]] Performance control:: This mode emulates the behavior of a typical soft synth modulation matrix mapping: It uses the target value that has been set in REAPER (not via this ReaLearn mapping) as an offset and starts changing it from there. @@ -474,7 +474,7 @@ include::partial$glue/usage-dependent-effect.adoc[] {control}:: include::partial$glue/speed-min-max/control.txt[] -When you choose a target with a xref:further-concepts/target-concepts.adoc#discrete-value-range[], the <> label will change into +When you choose a target with a xref:further-concepts/target.adoc#discrete-value-range[], the <> label will change into _Speed_. If a target is discrete, it cannot have arbitrarily small step sizes. It rather has one predefined atomic step size. diff --git a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/target-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/target-section.adoc index 9c01585b6..9c25f872e 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/target-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/target-section.adoc @@ -68,7 +68,7 @@ When choosing a track, the following additional elements are available. === Track must be selected checkbox If checked, this mapping will be active only if the track set in _Track_ is currently selected. -See xref:further-concepts/target-concepts.adoc#target-activation-condition[]. +See xref:further-concepts/target.adoc#target-activation-condition[]. === Selection ganging checkbox @@ -108,14 +108,14 @@ Only available for targets that work on a send/receive. The kind of send/receive that you want to control. Send:: Send from the track above to another track of your choice. -If you choose xref:further-concepts/target-concepts.adoc#particular-selector[], ReaLearn will memorize the ID of the destination track. +If you choose xref:further-concepts/target.adoc#particular-selector[], ReaLearn will memorize the ID of the destination track. That way you will still control the correct send even if you delete another send in that track. Receive:: Receive from another track of your choice to the track above (opposite direction of send). -If you choose the xref:further-concepts/target-concepts.adoc#particular-selector[] selector, ReaLearn will memorize the ID of the source track. +If you choose the xref:further-concepts/target.adoc#particular-selector[] selector, ReaLearn will memorize the ID of the source track. Output:: Send from the track above to a hardware output. -Please note that with hardware outputs, xref:further-concepts/target-concepts.adoc#particular-selector[] is the same as xref:further-concepts/target-concepts.adoc#at-position-selector[] because hardware outputs don't have unique IDs. +Please note that with hardware outputs, xref:further-concepts/target.adoc#particular-selector[] is the same as xref:further-concepts/target.adoc#at-position-selector[] because hardware outputs don't have unique IDs. === Send/Receive/Output section @@ -150,7 +150,7 @@ If checked, this mapping will be active only if the selected FX instance is curr If the FX instance is displayed in a floating window, _focused_ means that the floating window is active. If it's displayed within the FX chain window, _focused_ means that the FX chain window is currently open and the FX instance is the currently selected FX in that FX chain. -Of course, this flag doesn't have any effect if you chose the xref:further-concepts/target-concepts.adoc#fx-focused-selector[]. +Of course, this flag doesn't have any effect if you chose the xref:further-concepts/target.adoc#fx-focused-selector[]. == Common elements for pollable targets @@ -158,5 +158,5 @@ The following elements are available only for the few targets that might need po === Poll for feedback checkbox -Enables or disables xref:further-concepts/target-concepts.adoc#target-value-polling[]. +Enables or disables xref:further-concepts/target.adoc#target-value-polling[]. In the probably rare case that the polling causes performance issues, you can untick this checkbox. diff --git a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/top-section.adoc b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/top-section.adoc index 07ab05802..df4dd1fa5 100644 --- a/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/top-section.adoc +++ b/doc/realearn/modules/ROOT/pages/user-interface/mapping-panel/top-section.adoc @@ -15,7 +15,7 @@ If you clear the name, ReaLearn will name the mapping automatically based on its [#tags] == Tags field -Use this to assign arbitrary xref:further-concepts/mapping-concepts.adoc#mapping-tag[mapping tags] to this mapping (comma-separated). +Use this to assign arbitrary xref:further-concepts/mapping.adoc#mapping-tag[mapping tags] to this mapping (comma-separated). [#control-enabled] == Control-enabled checkbox (→) @@ -32,7 +32,7 @@ Disabling both control and feedback has the same effect as disabling the mapping [#active] == Active menu -This dropdown can be used to enable xref:further-concepts/mapping-concepts.adoc#conditional-activation[] for this mapping. +This dropdown can be used to enable xref:further-concepts/mapping.adoc#conditional-activation[] for this mapping. [#feedback-mode] == Feedback menu @@ -63,7 +63,7 @@ By choosing this option, ReaLearn will send feedback whenever the target value c [#show-in-projection] == Show in projection checkbox -When unticked, this mapping will not show up in xref:further-concepts/unit-concepts.adoc#projection[]. +When unticked, this mapping will not show up in xref:further-concepts/unit.adoc#projection[]. Useful e.g. for feedback-only mappings or buttons with multiple assignments. [[advanced-settings]]