documentation links complete

ossia · Aug 22, 2024 · 5f6a40f · 5f6a40f
1 parent f04b5b3
commit 5f6a40f
Show file tree

Hide file tree

Showing 43 changed files with 58 additions and 2 deletions.
diff --git a/src/plugins/score-plugin-analysis/Analysis/Centroid.hpp b/src/plugins/score-plugin-analysis/Analysis/Centroid.hpp
@@ -14,6 +14,7 @@ struct Centroid
     static const constexpr auto objectKey = "Centroid";
     static const constexpr auto category = "Analysis/Spectrum";
     static const constexpr auto author = "ossia score, Gist library";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectral-parameters";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the centroid of a signal";
     static const constexpr auto tags = std::array<const char*, 0>{};

diff --git a/src/plugins/score-plugin-analysis/Analysis/ComplexSpectralDifference.hpp b/src/plugins/score-plugin-analysis/Analysis/ComplexSpectralDifference.hpp
@@ -13,6 +13,7 @@ struct CSD
     static const constexpr auto prettyName = "Complex Spectral Difference";
     static const constexpr auto objectKey = "CSD";
     static const constexpr auto category = "Analysis/Onsets";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#onset-detection";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description

diff --git a/src/plugins/score-plugin-analysis/Analysis/Crest.hpp b/src/plugins/score-plugin-analysis/Analysis/Crest.hpp
@@ -13,6 +13,7 @@ struct Crest
     static const constexpr auto prettyName = "Spectral Crest";
     static const constexpr auto objectKey = "Crest";
     static const constexpr auto category = "Analysis/Spectrum";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectral-parameters";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the spectral crest of a signal";

diff --git a/src/plugins/score-plugin-analysis/Analysis/EnergyDifference.hpp b/src/plugins/score-plugin-analysis/Analysis/EnergyDifference.hpp
@@ -13,6 +13,7 @@ struct EnergyDifference
     static const constexpr auto prettyName = "Energy Difference";
     static const constexpr auto objectKey = "EnergyDifference";
     static const constexpr auto category = "Analysis/Onsets";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#onset-detection";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description

diff --git a/src/plugins/score-plugin-analysis/Analysis/Envelope.hpp b/src/plugins/score-plugin-analysis/Analysis/Envelope.hpp
@@ -13,6 +13,7 @@ struct RMS
     static const constexpr auto prettyName = "RMS";
     static const constexpr auto objectKey = "RMS";
     static const constexpr auto category = "Analysis/Envelope";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#envelope";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the RMS of a signal";
@@ -45,6 +46,7 @@ struct Peak
     static const constexpr auto prettyName = "Peak";
     static const constexpr auto objectKey = "Peak";
     static const constexpr auto category = "Analysis/Envelope";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#envelope";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the peak energy of a signal";

diff --git a/src/plugins/score-plugin-analysis/Analysis/Flatness.hpp b/src/plugins/score-plugin-analysis/Analysis/Flatness.hpp
@@ -13,6 +13,7 @@ struct Flatness
     static const constexpr auto prettyName = "Spectral flatness";
     static const constexpr auto objectKey = "Flatness";
     static const constexpr auto category = "Analysis/Spectrum";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectral-parameters";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the spectral flatness of a signal";

diff --git a/src/plugins/score-plugin-analysis/Analysis/HighFrequencyContent.hpp b/src/plugins/score-plugin-analysis/Analysis/HighFrequencyContent.hpp
@@ -13,6 +13,7 @@ struct Hfq
     static const constexpr auto prettyName = "High-Frequency Content";
     static const constexpr auto objectKey = "Hfq";
     static const constexpr auto category = "Analysis/Onsets";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#onset-detection";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description

diff --git a/src/plugins/score-plugin-analysis/Analysis/Kurtosis.hpp b/src/plugins/score-plugin-analysis/Analysis/Kurtosis.hpp
@@ -14,6 +14,7 @@ struct Kurtosis
     static const constexpr auto objectKey = "Kurtosis";
     static const constexpr auto category = "Analysis/Spectrum";
     static const constexpr auto author = "ossia score, Gist library";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectral-parameters";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the kurtosis of a signal";
     static const constexpr auto tags = std::array<const char*, 0>{};

diff --git a/src/plugins/score-plugin-analysis/Analysis/MFCC.hpp b/src/plugins/score-plugin-analysis/Analysis/MFCC.hpp
@@ -13,6 +13,7 @@ struct Spectrum
     static const constexpr auto prettyName = "Spectrum";
     static const constexpr auto objectKey = "Mel";
     static const constexpr auto category = "Analysis/Spectrum";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectrum-extraction";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the magnitude spectrum of a signal";
