From a2871d7ad8553dcc2d4a232d5103dcf234477e5a Mon Sep 17 00:00:00 2001 From: David Robillard Date: Mon, 16 Apr 2012 22:46:02 +0000 Subject: Improve documentation. --- lv2/lv2plug.in/ns/ext/presets/presets.ttl | 45 +++++++++++++++---------------- 1 file changed, 21 insertions(+), 24 deletions(-) (limited to 'lv2/lv2plug.in/ns/ext/presets') diff --git a/lv2/lv2plug.in/ns/ext/presets/presets.ttl b/lv2/lv2plug.in/ns/ext/presets/presets.ttl index 24dafc9..756590f 100644 --- a/lv2/lv2plug.in/ns/ext/presets/presets.ttl +++ b/lv2/lv2plug.in/ns/ext/presets/presets.ttl @@ -51,26 +51,10 @@ ] ] ; lv2:documentation """ -

This extension describes a format for presets (i.e. named sets of control +

This vocabulary describes a format for presets (i.e. named sets of control values and possibly other state) for LV2 plugins. The structure of a pset:Preset is deliberately identical to that of an lv2:Plugin, and can be -thought of as a plugin template or overlay. For example:

- -
-@prefix eg: <http://example.org/> .
-
-eg:mypreset
-    a pset:Preset ;
-    rdfs:label "One louder" ;
-    lv2:appliesTo eg:myplugin ;
-    lv2:port [
-        lv2:symbol "volume1" ;
-        pset:value 11.0
-    ] , [
-        lv2:symbol "volume2" ;
-        pset:value 11.0
-    ] .
-
+thought of as a plugin template or overlay.

Presets may be defined in any bundle, including the plugin's bundle, separate third party preset bundles, or user preset bundles saved by hosts. @@ -97,12 +81,25 @@ pset:Preset rdfs:comment "A Preset MUST have at least one string rdfs:label." ] ; lv2:documentation """ -

A Preset for an LV2 Plugin. A preset can be considered an "overlay" on a -Plugin. Rather than attempting to define all valid predicates for a Preset -(which is not possible since presets may need to specify values for things -defined in other extensions), the presets extension simply provides this class -which can be augmented with any data in the exact same fashion as the -definition of a Plugin.

+

A Preset for an LV2 Plugin. The structure of a Preset deliberately mirrors that +of a plugin, so existing predicates can be used to describe any data associated with +the preset. For example:

+ +
+@prefix eg: <http://example.org/> .
+
+eg:mypreset
+    a pset:Preset ;
+    rdfs:label "One louder" ;
+    lv2:appliesTo eg:myplugin ;
+    lv2:port [
+        lv2:symbol "volume1" ;
+        pset:value 11.0
+    ] , [
+        lv2:symbol "volume2" ;
+        pset:value 11.0
+    ] .
+

A Preset SHOULD have at least one lv2:appliesTo property. Each Port on a Preset MUST have at least a lv2:symbol property and a pset:value property.

-- cgit v1.2.1