From ca1877705386fc2f2a4b0ebecb0adba8c793dcbf Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sat, 28 Mar 2015 13:01:00 -0400 Subject: Remove formatting from comments for UI display. --- lv2/lv2plug.in/ns/ext/atom/atom.ttl | 5 +- lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl | 12 +-- lv2/lv2plug.in/ns/ext/event/event.ttl | 100 ++++++-------------- lv2/lv2plug.in/ns/ext/midi/midi.ttl | 4 +- lv2/lv2plug.in/ns/ext/parameters/parameters.ttl | 6 +- lv2/lv2plug.in/ns/ext/patch/patch.ttl | 107 ++++++---------------- lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl | 85 ++++------------- lv2/lv2plug.in/ns/ext/port-props/port-props.ttl | 96 +++---------------- lv2/lv2plug.in/ns/ext/presets/presets.ttl | 5 +- 9 files changed, 93 insertions(+), 327 deletions(-) (limited to 'lv2/lv2plug.in/ns/ext') diff --git a/lv2/lv2plug.in/ns/ext/atom/atom.ttl b/lv2/lv2plug.in/ns/ext/atom/atom.ttl index e854bed..8d41f35 100644 --- a/lv2/lv2plug.in/ns/ext/atom/atom.ttl +++ b/lv2/lv2plug.in/ns/ext/atom/atom.ttl @@ -65,10 +65,7 @@ atom:cType rdfs:label "C type" ; rdfs:domain rdfs:Class ; rdfs:range lv2:Symbol ; - rdfs:comment """ -The identifier for a C type describing the binary representation of an Atom of -this type. -""" . + rdfs:comment """The identifier for a C type describing the binary representation of an Atom of this type.""" . atom:Atom a rdfs:Class ; diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl index 3806374..71980a1 100644 --- a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl +++ b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.ttl @@ -75,16 +75,10 @@ dman:DynManifest a owl:Restriction ; owl:onProperty lv2:binary ; owl:minCardinality 1 ; - rdfs:comment """ -A DynManifest MUST have at least 1 lv2:binary, which MUST implement all the -functions defined in dynmanifest.h. -""" + rdfs:comment "A DynManifest MUST have at least 1 lv2:binary, which MUST implement all the functions defined in dynmanifest.h." ] ; - rdfs:comment """ -The class which represents a dynamic manifest generator. + rdfs:comment """The class which represents a dynamic manifest generator. There MUST NOT be any instances of dman:DynManifest in the generated manifest. -All relative URIs in the generated data MUST be relative to the base path -that would be used to parse a normal LV2 manifest (the bundle path). -""" . +All relative URIs in the generated data MUST be relative to the base path that would be used to parse a normal LV2 manifest (the bundle path).""" . diff --git a/lv2/lv2plug.in/ns/ext/event/event.ttl b/lv2/lv2plug.in/ns/ext/event/event.ttl index 66776f8..94e429f 100644 --- a/lv2/lv2plug.in/ns/ext/event/event.ttl +++ b/lv2/lv2plug.in/ns/ext/event/event.ttl @@ -31,79 +31,49 @@ ev:EventPort a rdfs:Class ; rdfs:label "Event Port" ; rdfs:subClassOf lv2:Port ; - rdfs:comment """ -Ports of this type will be connected to a struct of type LV2_Event_Buffer, -defined in event.h. These ports contain a sequence of generic events -(possibly several types mixed in a single stream), the specific types of -which are defined by some URI in another LV2 extension. -""" . + rdfs:comment """Ports of this type will be connected to a struct of type LV2_Event_Buffer, defined in event.h. These ports contain a sequence of generic events (possibly several types mixed in a single stream), the specific types of which are defined by some URI in another LV2 extension.""" . ev:Event a rdfs:Class ; rdfs:label "Event" ; - rdfs:comment """ -A single generic time-stamped event. + rdfs:comment """A single generic time-stamped event. -An ev:EventPort contains an LV2_Event_Buffer which contains a sequence -of these events. The binary format of LV2 events is defined by the -LV2_Event struct in event.h. +An ev:EventPort contains an LV2_Event_Buffer which contains a sequence of these events. The binary format of LV2 events is defined by the LV2_Event struct in event.h. -Specific event types (e.g. MIDI, OSC) are defined by extensions, and should -be rdfs:subClassOf this class. -""" . +Specific event types (e.g. MIDI, OSC) are defined by extensions, and should be rdfs:subClassOf this class.""" . ev:TimeStamp a rdfs:Class ; rdfs:label "Event Time Stamp" ; - rdfs:comment """ -The time stamp of an Event. + rdfs:comment """The time stamp of an Event. -This defines the meaning of the 'frames' and 'subframes' fields of an -LV2_Event (both unsigned 32-bit integers). -""" . +This defines the meaning of the 'frames' and 'subframes' fields of an LV2_Event (both unsigned 32-bit integers).""" . ev:FrameStamp a rdfs:Class ; rdfs:subClassOf ev:TimeStamp ; rdfs:label "Audio Frame Time Stamp" ; - rdfs:comment """ -The default time stamp unit for an LV2 event: the frames field represents + rdfs:comment """The default time stamp unit for an LV2 event: the frames field represents audio frames (in the sample rate passed to intantiate), and the subframes -field is 1/UINT32_MAX of a frame. -""" . +field is 1/UINT32_MAX of a frame.""" . ev:generic a lv2:PortProperty ; rdfs:label "generic event port" ; - rdfs:comment """ -Indicates that this port does something meaningful for any event type -(e.g. event mixers, delays, serialisers, etc). If this property is set, hosts -should consider the port suitable for any type of event. Otherwise, hosts -should consider the port 'appropriate' only for the specific event types -listed with :supportsEvent. Note that plugins must gracefully handle unknown -event types whether or not this property is present. -""" . + rdfs:comment """Indicates that this port does something meaningful for any event type (e.g. event mixers, delays, serialisers, etc). + +If this property is set, hosts should consider the port suitable for any type of event. Otherwise, hosts should consider the port 'appropriate' only for the specific event types listed with :supportsEvent. Note that plugins must gracefully handle unknown event types whether or not this property is present.""" . ev:supportsEvent a rdf:Property ; rdfs:domain ev:EventPort ; rdfs:range rdfs:Class ; rdfs:label "supports event type" ; - rdfs:comment """ -Indicates that this port supports or "understands" a certain event type. -For input ports, this means the plugin understands and does something useful -with events of this type. For output ports, this means the plugin may generate -events of this type. If the plugin never actually generates events of this type, -but might pass them through from an input, this property should not be set (use -ev:inheritsEvent for that). -Plugins with event input ports must always gracefully handle any type of event, -even if it does not 'support' it. This property should always be set for -event types the plugin understands/generates so hosts can discover plugins -appropriate for a given scenario (e.g. plugins with a MIDI input). -Hosts are not expected to consider event ports suitable for some type of -event if the relevant :supportsEvent property is not set, unless the -ev:generic property for that port is also set. -""" . + rdfs:comment """Indicates that this port supports or "understands" a certain event type. + +For input ports, this means the plugin understands and does something useful with events of this type. For output ports, this means the plugin may generate events of this type. If the plugin never actually generates events of this type, but might pass them through from an input, this property should not be set (use ev:inheritsEvent for that). + +Plugins with event input ports must always gracefully handle any type of event, even if it does not 'support' it. This property should always be set for event types the plugin understands/generates so hosts can discover plugins appropriate for a given scenario (e.g. plugins with a MIDI input). Hosts are not expected to consider event ports suitable for some type of event if the relevant :supportsEvent property is not set, unless the ev:generic property for that port is also set.""" . ev:inheritsEvent a rdf:Property ; @@ -111,12 +81,7 @@ ev:inheritsEvent lv2:OutputPort ; rdfs:range lv2:Port ; rdfs:label "inherits event type" ; - rdfs:comment """ -Indicates that this output port might pass through events that arrived at some -other input port (or generate an event of the same type as events arriving at -that input). The host must always check the stamp type of all outputs when -connecting an input, but this property should be set whenever it applies. -""" . + rdfs:comment """Indicates that this output port might pass through events that arrived at some other input port (or generate an event of the same type as events arriving at that input). The host must always check the stamp type of all outputs when connecting an input, but this property should be set whenever it applies.""" . ev:supportsTimeStamp a rdf:Property ; @@ -124,11 +89,7 @@ ev:supportsTimeStamp lv2:InputPort ; rdfs:range rdfs:Class ; rdfs:label "supports time stamp type" ; - rdfs:comment """ -Indicates that this port supports or "understands" a certain time stamp type. -Meaningful only for input ports, the host must never connect a port to an -event buffer with a time stamp type that isn't supported by the port. -""" . + rdfs:comment """Indicates that this port supports or "understands" a certain time stamp type. Meaningful only for input ports, the host must never connect a port to an event buffer with a time stamp type that isn't supported by the port.""" . ev:generatesTimeStamp a rdf:Property ; @@ -136,17 +97,11 @@ ev:generatesTimeStamp lv2:OutputPort ; rdfs:range rdfs:Class ; rdfs:label "generates time stamp type" ; - rdfs:comment """ -Indicates that this port may output a certain time stamp type, regardless of -the time stamp type of any input ports. If the port outputs stamps based on -what type inputs are connected to, this property should not be set (use the -ev:inheritsTimeStamp property for that). Hosts MUST check the time_stamp value -of any output port buffers after a call to connect_port on ANY event input -port on the plugin. If the plugin changes the stamp_type field of an output -event buffer during a call to run(), the plugin must call the -stamp_type_changed function provided by the host in the LV2_Event_Feature -struct, if it is non-NULL. -""" . + rdfs:comment """Indicates that this port may output a certain time stamp type, regardless of the time stamp type of any input ports. + +If the port outputs stamps based on what type inputs are connected to, this property should not be set (use the ev:inheritsTimeStamp property for that). Hosts MUST check the time_stamp value of any output port buffers after a call to connect_port on ANY event input port on the plugin. + +If the plugin changes the stamp_type field of an output event buffer during a call to run(), the plugin must call the stamp_type_changed function provided by the host in the LV2_Event_Feature struct, if it is non-NULL.""" . ev:inheritsTimeStamp a rdf:Property ; @@ -154,9 +109,6 @@ ev:inheritsTimeStamp lv2:OutputPort ; rdfs:range lv2:Port ; rdfs:label "inherits time stamp type" ; - rdfs:comment """ -Indicates that this port follows the time stamp type of an input port. -This property is not necessary, but it should be set for outputs that -base their output type on an input port so the host can make more sense -of the plugin and provide a more sensible interface. -""" . + rdfs:comment """Indicates that this port follows the time stamp type of an input port. + +This property is not necessary, but it should be set for outputs that base their output type on an input port so the host can make more sense of the plugin and provide a more sensible interface.""" . diff --git a/lv2/lv2plug.in/ns/ext/midi/midi.ttl b/lv2/lv2plug.in/ns/ext/midi/midi.ttl index 0be2a6e..20d7f37 100644 --- a/lv2/lv2plug.in/ns/ext/midi/midi.ttl +++ b/lv2/lv2plug.in/ns/ext/midi/midi.ttl @@ -387,9 +387,7 @@ midi:statusMask owl:FunctionalProperty ; rdfs:label "status mask" ; rdfs:range midi:HexByte ; - rdfs:comment """ -The status byte for a message of this type on channel 1, i.e. a status byte -with the lower nibble set to zero.""" . + rdfs:comment """The status byte for a message of this type on channel 1, i.e. a status byte with the lower nibble set to zero.""" . midi:velocity a rdf:Property , diff --git a/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl b/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl index c89ac78..2919c3e 100644 --- a/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl +++ b/lv2/lv2plug.in/ns/ext/parameters/parameters.ttl @@ -20,9 +20,7 @@ to the user more efficiently.

