aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/morph
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-03-22 16:36:44 +0100
committerDavid Robillard <d@drobilla.net>2020-04-10 19:46:04 +0200
commit430284545345539c9ffb31df889debac1d3888b5 (patch)
treedc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/morph
parentc4514483da1ab4f49148f9c4fe4ff5b559323217 (diff)
downloadlv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/morph')
-rw-r--r--lv2/morph/morph.meta.ttl69
-rw-r--r--lv2/morph/morph.ttl54
2 files changed, 75 insertions, 48 deletions
diff --git a/lv2/morph/morph.meta.ttl b/lv2/morph/morph.meta.ttl
index 32f3e70..0616473 100644
--- a/lv2/morph/morph.meta.ttl
+++ b/lv2/morph/morph.meta.ttl
@@ -1,6 +1,8 @@
@prefix dcs: <http://ontologi.es/doap-changeset#> .
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
+@prefix morph: <http://lv2plug.in/ns/ext/morph#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/morph>
@@ -19,5 +21,70 @@
rdfs:label "Initial release."
]
]
- ] .
+ ] ;
+ lv2:documentation """
+
+This extension defines two port types: morph:MorphPort, which has a
+host-configurable type, and morph:AutoMorphPort, which may automatically change
+type when a MorphPort's type is changed. These ports always have a default
+type and work normally work in hosts that are unaware of this extension. Thus,
+this extension provides a backwards compatibility mechanism which allows
+plugins to use new port types but gracefully fall back to a default type in
+hosts that do not support them.
+
+This extension only defines port types and properties for describing morph
+ports. The actual run-time switching is done via the opts:interface API.
+
+"""^^lv2:Markdown .
+
+morph:MorphPort
+ lv2:documentation """
+
+Ports of this type MUST have another type which defines the default buffer
+format (for example lv2:ControlPort) but can be dynamically changed to a
+different type in hosts that support opts:interface.
+
+The host may change the type of a MorphPort by setting its morph:currentType
+with LV2_Options_Interface::set(). If the plugin has any morph:AutoMorphPort
+ports, the host MUST check their types after changing any port type since they
+may have changed.
+
+"""^^lv2:Markdown .
+
+morph:AutoMorphPort
+ lv2:documentation """
+
+Ports of this type MUST have another type which defines the default buffer
+format (e.g. lv2:ControlPort) but may dynamically change types based on the
+configured types of any morph:MorphPort ports on the same plugin instance.
+
+The type of a port may only change in response to a host call to
+LV2_Options_Interface::set(). Whenever any port type on the instance changes,
+the host MUST check the type of all morph:AutoMorphPort ports with
+LV2_Options_Interface::get() before calling run() again, since they may have
+changed. If the type of any port is zero, it means the current configuration
+is invalid and the plugin may not be run (unless that port is
+lv2:connectionOptional and connected to NULL).
+
+This is mainly useful for outputs whose type depends on the type of
+corresponding inputs.
+
+"""^^lv2:Markdown .
+
+morph:supportsType
+ lv2:documentation """
+
+Indicates that a port supports being switched to a certain type. A MorphPort
+MUST list each type it supports being switched to in the plugin data using this
+property.
+
+"""^^lv2:Markdown .
+
+morph:currentType
+ lv2:documentation """
+
+The currently active type of the port. This is for dynamic use as an option
+and SHOULD NOT be listed in the static plugin data.
+
+"""^^lv2:Markdown .
diff --git a/lv2/morph/morph.ttl b/lv2/morph/morph.ttl
index af48201..3afe358 100644
--- a/lv2/morph/morph.ttl
+++ b/lv2/morph/morph.ttl
@@ -11,68 +11,31 @@
<http://lv2plug.in/ns/ext/morph>
a owl:Ontology ,
lv2:Specification ;
+ rdfs:label "LV2 Morph" ;
+ rdfs:comment "Ports that can dynamically change type." ;
rdfs:seeAlso <morph.h> ,
- <morph.meta.ttl> ;
- lv2:documentation """
-<p>This extension defines two port types: morph:MorphPort, which has a
-host-configurable type, and morph:AutoMorphPort, which may automatically change
-type when a MorphPort's type is changed. These ports always have a default
-type and work normally work in hosts that are unaware of this extension. Thus,
-this extension provides a backwards compatibility mechanism which allows
-plugins to use new port types but gracefully fall back to a default type in
-hosts that do not support them.</p>
-
-<p>This extension only defines port types and properties for describing morph
-ports. The actual run-time switching is done via the opts:interface API.</p>
-""" .
+ <morph.meta.ttl> .
morph:MorphPort
a rdfs:Class ,
owl:Class ;
rdfs:subClassOf lv2:Port ;
rdfs:label "Morph Port" ;
- lv2:documentation """
-<p>Ports of this type MUST have another type which defines the default buffer
-format (e.g. lv2:ControlPort) but can be dynamically changed to a different
-type in hosts that support opts:interface.</p>
-
-<p>The host may change the type of a MorphPort by setting its morph:currentType
-with LV2_Options_Interface::set(). If the plugin has any morph:AutoMorphPort
-ports, the host MUST check their types after changing any port type since they
-may have changed.</p> """ .
+ rdfs:comment "A port which can be switched to another type." .
morph:AutoMorphPort
a rdfs:Class ,
owl:Class ;
rdfs:subClassOf lv2:Port ;
rdfs:label "Auto Morph Port" ;
- lv2:documentation """
-<p>Ports of this type MUST have another type which defines the default buffer
-format (e.g. lv2:ControlPort) but may dynamically change types based on the
-configured types of any morph:MorphPort ports on the same plugin instance.</p>
-
-<p>The type of a port may only change in response to a host call to
-LV2_Options_Interface::set(). Whenever any port type on the instance changes,
-the host MUST check the type of all morph:AutoMorphPort ports with
-LV2_Options_Interface::get() before calling run() again, since they may have
-changed. If the type of any port is zero, it means the current configuration
-is invalid and the plugin may not be run (unless that port is
-lv2:connectionOptional and connected to NULL).</p>
-
-<p>This is mainly useful for outputs whose type depends on the type of
-corresponding inputs.</p>
-""" .
+ rdfs:comment "A port that can change its type based on that of another." .
morph:supportsType
a rdf:Property ,
owl:ObjectProperty ;
rdfs:domain morph:MorphPort ;
rdfs:label "supports type" ;
- lv2:documentation """
-<p>Indicates that a port supports being switched to a certain type. A
-MorphPort MUST list each type it supports being switched to in the plugin data
-using this property.</p>
-""" .
+ rdfs:comment "A type that a port supports being switched to." .
morph:currentType
a rdf:Property ,
@@ -80,8 +43,5 @@ morph:currentType
owl:ObjectProperty ;
rdfs:domain morph:MorphPort ;
rdfs:label "current type" ;
- lv2:documentation """
-<p>The currently active type of the port. This is for dynamic use as an option
-and SHOULD NOT be listed in the static plugin data.</p>
-""" .
+ rdfs:comment "The currently active type of the port." .