@@ -45,6 +46,7 @@ struct MelSpectrum
     static const constexpr auto prettyName = "Mel spectrum";
     static const constexpr auto objectKey = "Mel";
     static const constexpr auto category = "Analysis/Spectrum";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectrum-extraction";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description
@@ -79,6 +81,7 @@ struct MFCC
     static const constexpr auto objectKey = "MFCC";
     static const constexpr auto category = "Analysis/Spectrum";
     static const constexpr auto author = "ossia score, Gist library";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectrum-extraction";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description
         = "Get the mel-frequency cepstral coefficients of a signal";

diff --git a/src/plugins/score-plugin-analysis/Analysis/Pitch.hpp b/src/plugins/score-plugin-analysis/Analysis/Pitch.hpp
@@ -21,6 +21,7 @@ struct Pitch
     static const constexpr auto objectKey = "Pitch";
     static const constexpr auto category = "Analysis/Pitch";
     static const constexpr auto author = "ossia score, Gist library";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#pitch-detection";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the pitch of a signal";
     static const constexpr auto tags = std::array<const char*, 0>{};

diff --git a/src/plugins/score-plugin-analysis/Analysis/Rolloff.hpp b/src/plugins/score-plugin-analysis/Analysis/Rolloff.hpp
@@ -14,6 +14,7 @@ struct Rolloff
     static const constexpr auto objectKey = "Rolloff";
     static const constexpr auto category = "Analysis/Spectrum";
     static const constexpr auto author = "ossia score, Gist library";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#spectral-parameters";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the spectral rolloff of a signal";
     static const constexpr auto tags = std::array<const char*, 0>{};

diff --git a/src/plugins/score-plugin-analysis/Analysis/SpectralDifference.hpp b/src/plugins/score-plugin-analysis/Analysis/SpectralDifference.hpp
@@ -13,6 +13,7 @@ struct SpectralDiff
     static const constexpr auto prettyName = "Spectral Difference";
     static const constexpr auto objectKey = "SpectralDiff";
     static const constexpr auto category = "Analysis/Onsets";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#onset-detection";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the spectral difference of a signal";

diff --git a/src/plugins/score-plugin-analysis/Analysis/SpectralDifference_HWR.hpp b/src/plugins/score-plugin-analysis/Analysis/SpectralDifference_HWR.hpp
@@ -13,6 +13,7 @@ struct SpectralDiffHWR
     static const constexpr auto prettyName = "Spectral Difference (HWR)";
     static const constexpr auto objectKey = "SpectralDiffHWR";
     static const constexpr auto category = "Analysis/Onsets";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#onset-detection";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description

diff --git a/src/plugins/score-plugin-analysis/Analysis/ZeroCrossing.hpp b/src/plugins/score-plugin-analysis/Analysis/ZeroCrossing.hpp
@@ -13,6 +13,7 @@ struct ZeroCrossing
     static const constexpr auto prettyName = "Zero-crossings";
     static const constexpr auto objectKey = "Zerocross";
     static const constexpr auto category = "Analysis/Pitch";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#pitch-detection";
     static const constexpr auto author = "ossia score, Gist library";
     static const constexpr auto kind = Process::ProcessCategory::Analyzer;
     static const constexpr auto description = "Get the zero-crossing rate of a signal";

diff --git a/src/plugins/score-plugin-avnd/AvndProcesses/AddressTools.hpp b/src/plugins/score-plugin-avnd/AvndProcesses/AddressTools.hpp
@@ -103,6 +103,7 @@ struct PatternUnfolder : PatternObject
   halp_meta(description, "Send a message to all nodes matching a pattern")
   halp_meta(c_name, "avnd_pattern_apply")
   halp_meta(uuid, "44a55ee1-c2c9-43d5-a655-8eaedaff394c")