""" . param:ControlGroup a rdfs:Class ; rdfs:subClassOf pg:Group ; - rdfs:comment """ -A group representing a set of associated controls. -""" . + rdfs:comment "A group representing a set of associated controls." . param:amplitude a lv2:Parameter ; @@ -73,7 +71,7 @@ param:ratio a lv2:Parameter ; rdfs:range atom:Float ; rdfs:label "ratio" ; - rdfs:comment "Compression ration." . + rdfs:comment "Compression ratio." . param:release a lv2:Parameter ; diff --git a/lv2/lv2plug.in/ns/ext/patch/patch.ttl b/lv2/lv2plug.in/ns/ext/patch/patch.ttl index 9599285..0e4c47d 100644 --- a/lv2/lv2plug.in/ns/ext/patch/patch.ttl +++ b/lv2/lv2plug.in/ns/ext/patch/patch.ttl @@ -46,11 +46,7 @@ patch:Ack a rdfs:Class ; rdfs:subClassOf patch:Response ; rdfs:label "Ack" ; - lv2:documentation """ -

An acknowledgement that a request has been successfully processed. This is -returned as a reply when a specific reply type is not necessary or -appropriate.

-""" . + rdfs:comment """An acknowledgement that a request has been successfully processed. This is returned as a reply when a specific reply type is not necessary or appropriate. """ . patch:Copy a rdfs:Class ; @@ -65,36 +61,27 @@ patch:Copy owl:cardinality 1 ; owl:onProperty patch:destination ] ; - lv2:documentation """ -

Copy the patch:subject to patch:destination. After this, patch:destination -has the description patch:subject had prior to this request's execution, and -patch:subject is unchanged. It is an error if the subject does not exist or -the destination already exists.

+ rdfs:comment """Copy the patch:subject to patch:destination. After this, patch:destination has the description patch:subject had prior to this request's execution, and patch:subject is unchanged. It is an error if the subject does not exist or the destination already exists. -

Multiple patch:subject properties may be given if the patch:destination is -a container, the semantics of this use case are application defined.

-""" . +Multiple patch:subject properties may be given if the patch:destination is a container, the semantics of this use case are application defined.""" . patch:Delete a rdfs:Class ; rdfs:subClassOf patch:Request ; rdfs:label "Delete" ; - lv2:documentation """ -

Request the subject(s) be deleted.

-""" . + rdfs:comment "Request the subject(s) be deleted." . patch:Error a rdfs:Class ; rdfs:subClassOf patch:Response ; rdfs:label "Error" ; - lv2:documentation """ -

A response indicating an error processing a request.

-""" . + rdfs:comment "A response indicating an error processing a request." . patch:Get a rdfs:Class ; rdfs:subClassOf patch:Request ; rdfs:label "Get" ; + rdfs:comment "Request a description of the subject." ; lv2:documentation """