+  halp_meta(manual_url, "https://ossia.io/score-docs/processes/pattern-applier.html#pattern-applier")
 
   struct
   {

diff --git a/src/plugins/score-plugin-avnd/AvndProcesses/Combiner.hpp b/src/plugins/score-plugin-avnd/AvndProcesses/Combiner.hpp
@@ -12,6 +12,7 @@ struct PatternCombiner : PatternObject
   halp_meta(description, "Apply an operation to all inputs matching a pattern")
   halp_meta(c_name, "avnd_pattern_combine")
   halp_meta(uuid, "18efe965-9acc-4703-9af3-3cef658b301a")
+  halp_meta(manual_url, "https://ossia.io/score-docs/processes/pattern-combiner.html#pattern-combiner")
 
   struct
   {

diff --git a/src/plugins/score-plugin-avnd/AvndProcesses/DeviceRecorder.hpp b/src/plugins/score-plugin-avnd/AvndProcesses/DeviceRecorder.hpp
@@ -426,6 +426,7 @@ struct DeviceRecorder : PatternObject
   halp_meta(description, "Record the messages of a device at regular interval")
   halp_meta(c_name, "avnd_device_recorder")
   halp_meta(uuid, "7161ca22-5684-48f2-bde7-88933500a7fb")
+  halp_meta(manual_url, "https://ossia.io/score-docs/processes/csv-recorder.html#csv-recorder")
 
   // Threaded worker
   struct recorder_thread

diff --git a/src/plugins/score-plugin-avnd/AvndProcesses/Sweeper.hpp b/src/plugins/score-plugin-avnd/AvndProcesses/Sweeper.hpp
@@ -29,6 +29,7 @@ struct PatternSweeper : PatternObject
   halp_meta(description, "Sweep a message to all nodes matching a pattern")
   halp_meta(c_name, "avnd_pattern_sweep")
   halp_meta(uuid, "55f4fe13-f71b-4c20-ac32-74668e82664c")
+  halp_meta(manual_url, "https://ossia.io/score-docs/processes/sweeper.html#sweeper")
 
   struct
   {

diff --git a/src/plugins/score-plugin-avnd/Crousti/Metadata.hpp b/src/plugins/score-plugin-avnd/Crousti/Metadata.hpp
@@ -140,7 +140,7 @@ struct Metadata<Process::Descriptor_k, oscr::ProcessModel<Info>>
           if_exists(Info::kind(), else return Process::ProcessCategory::Other;),
           if_attribute(category), if_attribute(description), if_attribute(author),
           Metadata<Tags_k, oscr::ProcessModel<Info>>::get(), inletDescription(),
-          outletDescription()
+          outletDescription(), if_attribute(manual_url)
     };
     return desc;
   }

diff --git a/src/plugins/score-plugin-engine/Engine/Node/Process.hpp b/src/plugins/score-plugin-engine/Engine/Node/Process.hpp
@@ -100,7 +100,8 @@ struct Metadata<Process::Descriptor_k, Control::ControlProcess<Info>>
         Info::Metadata::author,
         Metadata<Tags_k, Control::ControlProcess<Info>>::get(),
         inletDescription(),
-        outletDescription()};
+        outletDescription(),
+        QUrl(Info::Metadata::manual_url)};
     return desc;
   }
 };

diff --git a/src/plugins/score-plugin-fx/Fx/AngleNode.hpp b/src/plugins/score-plugin-fx/Fx/AngleNode.hpp
@@ -12,6 +12,7 @@ struct Node
     static const constexpr auto objectKey = "AngleMapper";
     static const constexpr auto category = "Control/Mappings";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "";
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Map the variation of an angle";
     static const constexpr auto tags = std::array<const char*, 0>{};

diff --git a/src/plugins/score-plugin-fx/Fx/Arpeggiator.hpp b/src/plugins/score-plugin-fx/Fx/Arpeggiator.hpp
@@ -23,6 +23,7 @@ struct Node
     static const constexpr auto objectKey = "Arpeggiator";
     static const constexpr auto category = "Midi";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/midi-utilities.html#arpeggiator";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::MidiEffect;
     static const constexpr auto description = "Arpeggiator";

diff --git a/src/plugins/score-plugin-fx/Fx/Chord.hpp b/src/plugins/score-plugin-fx/Fx/Chord.hpp
@@ -15,6 +15,7 @@ struct Node
     static const constexpr auto objectKey = "Chord";
     static const constexpr auto category = "Midi";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/midi-utilities.html#chord";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Generate a chord from a single note";

diff --git a/src/plugins/score-plugin-fx/Fx/ClassicalBeat.hpp b/src/plugins/score-plugin-fx/Fx/ClassicalBeat.hpp
@@ -12,6 +12,7 @@ struct Node
     static const constexpr auto objectKey = "ImpulseMetronome";
     static const constexpr auto category = "Control/Generators";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/control-utilities.html#impulse-metronome";
     static const constexpr auto kind = Process::ProcessCategory::Generator;
     static const constexpr auto description
         = "A simple metronome - outputs a bang on the current tick";

diff --git a/src/plugins/score-plugin-fx/Fx/DebugFx.hpp b/src/plugins/score-plugin-fx/Fx/DebugFx.hpp
@@ -10,6 +10,7 @@ struct Node
     static const constexpr auto objectKey = "TestFX";
     static const constexpr auto category = "Debug";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::Other;
     static const constexpr auto description = "Shows all the available widgets";

diff --git a/src/plugins/score-plugin-fx/Fx/EmptyMapping.hpp b/src/plugins/score-plugin-fx/Fx/EmptyMapping.hpp
@@ -12,6 +12,7 @@ struct Node
     static const constexpr auto objectKey = "EmptyValueMapper";
     static const constexpr auto category = "Control/Mappings";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Copies its inputs to its outputs";