Request a description of the subject.

@@ -154,16 +141,11 @@ patch:Insert owl:cardinality 1 ; owl:onProperty patch:subject ] ; - lv2:documentation """ -

Insert the patch:body at patch:subject. If the subject does not exist, it is -created. If the subject does already exist, it is added to. This request only -adds properties, it never removes them. The user must take care that multiple -values are not set for properties which should only have one value.

-""" . + rdfs:comment """Insert the patch:body at patch:subject. If the subject does not exist, it is created. If the subject does already exist, it is added to. This request only adds properties, it never removes them. The user must take care that multiple values are not set for properties which should only have one value.""" . patch:Message a rdfs:Class ; - rdfs:label "Message" . + rdfs:label "Patch Message" . patch:Move a rdfs:Class ; @@ -178,12 +160,7 @@ patch:Move owl:cardinality 1 ; owl:onProperty patch:destination ] ; - lv2:documentation """ -

Move the patch:subject to patch:destination. After this, patch:destination -has the description patch:subject had prior to this request's execution, and -patch:subject no longer exists. It is an error if the subject does not exist -or the destination already exists.

-""" . + rdfs:comment "Move the patch:subject to patch:destination. After this, patch:destination has the description patch:subject had prior to this request's execution, and patch:subject no longer exists. It is an error if the subject does not exist or the destination already exists." . patch:Patch a rdfs:Class ; @@ -194,8 +171,9 @@ patch:Patch owl:onProperty patch:subject ] ; rdfs:label "Patch" ; + rdfs:comment "Add and/or remove properties of the subject." ; lv2:documentation """ -

A method for modifying the properties of an object.

+

Add and/or remove properties of the subject.

This method always has at least one patch:subject, and exactly one patch:add and patch:remove property. The value of patch:add and patch:remove are nodes @@ -227,29 +205,19 @@ patch:Put owl:cardinality 1 ; owl:onProperty patch:subject ] ; - lv2:documentation """ -

Put the patch:body as the patch:subject. If the subject does not already exist, -it is created. If the subject does already exist, the patch:body is considered -an updated version of it, and the previous version is replaced.

-""" . + rdfs:comment """Put the patch:body as the patch:subject. If the subject does not already exist, it is created. If the subject does already exist, the patch:body is considered an updated version of it, and the previous version is replaced.""" . patch:Request a rdfs:Class ; rdfs:label "Request" ; rdfs:subClassOf patch:Message ; - lv2:documentation """ -

A request. A request may have a patch:subject property, which indicates which -resource the request applies to. The subject may be omitted in contexts where -it is implicit (e.g. the recipient is the subject).

-""" . + rdfs:comment """A request. A request may have a patch:subject property, which indicates which resource the request applies to. The subject may be omitted in contexts where it is implicit (e.g. the recipient is the subject).""" . patch:Response a rdfs:Class ; rdfs:subClassOf patch:Message ; rdfs:label "Response" ; - lv2:documentation """ -

A response to a method.

-""" . + rdfs:comment "A response to a message." . patch:Set a rdfs:Class ; @@ -264,6 +232,7 @@ patch:Set owl:cardinality 1 ; owl:onProperty patch:value ] ; + rdfs:comment "Set one property to a specific value." ; lv2:documentation """

A compact message for setting one property to a specific value.

@@ -303,12 +272,10 @@ patch:body owl:ObjectProperty , owl:FunctionalProperty ; rdfs:domain patch:Message ; - lv2:documentation """ -

The body of a message.

+ rdfs:comment """The body of a message. -

The details of this property's value depend on the type of message it is a -part of.

-""" . +The details of this property's value depend on the type of message it is a +part of.""" . patch:destination a rdf:Property , @@ -319,19 +286,16 @@ patch:destination patch:property a rdf:Property ; rdfs:label "property" ; + rdfs:domain patch:Set ; rdfs:range rdf:Property ; - lv2:documentation """ -

The property this message applies to.

-""" . + rdfs:comment "The property for a Set message." . patch:readable a rdf:Property ; rdfs:label "readable" ; rdfs:range rdf:Property ; - lv2:documentation """ -

Indicates that the subject may have a property that can be read via a -patch:Get message. See the similar property patch:writable for details.

-""" . + rdfs:comment """Indicates that the subject may have a property that can be read via a +patch:Get message. See the similar property patch:writable for details.""" . patch:remove a rdf:Property , @@ -347,11 +311,7 @@ patch:request rdfs:label "request" ; rdfs:domain patch:Response ; rdfs:range patch:Request ; - lv2:documentation """ -

The request this is a response to. This can be used if referring directly -to the URI or blank node ID of the request is possible. Otherwise, use -patch:sequenceNumber.

-""" . + rdfs:comment """The request this is a response to. This can be used if referring directly to the URI or blank node ID of the request is possible. Otherwise, use patch:sequenceNumber.""" . patch:sequenceNumber a rdf:Property , @@ -360,34 +320,27 @@ patch:sequenceNumber rdfs:label "sequence number" ; rdfs:domain patch:Message ; rdfs:range xsd:int ; - lv2:documentation """ -

The sequence number of a request or response. This property is used to -associate replies with requests when it is not feasible to refer to request -URIs with patch:request. A patch:Response with a given sequence number is the -reply to the previously send patch:Request with the same sequence number.

+ rdfs:comment """The sequence number of a request or response. This property is used to associate replies with requests when it is not feasible to refer to request URIs with patch:request. A patch:Response with a given sequence number is the reply to the previously send patch:Request with the same sequence number. -

The special sequence number 0 means no reply is desired.