@@ -42,6 +43,7 @@ struct Node
     static const constexpr auto objectKey = "EmptyMidiMapper";
     static const constexpr auto category = "Control/Mappings";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "";
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Copies its inputs to its outputs";
     static const constexpr auto tags = std::array<const char*, 0>{};
@@ -72,6 +74,7 @@ struct Node
     static const constexpr auto objectKey = "EmptyAudioMapper";
     static const constexpr auto category = "Control/Mappings";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "";
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Copies its inputs to its outputs";
     static const constexpr auto tags = std::array<const char*, 0>{};

diff --git a/src/plugins/score-plugin-fx/Fx/Envelope.hpp b/src/plugins/score-plugin-fx/Fx/Envelope.hpp
@@ -14,6 +14,7 @@ struct Node
     static const constexpr auto objectKey = "Envelope";
     static const constexpr auto category = "Audio";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/analysis.html#envelope";
     static const constexpr auto kind
         = Process::ProcessCategory::Analyzer | Process::ProcessCategory::Deprecated;
     static const constexpr auto description

diff --git a/src/plugins/score-plugin-fx/Fx/FactorOracle.hpp b/src/plugins/score-plugin-fx/Fx/FactorOracle.hpp
@@ -215,6 +215,7 @@ struct Node
     static const constexpr auto prettyName = "Factor Oracle";
     static const constexpr auto objectKey = "Factor Oracle";
     static const constexpr auto category = "Control/Impro";
+    static const constexpr auto manual_url = "";
     static const constexpr auto author
         = "Shlomo Dubnov, Ge Wang, Éric Meaux, Jean-Michaël Celerier";
     static const constexpr auto kind = Process::ProcessCategory::Mapping;

diff --git a/src/plugins/score-plugin-fx/Fx/FactorOracle2.hpp b/src/plugins/score-plugin-fx/Fx/FactorOracle2.hpp
@@ -328,6 +328,7 @@ struct Node
     static const constexpr auto prettyName = "New Factor Oracle";
     static const constexpr auto objectKey = "New Factor Oracle";
     static const constexpr auto category = "Control/Impro";
+    static const constexpr auto manual_url = "";
     static const constexpr auto author = "Maria Paula Carrero Rivas";
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Factor Oracle algorithm ."; // TODO cite

diff --git a/src/plugins/score-plugin-fx/Fx/FactorOracle2MIDI.hpp b/src/plugins/score-plugin-fx/Fx/FactorOracle2MIDI.hpp
@@ -335,6 +335,7 @@ struct Node
     static const constexpr auto prettyName = "New Factor Oracle MIDI";
     static const constexpr auto objectKey = "New Factor Oracle MIDI";
     static const constexpr auto category = "Control/Impro";
+    static const constexpr auto manual_url = "";
     static const constexpr auto author = "Maria Paula Carrero Rivas";
     static const constexpr auto kind = Process::ProcessCategory::Mapping;
     static const constexpr auto description = "Factor Oracle algorithm ."; // TODO cite

diff --git a/src/plugins/score-plugin-fx/Fx/Gain.hpp b/src/plugins/score-plugin-fx/Fx/Gain.hpp
@@ -11,6 +11,7 @@ struct Node
     static const constexpr auto objectKey = "Gain";
     static const constexpr auto category = "Audio/Utilities";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/audio-utilities.html#gain";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::AudioEffect;
     static const constexpr auto description = "A simple volume control";

diff --git a/src/plugins/score-plugin-fx/Fx/LFO.hpp b/src/plugins/score-plugin-fx/Fx/LFO.hpp
@@ -34,6 +34,7 @@ struct Node
     static const constexpr auto objectKey = "LFO";
     static const constexpr auto category = "Control/Generators";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/lfo.html#lfo";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind
         = Process::ProcessCategory::Generator | Process::ProcessCategory::Deprecated;
@@ -236,6 +237,7 @@ struct Node
     static const constexpr auto objectKey = "LFO";
     static const constexpr auto category = "Control/Generators";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/lfo.html#lfo";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::Generator;
     static const constexpr auto description = "Low-frequency oscillator";

diff --git a/src/plugins/score-plugin-fx/Fx/Looper.hpp b/src/plugins/score-plugin-fx/Fx/Looper.hpp
@@ -11,6 +11,7 @@ struct Node
     static const constexpr auto objectKey = "Looper (audio)";
     static const constexpr auto category = "Audio/Utilities";
     static const constexpr auto author = "ossia score";
+    static const constexpr auto manual_url = "https://ossia.io/score-docs/processes/audio-looper.html#audio-looper";
     static const constexpr auto tags = std::array<const char*, 0>{};
     static const constexpr auto kind = Process::ProcessCategory::AudioEffect;
     static const constexpr auto description = "Loop audio";