-""" . +The special sequence number 0 means no reply is desired. """ . patch:subject a rdf:Property , owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain patch:Message . + rdfs:domain patch:Message ; + rdfs:comment "The subject this message applies to." . patch:value a rdf:Property ; rdfs:label "value" ; + rdfs:domain patch:Set ; rdfs:range rdf:Property ; - lv2:documentation """ -

The value of a property in a patch:Set message.

-""" . + rdfs:comment "The value of a property in a patch:Set message." . patch:wildcard a rdfs:Resource ; - rdfs:comment """ -A wildcard which matches any resource. This makes it possible to describe the removal of all values for a given property. -""" . + rdfs:comment """A wildcard which matches any resource. This makes it possible to describe the removal of all values for a given property.""" . patch:writable a rdf:Property ; diff --git a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl b/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl index e02ec7b..011b0fc 100644 --- a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl +++ b/lv2/lv2plug.in/ns/ext/port-groups/port-groups.ttl @@ -17,22 +17,14 @@ pg:Group a owl:Restriction ; owl:onProperty lv2:symbol ; owl:cardinality 1 ; - rdfs:comment """ -A pg:Group MUST have exactly one string lv2:symbol. This symbol must be -unique according to the same rules as the lv2:symbol for an lv2:Port, where -group symbols and port symbols reside in the same namespace. In other words, -a group on a plugin MUST NOT have the same symbol as another group or a port -on that plugin. This makes it possible to uniquely reference a port or group -on a plugin with a single identifier and no context. -""" + rdfs:comment """A pg:Group MUST have exactly one string lv2:symbol. + +This symbol must be unique according to the same rules as the lv2:symbol for an lv2:Port, where group symbols and port symbols reside in the same namespace. In other words, a group on a plugin MUST NOT have the same symbol as another group or a port on that plugin. This makes it possible to uniquely reference a port or group on a plugin with a single identifier and no context.""" ] ; - rdfs:comment """ -A set of ports/channels/controls/etc that are are logically grouped together, -e.g. two audio ports in a group may form a stereo stream. In order to avoid -the need to define large numbers of identical group definitions, a group -definition may be shared. For example, a plugin collection may define a single -URI for a pg:StereoGroup with the symbol "input" and use it in many plugins. -""" . + rdfs:comment """A set of ports/channels/controls/etc that are are logically grouped together, +e.g. two audio ports in a group may form a stereo stream. + +In order to avoid the need to define large numbers of identical group definitions, a group definition may be shared. For example, a plugin collection may define a single URI for a pg:StereoGroup with the symbol "input" and use it in many plugins.""" . pg:InputGroup a rdfs:Class ; @@ -56,30 +48,20 @@ pg:Element owl:cardinality 1 ; rdfs:comment "An element MUST have exactly one lv2:designation." ] ; - rdfs:comment """ -An element of a group, which has a designation and an optional index. -""" . + rdfs:comment "An element of a group, which has a designation and an optional index." . pg:element a rdf:Property , owl:ObjectProperty ; rdfs:range pg:Element ; rdfs:label "element" ; - rdfs:comment """ -Indicates that a group has a certain element (a parameter or channel -designation with a possible index). -""" . + rdfs:comment """Indicates that a group has a certain element (a parameter or channel designation with a possible index).""" . pg:sideChainOf a rdf:Property , owl:ObjectProperty ; rdfs:label "side-chain of" ; - rdfs:comment """ -Indicates that this port or group should be considered a "side chain" of -some other port or group. The precise definition of "side chain" depends -on the plugin, but in general this group should be considered a modifier to -some other group, rather than an independent input itself. -""" . + rdfs:comment """Indicates that this port or group should be considered a "side chain" of some other port or group. The precise definition of "side chain" depends on the plugin, but in general this group should be considered a modifier to some other group, rather than an independent input itself.""" . pg:subGroupOf a rdf:Property , @@ -88,13 +70,7 @@ pg:subGroupOf rdfs:domain pg:Group ; rdfs:range pg:Group ; rdfs:label "sub-group of" ; - rdfs:comment """ -Indicates that this group is a child of another group. This property has no -meaning with respect to plugin execution, but the host may find this -information useful (e.g. to provide a compact user interface). Note that being -a sub-group does not relax the restriction that the group MUST have a unique -symbol with respect to the plugin. -""" . + rdfs:comment """Indicates that this group is a child of another group. This property has no meaning with respect to plugin execution, but the host may find this information useful (e.g. to provide a compact user interface). Note that being a sub-group does not relax the restriction that the group MUST have a unique symbol with respect to the plugin.""" . pg:source a rdf:Property , @@ -102,13 +78,7 @@ pg:source rdfs:domain pg:OutputGroup ; rdfs:range pg:InputGroup ; rdfs:label "source" ; - rdfs:comment """ -Indicates that this port or group should be considered the "result" of -some other port or group. This property only makes sense on groups with -outputs when the source is a group with inputs. This can be used to convey -a relationship between corresponding input and output groups with different -types, e.g. a mono->stereo plugin. -""" . + rdfs:comment """Indicates that this port or group should be considered the "result" of some other port or group. This property only makes sense on groups with outputs when the source is a group with inputs. This can be used to convey a relationship between corresponding input and output groups with different types, e.g. a mono->stereo plugin.""" . pg:mainInput a rdf:Property , @@ -117,11 +87,7 @@ pg:mainInput rdfs:domain lv2:Plugin ; rdfs:range pg:InputGroup ; rdfs:label "main input" ; - rdfs:comment """ -Indicates that this group should be considered the "main" input, i.e. the -primary task is processing the signal in this group. A plugin MUST NOT have -more than one pg:mainInput property. -""" . + rdfs:comment """Indicates that this group should be considered the "main" input, i.e. the primary task is processing the signal in this group. A plugin MUST NOT have more than one pg:mainInput property.""" . pg:mainOutput a rdf:Property , @@ -130,10 +96,7 @@ pg:mainOutput rdfs:domain lv2:Plugin ; rdfs:range pg:OutputGroup ; rdfs:label "main output" ; - rdfs:comment """ -Indicates that this group should be considered the "main" output. The main -output group SHOULD have the main input group as a pg:source. -""" . + rdfs:comment """Indicates that this group should be considered the "main" output. The main output group SHOULD have the main input group as a pg:source.""" . pg:group a rdf:Property , @@ -142,20 +105,12 @@ pg:group rdfs:domain lv2:Port ; rdfs:range pg:Group ; rdfs:label "group" ; - rdfs:comment """ -Indicates that this port is a part of a group of ports on the plugin. The port -should also have an lv2:designation property to define its designation within -that group. -""" . + rdfs:comment """Indicates that this port is a part of a group of ports on the plugin. The port should also have an lv2:designation property to define its designation within that group.""" . pg:DiscreteGroup a rdfs:Class ; rdfs:subClassOf pg:Group ; - rdfs:comment """ -"Discrete" channel configurations. These groups are divided into channels -where each represents a particular speaker location. The position of sound -in one of these groups depends on a particular speaker configuration. -""" . + rdfs:comment """Discrete channel configurations. These groups are divided into channels where each represents a particular speaker location. The position of sound in one of these groups depends on a particular speaker configuration.""" . pg:left a lv2:Channel ; @@ -454,13 +409,7 @@ amb:ACN15 pg:AmbisonicGroup a rdfs:Class ; rdfs:subClassOf pg:Group ; - rdfs:comment """ -"Ambisonic" channel configurations. These groups are divided into channels -which together represent a position in an abstract n-dimensional space. -The position of sound in one of these groups does not depend on a particular -speaker configuration; a decoder can be used to convert an ambisonic stream -for any speaker configuration. -""" . + rdfs:comment """Ambisonic channel configurations. These groups are divided into channels which together represent a position in an abstract n-dimensional space. The position of sound in one of these groups does not depend on a particular speaker configuration; a decoder can be used to convert an ambisonic stream for any speaker configuration.""" . pg:AmbisonicBH1P0Group a rdfs:Class ; diff --git a/lv2/lv2plug.in/ns/ext/port-props/port-props.ttl b/lv2/lv2plug.in/ns/ext/port-props/port-props.ttl index 7eb7e7d..f27f51e 100644 --- a/lv2/lv2plug.in/ns/ext/port-props/port-props.ttl +++ b/lv2/lv2plug.in/ns/ext/port-props/port-props.ttl @@ -12,136 +12,64 @@

This vocabulary defines various properties for plugin ports, which can be used to better describe how a plugin can be controlled. Using this metadata, hosts can build better UIs for plugins, and provide more advanced automatic -functionality.

-""" . +functionality.

""" . pprops:trigger a lv2:PortProperty ; rdfs:label "trigger" ; - rdfs:comment """ -Indicates that the data item corresponds to a momentary event that has been -detected (control output ports) or is to be triggered (control input ports). -For input ports, the port needs to be reset to lv2:default value after run() -function of the plugin has returned. If the control port is assigned a GUI -widget by the host, the widget should be of auto-off (momentary, one-shot) type -- for example, a push button if the port is also declared as lv2:toggled, or a -series of push button or auto-clear input box with a "Send" button if the port -is also lv2:integer. -""" . + rdfs:comment """Indicates that the data item corresponds to a momentary event that has been detected (control output ports) or is to be triggered (control input ports). For input ports, the port needs to be reset to lv2:default value after run() function of the plugin has returned. If the control port is assigned a GUI widget by the host, the widget should be of auto-off (momentary, one-shot) type - for example, a push button if the port is also declared as lv2:toggled, or a series of push button or auto-clear input box with a "Send" button if the port is also lv2:integer.""" . pprops:supportsStrictBounds a lv2:Feature ; rdfs:label "supports strict bounds" ; - rdfs:comment """ -Indicates use of host support for pprops:hasStrictBounds port property. A -plugin that specifies it as optional feature can omit value clamping for -hasStrictBounds ports, if the feature is supported by the host. When specified -as required feature, it indicates that the plugin does not do any clamping for -input ports that have a pprops:hasStrictBounds property. -""" . + rdfs:comment """Indicates use of host support for pprops:hasStrictBounds port property. A plugin that specifies it as optional feature can omit value clamping for hasStrictBounds ports, if the feature is supported by the host. When specified as required feature, it indicates that the plugin does not do any clamping for input ports that have a pprops:hasStrictBounds property.""" . pprops:hasStrictBounds a lv2:PortProperty ; rdfs:label "has strict bounds" ; - rdfs:comment """ -For hosts that support pprops:supportsStrictBounds, this indicates that the -value of the port should never exceed the port's minimum and maximum control -points. For input ports, it moves the responsibility for limiting the range of -values to host, if it supports pprops:supportsStrictBounds. For output ports, -it indicates that values within specified range are to be expected, and -breaking that should be considered by the host as error in plugin -implementation. -""" . + rdfs:comment """For hosts that support pprops:supportsStrictBounds, this indicates that the value of the port should never exceed the port's minimum and maximum control points. For input ports, it moves the responsibility for limiting the range of values to host, if it supports pprops:supportsStrictBounds. For output ports, it indicates that values within specified range are to be expected, and breaking that should be considered by the host as error in plugin implementation.""" . pprops:expensive a lv2:PortProperty ; rdfs:label "changes are expensive" ; - rdfs:comment """ -Input ports only. Indicates that any changes to the port value may trigger -expensive background calculation (e.g. regenerate some lookup tables in a -background thread). Any value changes may have not have immediate effect, or -may cause silence or diminished-quality version of the output until background -processing is finished. Ports having this property are typically not well -suited for connection to outputs of other plugins, and should not be offered as -connection targets or for automation by default. -""" . + rdfs:comment """Input ports only. Indicates that any changes to the port value may trigger expensive background calculation (e.g. regenerate some lookup tables in a background thread). Any value changes may have not have immediate effect, or may cause silence or diminished-quality version of the output until background processing is finished. Ports having this property are typically not well suited for connection to outputs of other plugins, and should not be offered as connection targets or for automation by default.""" . pprops:causesArtifacts a lv2:PortProperty ; rdfs:label "changes cause artifacts" ; - rdfs:comment """ -Input ports only. Indicates that any changes to the port value may produce -slight artifacts to produced audio signals (zipper noise and other results of -signal discontinuities). Connecting ports of this type to continuous signals -is not recommended, and when presenting a list of automation targets, those -ports may be marked as artifact-producing. -""" . + rdfs:comment """Input ports only. Indicates that any changes to the port value may produce slight artifacts to produced audio signals (zipper noise and other results of signal discontinuities). Connecting ports of this type to continuous signals is not recommended, and when presenting a list of automation targets, those ports may be marked as artifact-producing.""" . pprops:continuousCV a lv2:PortProperty ; rdfs:label "smooth modulation signal" ; - rdfs:comment """ -Indicates that the port carries a "smooth" modulation signal. Control input -ports of this type are well-suited for being connected to sources of smooth -signals (knobs with smoothing, modulation rate oscillators, output ports with -continuousCV type, etc.). Typically, the plugin with ports which have this -property will implement appropriate smoothing to avoid audio artifacts. For -output ports, this property suggests the value of the port is likely to change -frequently, and describes a smooth signal (e.g. successive values may be -considered points along a curve). -""" . + rdfs:comment """Indicates that the port carries a "smooth" modulation signal. Control input ports of this type are well-suited for being connected to sources of smooth signals (knobs with smoothing, modulation rate oscillators, output ports with continuousCV type, etc.). Typically, the plugin with ports which have this property will implement appropriate smoothing to avoid audio artifacts. For output ports, this property suggests the value of the port is likely to change frequently, and describes a smooth signal (e.g. successive values may be considered points along a curve).""" . pprops:discreteCV a lv2:PortProperty ; rdfs:label "discrete modulation signal" ; - rdfs:comment """ -Indicates that the port carries a "discrete" modulation signal. Input ports of -this type are well-suited for being connected to sources of discrete signals -(switches, buttons, classifiers, event detectors, etc.). May be combined with -pprops:trigger property. For output ports, this property suggests the value of -the port describe discrete values that should be interpreted as steps (and not -points along a curve). -""" . + rdfs:comment """Indicates that the port carries a "discrete" modulation signal. Input ports of this type are well-suited for being connected to sources of discrete signals (switches, buttons, classifiers, event detectors, etc.). May be combined with pprops:trigger property. For output ports, this property suggests the value of the port describe discrete values that should be interpreted as steps (and not points along a curve).""" . pprops:logarithmic a lv2:PortProperty ; rdfs:label "logarithmic scale" ; - rdfs:comment """ -Indicates that port value behaviour within specified range (bounds) is a value -using logarithmic scale. The lower and upper bounds must be specified, and -must be of the same sign. -""" . + rdfs:comment """Indicates that port value behaviour within specified range (bounds) is a value using logarithmic scale. The lower and upper bounds must be specified, and must be of the same sign.""" . pprops:notAutomatic a lv2:PortProperty ; rdfs:label "not intended as a CV input" ; - rdfs:comment """ -Indicates that the port is not primarily intended to be fed with modulation -signals from external sources (other plugins, etc.). It is merely a UI hint -and hosts may allow the user to override it. -""" . + rdfs:comment """Indicates that the port is not primarily intended to be fed with modulation signals from external sources (other plugins, etc.). It is merely a UI hint and hosts may allow the user to override it.""" . pprops:notOnGUI a lv2:PortProperty ; rdfs:label "not on GUI" ; - rdfs:comment """ -Indicates that the port is not primarily intended to be represented by a -separate control in the user interface window (or any similar mechanism used -for direct, immediate control of control ports). It is merely a UI hint and -hosts may allow the user to override it. -""" . + rdfs:comment """Indicates that the port is not primarily intended to be represented by a separate control in the user interface window (or any similar mechanism used for direct, immediate control of control ports). It is merely a UI hint and hosts may allow the user to override it.""" . pprops:displayPriority a rdf:Property ; rdfs:domain lv2:Port ; rdfs:range xsd:nonNegativeInteger ; rdfs:label "display priority" ; - rdfs:comment """ -Indicates how important a port is to controlling the plugin. If a host can -only display some ports of a plugin, it should prefer ports with a higher -display priority. Priorities do not need to be unique, and are only meaningful -when compared to each other. -""" . + rdfs:comment """Indicates how important a port is to controlling the plugin. If a host can only display some ports of a plugin, it should prefer ports with a higher display priority. Priorities do not need to be unique, and are only meaningful when compared to each other.""" . pprops:rangeSteps a rdf:Property ; diff --git a/lv2/lv2plug.in/ns/ext/presets/presets.ttl b/lv2/lv2plug.in/ns/ext/presets/presets.ttl index 7ceb39b..da7e9bb 100644 --- a/lv2/lv2plug.in/ns/ext/presets/presets.ttl +++ b/lv2/lv2plug.in/ns/ext/presets/presets.ttl @@ -91,10 +91,7 @@ pset:value a rdf:Property ; rdfs:domain lv2:Port ; rdfs:label "value" ; - rdfs:comment """ -Specifies the value of a Port on some Preset. This property is used -in a similar way to e.g. lv2:default. -""" . + rdfs:comment """Specifies the value of a Port on some Preset. This property is used in a similar way to e.g. lv2:default.""" . pset:preset a rdf:Property ; -- cgit v1.2.1