From db32487a23a07dcf62686480aa8642c4795f3787 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Mon, 14 Nov 2011 01:23:22 +0000 Subject: Make all lv2:documentation valid XHTML Basic 1.1. Validate lv2:documentation in lv2specgen (if lxml is available). --- ext/atom.lv2/atom.ttl | 62 ++++++++++++++++++------------------- ext/contexts.lv2/contexts.ttl | 10 +++--- ext/cv-port.lv2/cv-port.ttl | 20 ++++++------ ext/midi.lv2/midi.ttl | 8 ++--- ext/parameter.lv2/parameter.ttl | 8 ++--- ext/pui-event.lv2/pui-event.ttl | 4 +-- ext/pui-gtk.lv2/pui-gtk.ttl | 4 +-- ext/pui.lv2/pui.ttl | 6 ++-- ext/reference.lv2/reference.ttl | 6 ++-- ext/state.lv2/state.ttl | 19 ++++++------ ext/string-port.lv2/string-port.ttl | 40 ++++++++++++------------ ext/time.lv2/time.ttl | 4 +-- ext/uri-unmap.lv2/uri-unmap.ttl | 10 +++--- ext/urid.lv2/urid.ttl | 26 ++++++++-------- 14 files changed, 113 insertions(+), 114 deletions(-) (limited to 'ext') diff --git a/ext/atom.lv2/atom.ttl b/ext/atom.lv2/atom.ttl index e49c544..f01100a 100644 --- a/ext/atom.lv2/atom.ttl +++ b/ext/atom.lv2/atom.ttl @@ -168,9 +168,9 @@ atom:URID rdfs:label "Integer ID mapped from a URI" ; atom:cType "LV2_Atom_ID" ; lv2:documentation """ -An unsigned 32-bit integer mapped from a URI using the An unsigned 32-bit integer mapped from a URI using the URI Map extension's -LV2_URI_Map_Feature::uri_to_id() with map = NULL. +LV2_URI_Map_Feature::uri_to_id() with map = NULL.

""" . atom:BlankID @@ -179,10 +179,10 @@ atom:BlankID rdfs:label "Integer ID for a blank node" ; atom:cType "LV2_Atom_ID" ; lv2:documentation """ -An unsigned 32-bit integer identifier for a blank node. A BlankID is only +

An unsigned 32-bit integer identifier for a blank node. A BlankID is only meaningful within a limited scope (e.g. the Atom in which it appears), and MUST NOT be used as a global identifier. In particular, a BlankID is NOT a -URID, and can not be mapped to/from a URI. +URID, and can not be mapped to/from a URI.

""" . atom:Vector @@ -255,8 +255,8 @@ atom:Resource rdfs:subClassOf atom:Thing ; atom:cType "LV2_Thing" ; lv2:documentation """ -An atom:Thing where id is the URI of the resource mapped to an -atom:URID. +

An atom:Thing where id is the URI of the resource mapped to an +atom:URID.

""" . atom:Blank @@ -264,10 +264,10 @@ atom:Blank rdfs:subClassOf atom:Thing ; atom:cType "LV2_Thing" ; lv2:documentation """ -An atom:Thing where id is the blank node ID of the object, which -is only meaningful within a certain limited scope (e.g. the container of the -Blank) and MUST NOT be used as a global ID. In particular, id is -NOT an ID. +

An atom:Thing where id is the blank node ID of the object, +which is only meaningful within a certain limited scope (e.g. the container of +the Blank) and MUST NOT be used as a global ID. In particular, id +is NOT an ID.

""" . atom:Message @@ -275,12 +275,12 @@ atom:Message rdfs:subClassOf atom:Thing ; atom:cType "LV2_Thing" ; lv2:documentation """ -A atom:Thing where id is a message type ID. Conceptually, -a Message is identical to a Blank, but is a distinct type with a single type -field to allow simple and fast dispatch by handling code. +

A atom:Thing where id is a message type ID. Conceptually, a +Message is identical to a Blank, but is a distinct type with a single type +field to allow simple and fast dispatch by handling code.

-A Message may be serialised as a Blank by adding an rdf:type property with the -value id unmapped to a URI. +

A Message may be serialised as a Blank by adding an rdf:type property with +the value id unmapped to a URI.

""" . atom:Event @@ -288,8 +288,8 @@ atom:Event rdfs:label "Event" ; atom:cType "LV2_Atom_Event" ; lv2:documentation """ -An atom with a time stamp header prepended, typically for sample accurate -transmission via LV2 ports. See struct LV2_Atom_Event. +

An atom with a time stamp header prepended, typically for sample accurate +transmission via LV2 ports. See struct LV2_Atom_Event.

""" . atom:Bang @@ -336,10 +336,10 @@ atom:blobSupport a lv2:Feature ; rdfs:label "Blob support" ; lv2:documentation """ -Support for dynamically allocated blobs. If a host supports this feature, it -MUST pass a LV2_Feature with URI +

Support for dynamically allocated blobs. If a host supports this feature, +it MUST pass a LV2_Feature with URI http://lv2plug.in/ns/ext/atom#blobSupport and data pointing to a -LV2_Blob_Support. +LV2_Blob_Support.

""" . atom:AtomPort @@ -369,8 +369,8 @@ atom:ValuePort rdfs:subClassOf atom:AtomPort ; rdfs:label "Value Port" ; lv2:documentation """ -An AtomPort that interprets its data as a persistent and time-independent -"value". +

An AtomPort that interprets its data as a persistent and time-independent +"value".

-Value ports can be thought of as purely functional ports: if a plugin -callback has only value ports, then the plugin callback is a pure function. +

Value ports can be thought of as purely functional ports: if a plugin +callback has only value ports, then the plugin callback is a pure function.

""" . atom:MessagePort @@ -414,12 +414,12 @@ atom:EventPort rdfs:label "Event port" ; rdfs:subClassOf lv2:Port ; lv2:documentation """ -A port used for communicating time-stamped atoms in the audio context. Ports -of this type are connected to an LV2_Atom_Buffer, which contains a flat -time-stamped sequence of atom:Event. +

A port used for communicating time-stamped atoms in the audio context. +Ports of this type are connected to an LV2_Atom_Buffer, which contains a flat +time-stamped sequence of atom:Event.

-This port type is intended as a simpler and atom compatible successor to ev:EventPort. +

This port type is intended as a simpler and atom compatible successor to ev:EventPort.

""" . atom:supports @@ -428,8 +428,8 @@ atom:supports rdfs:range atom:Atom ; rdfs:label "supports" ; lv2:documentation """ -Indicates that a Port supports a certain atom:Atom type. This is distinct from +

Indicates that a Port supports a certain atom:Atom type. This is distinct from the port type - e.g. the port type ValuePort can hold atoms with many different types. This property is used to describe which Atom types a Port expects to -receive or send. +receive or send.

""" . diff --git a/ext/contexts.lv2/contexts.ttl b/ext/contexts.lv2/contexts.ttl index 1290b3d..c56c649 100644 --- a/ext/contexts.lv2/contexts.ttl +++ b/ext/contexts.lv2/contexts.ttl @@ -96,10 +96,10 @@ ctx:audioContext a ctx:Context , lv2:Feature ; ctx:messageContext a ctx:Context , lv2:Feature ; lv2:documentation """ -A non-realtime context for plugin control via message passing. This context +

A non-realtime context for plugin control via message passing. This context has a run method which takes a bitset of flags for parameters specifying which input and output ports are valid before and after the run method has executed, -respectively (see LV2_Contexts_MessageContext). +respectively (see LV2_Contexts_MessageContext).

""" . ctx:idleContext a ctx:Context , lv2:Feature ; @@ -110,10 +110,10 @@ This context never has any ports. ctx:requestRunFeature a lv2:Feature ; lv2:documentation """ -A feature allowing the plugin to request the execution of a particular context -at an arbitrary time. To support this feature, the host MUST pass an +

A feature allowing the plugin to request the execution of a particular +context at an arbitrary time. To support this feature, the host MUST pass an LV2_Feature to instantiate with data pointing to a -LV2_Contexts_Request_Run_Feature. +LV2_Contexts_Request_Run_Feature.

The plugin MAY call request_run with the given data from any non-realtime context to demand soon-as-possible execution diff --git a/ext/cv-port.lv2/cv-port.ttl b/ext/cv-port.lv2/cv-port.ttl index d751692..f49024b 100644 --- a/ext/cv-port.lv2/cv-port.ttl +++ b/ext/cv-port.lv2/cv-port.ttl @@ -32,15 +32,13 @@ rdfs:seeAlso ] ; lv2:documentation """ - -This extension defines Control Voltage (CV) ports, which are audio-rate control -ports like those used on classical voltage-controlled synthesizers. These -ports serve as control ports like This extension defines Control Voltage (CV) ports, which are audio-rate +control ports like those used on classical voltage-controlled synthesizers. +These ports serve as control ports like lv2:ControlPort but can also be used for audio-rate modulation of control signals. This enables many types of processing and synthesis which are not possible with a lower control -rate. - +rate.

""" . cv:CVPort @@ -49,7 +47,7 @@ cv:CVPort rdfs:subClassOf lv2:Port ; lv2:documentation """ -Ports of this type have identical semantics to Ports of this type have identical semantics to lv2:AudioPort in terms of buffer format and connection/input/output logistics. However, rather than the buffer representing audio, the buffer represents audio-rate control data. A @@ -58,12 +56,12 @@ href="http://lv2plug.in/ns/lv2core#ControlPort">lv2:ControlPort typically has to describe appropriate control values (e.g. lv2:minimum, lv2:maximum, lv2:default) +href="http://lv2plug.in/ns/lv2core#default">lv2:default)

-Hosts SHOULD take care to prevent data from a CVPort port from being used as -audio except in cases where this is known to be safe. +

Hosts SHOULD take care to prevent data from a CVPort port from being used as +audio except in cases where this is known to be safe.

-Example: +

Example:

 <http://example.org/some-plugin>
     lv2:port [
diff --git a/ext/midi.lv2/midi.ttl b/ext/midi.lv2/midi.ttl
index cbd80c3..bf293d1 100644
--- a/ext/midi.lv2/midi.ttl
+++ b/ext/midi.lv2/midi.ttl
@@ -43,11 +43,11 @@
 		foaf:mbox 
 	] ;
     lv2:documentation """
-This extension defines a data type for a MIDI message, midi:MidiEvent, which is
-normalized for fast and convenient processing by plugins.  It is particularly
-useful as the payload of an This extension defines a data type for a MIDI message, midi:MidiEvent, which
+is normalized for fast and convenient processing by plugins.  It is
+particularly useful as the payload of an Atom or Event.
+href="http://lv2plug.in/ns/ext/event#Event">Event.

 """ .
 
 midi:MidiEvent
diff --git a/ext/parameter.lv2/parameter.ttl b/ext/parameter.lv2/parameter.ttl
index f136ad9..191aa81 100644
--- a/ext/parameter.lv2/parameter.ttl
+++ b/ext/parameter.lv2/parameter.ttl
@@ -68,10 +68,10 @@ param:supportsType a rdf:Property ;
     rdfs:range   atom:AtomType ;
     rdfs:label   "supports type" ;
     lv2:documentation """
-Indicates that a Parameter has values of a particular type.  A Parameter
-may support many types.  Parameter values are always LV2 Atoms as defined
-by the LV2 Atom Extension
-Any type of LV2 Atom may be used as a parameter value.
+
Indicates that a Parameter has values of a particular type.  A Parameter may
+support many types.  Parameter values are always LV2 Atoms as defined by the LV2 Atom Extension Any type of LV2
+Atom may be used as a parameter value.

 """ .
 
 
diff --git a/ext/pui-event.lv2/pui-event.ttl b/ext/pui-event.lv2/pui-event.ttl
index 031b9e5..2a4bdb3 100644
--- a/ext/pui-event.lv2/pui-event.ttl
+++ b/ext/pui-event.lv2/pui-event.ttl
@@ -49,8 +49,8 @@
 		foaf:mbox ;
 	];
 	lv2:documentation """
-This extension defines an pui:PortProtocol for passing events (MIDI, OSC,
-etc.) between LV2 plugins and UIs.
+
This extension defines an pui:PortProtocol for passing events (MIDI, OSC,
+etc.) between LV2 plugins and UIs.

 """.
 
 puiev:events a pui:PortProtocol;
diff --git a/ext/pui-gtk.lv2/pui-gtk.ttl b/ext/pui-gtk.lv2/pui-gtk.ttl
index 63c8417..3af016e 100644
--- a/ext/pui-gtk.lv2/pui-gtk.ttl
+++ b/ext/pui-gtk.lv2/pui-gtk.ttl
@@ -44,8 +44,8 @@
 		foaf:mbox ;
 	];
 	lv2:documentation """
-This extension defines an UI type for the in-process UI extension that can be
-used in a Gtk+ program.
+
This extension defines an UI type for the in-process UI extension that can
+be used in a Gtk+ program.

 """.
 
 gtkui:GtkUI a rdfs:Class;
diff --git a/ext/pui.lv2/pui.ttl b/ext/pui.lv2/pui.ttl
index 98db919..2d3a373 100644
--- a/ext/pui.lv2/pui.ttl
+++ b/ext/pui.lv2/pui.ttl
@@ -86,9 +86,9 @@ instance.

 code and the process that loads the shared object file containing the actual
 plugin implementation do not have to be the same. There are many valid reasons
 for having the plugin and the UI in different processes, or even on different
-machines. This means that you can not use singletons and global
-variables and expect them to refer to the same objects in the UI and the actual
-plugin. The function callback interface defined in the header pui.h is
+machines. This means that you can not use singletons and
+global variables and expect them to refer to the same objects in the UI and the
+actual plugin. The function callback interface defined in the header pui.h is
 all you can expect to work.

 """.
 
diff --git a/ext/reference.lv2/reference.ttl b/ext/reference.lv2/reference.ttl
index 6d5870f..1e030ee 100644
--- a/ext/reference.lv2/reference.ttl
+++ b/ext/reference.lv2/reference.ttl
@@ -61,10 +61,10 @@ a plugin, except via functions provided by the host in LV2_Blob_Support.

 reference:blobSupport a lv2:Feature ;
 	rdfs:label "Blob support" ;
 	lv2:documentation """
-Support for dynamically allocated blobs.  If a host supports this feature, it
-MUST pass a LV2_Feature with URI
+
Support for dynamically allocated blobs.  If a host supports this feature,
+it MUST pass a LV2_Feature with URI
 http://lv2plug.in/ns/ext/atom#blobSupport and data pointing to a
-LV2_Blob_Support.
+LV2_Blob_Support.

 """ .
 
 reference:Blob a rdfs:Class ;
diff --git a/ext/state.lv2/state.ttl b/ext/state.lv2/state.ttl
index 9d8305e..1d85bd3 100644
--- a/ext/state.lv2/state.ttl
+++ b/ext/state.lv2/state.ttl
@@ -177,12 +177,13 @@ state:Interface
     a rdfs:Class ;
     rdfs:subClassOf lv2:ExtensionData ;
     lv2:documentation """
-A structure (LV2_State_Interface) which contains functions to be called by the
-host to save and restore state.  In order to support this extension, the plugin
-must return a valid LV2_State_Interface from LV2_Descriptor::extension_data()
-when it is called with URI "http://lv2plug.in/ns/ext/state#StateInterface".
+
A structure (LV2_State_Interface) which contains functions to be called by
+the host to save and restore state.  In order to support this extension, the
+plugin must return a valid LV2_State_Interface from
+LV2_Descriptor::extension_data() when it is called with URI
+"http://lv2plug.in/ns/ext/state#StateInterface".

 
-The plugin data file should describe this like so:
+
The plugin data file should describe this like so:

 
 @prefix state: <http://lv2plug.in/ns/ext/state#> .
 
@@ -210,11 +211,11 @@ state:instanceState
     a rdf:Property ;
     rdfs:range state:InstanceState ;
     lv2:documentation """
-Predicate to relate a plugin instance to an InstanceState. This may be used
+
Predicate to relate a plugin instance to an InstanceState. This may be used
 wherever the state of a particular plugin instance needs to be represented.
 Note that the domain of this property is unspecified, since LV2 does not define
 any RDF class for plugin instance. This predicate may be used wherever it makes
-sense to do so, e.g.:
+sense to do so, e.g.:

 
 @prefix eg: <http://example.org/> .
 
@@ -224,7 +225,7 @@ sense to do so, e.g.:
     eg:favourite-number 2
 ] .
 

-Note that this property is provided because it may be useful for hosts,
+
Note that this property is provided because it may be useful for hosts,
 plugins, or extensions that work with instance state, but its use is not
-required to support the LV2 State extension.
+required to support the LV2 State extension.

 """ .
diff --git a/ext/string-port.lv2/string-port.ttl b/ext/string-port.lv2/string-port.ttl
index 35cd594..f36fa7a 100644
--- a/ext/string-port.lv2/string-port.ttl
+++ b/ext/string-port.lv2/string-port.ttl
@@ -36,28 +36,28 @@
 		foaf:name "Krzysztof Foltman" ;
 	] ;
 	lv2:documentation """
-Defines ports which contain string data.
+
Defines ports which contain string data.

 
 
UI issues

-When using port_event / write_port (and possible other communication
+
When using port_event / write_port (and possible other communication
 mechanisms), the format parameter should contain the numeric value of URI
 LV2_STRING_PORT_URI (mapped with http://lv2plug.in/ns/extensions/ui specified
-as map URI).
+as map URI).

 
-It's probably possible to use ports belonging to message context
+
It's probably possible to use ports belonging to message context
 <http://lv2plug.in/ns/ext/contexts#MessageContext> for transfer. However,
-contexts mechanism does not offer any way to notify the message recipient
-about which ports have been changed. To remedy that, this extension defines
-a flag LV2_STRING_DATA_CHANGED_FLAG that carries that information inside a
-port value structure.
+contexts mechanism does not offer any way to notify the message recipient about
+which ports have been changed. To remedy that, this extension defines a flag
+LV2_STRING_DATA_CHANGED_FLAG that carries that information inside a port value
+structure.

 
 
Storage

-The value of string port are assumed to be "persistent": if a host saves
-and restores a state of a plugin (e.g. control port values), the values
-of input string ports should also be assumed to belong to that state. This
-also applies to message context: if a session is being restored, the host
-MUST resend the last value that was sent to the port before session has been
-saved. In other words, string port values "stick" to message ports.
+
The value of string port are assumed to be "persistent": if a host saves and
+restores a state of a plugin (e.g. control port values), the values of input
+string ports should also be assumed to belong to that state. This also applies
+to message context: if a session is being restored, the host MUST resend the
+last value that was sent to the port before session has been saved. In other
+words, string port values "stick" to message ports.

 """ .
 
 sp:StringTransfer a lv2:Feature ;
@@ -66,22 +66,22 @@ sp:StringTransfer a lv2:Feature ;
 sp:StringPort a lv2:Port ;
    rdfs:label "String port" ;
    lv2:documentation """
-Indicates that the port data points to a LV2_String_Data structure
-as defined in accompanying header file.
+
Indicates that the port data points to a LV2_String_Data structure
+as defined in accompanying header file.

 
 
Input Port Semantics

-If the port does not have a context specified (it runs in the default,
+
If the port does not have a context specified (it runs in the default,
 realtime audio processing context), the values in the structure and the actual
 string data MUST remain unchanged for the time a run() function of a plugin
 is executed. However, if the port belongs to a different context, the same
 data MUST remain unchanged only for the time a run() or message_process()
-function of a given context is executed.
+function of a given context is executed.

 
 
Output Port Semantics

-The plugin may only change the string or length in a run() function (if
+
The plugin may only change the string or length in a run() function (if
 the port belongs to default context) or in context-defined counterparts
 (if the port belongs to another context). Because of that, using default
-context output string ports is contraindicated for longer strings.
+context output string ports is contraindicated for longer strings.

 """ .
 
 sp:default a rdf:Property ;
diff --git a/ext/time.lv2/time.ttl b/ext/time.lv2/time.ttl
index 4823d07..40bfdbb 100644
--- a/ext/time.lv2/time.ttl
+++ b/ext/time.lv2/time.ttl
@@ -42,10 +42,10 @@ time:Position
 	a rdfs:Class ;
 	rdfs:label "LV2 time position" ;
 	lv2:documentation """
-Type for an LV2_Time_Position struct.  This can be mapped to an integer and
+
Type for an LV2_Time_Position struct.  This can be mapped to an integer and
 used as the type field of an event to indicate that the event payload is an
 LV2_Time_Positon struct.  Plugins SHOULD indicate that a port supports time
-information using the ev:supports predicate, e.g.:
+information using the ev:supports predicate, e.g.:

 
 <plugin> lv2:port [
     a lv2:InputPort , ev:EventPort ;
diff --git a/ext/uri-unmap.lv2/uri-unmap.ttl b/ext/uri-unmap.lv2/uri-unmap.ttl
index a55de8a..053bb37 100644
--- a/ext/uri-unmap.lv2/uri-unmap.ttl
+++ b/ext/uri-unmap.lv2/uri-unmap.ttl
@@ -38,9 +38,9 @@
 		rdfs:seeAlso 
 	] ;
     lv2:documentation """
-This extension is the opposite of the LV2 URI Map extension.  It allows the host to pass an id_to_uri function
-to the plugin which can be used for unmapping an integer (previously mapped using
-the URI map extension's uri_to_id) back to a string.
-""" .
+
This extension is the opposite of the LV2 URI Map extension.  It allows
+the host to pass an id_to_uri function to the plugin which can be used for
+unmapping an integer (previously mapped using the URI map extension's
+uri_to_id) back to a string.
""" .
 
diff --git a/ext/urid.lv2/urid.ttl b/ext/urid.lv2/urid.ttl
index 6b05071..a87b368 100644
--- a/ext/urid.lv2/urid.ttl
+++ b/ext/urid.lv2/urid.ttl
@@ -35,33 +35,33 @@
 		foaf:homepage 
 	] ;
 	lv2:documentation """
-This extension defines a simple mechanism for plugins to map URIs to and from
-integers, usually for performance reasons (e.g. processing events typed by URIs
-in real time).  Typically, plugins map URIs to integers for things they
+
This extension defines a simple mechanism for plugins to map URIs to and
+from integers, usually for performance reasons (e.g. processing events typed by
+URIs in real time).  Typically, plugins map URIs to integers for things they
 "understand" at instantiation time, and store those values for use in the audio
 thread without doing any string comparison.  This allows for the extensibility
-of RDF but with the performance of integers.
+of RDF but with the performance of integers.

 
-This extension is intended as an improved and simpler replacement for the
-uri-map extension, since the
-map context parameter has been found problematic.
+
This extension is intended as an improved and simpler replacement for the uri-map extension, since the
+map context parameter has been found problematic.

 """ .
 
 urid:map
 	a lv2:Feature ;
 	lv2:documentation """
-A feature which is used to map URIs to integers.  To support this feature, the
-host must pass an LV2_Feature to LV2_Descriptor::instantiate() with
-URI http://lv2plug.in/ns/ext/urid#map and data
-pointed to an instance of LV2_URID_Map.
+
A feature which is used to map URIs to integers.  To support this feature,
+the host must pass an LV2_Feature to LV2_Descriptor::instantiate() with
+URI http://lv2plug.in/ns/ext/urid#map and data pointed
+to an instance of LV2_URID_Map.

 """ .
 
 urid:unmap
 	a lv2:Feature ;
 	lv2:documentation """
-A feature which is used to unmap URIs previously mapped to integers by
+
A feature which is used to unmap URIs previously mapped to integers by
 urid:map.  To support this feature, the host must pass an LV2_Feature to
 LV2_Descriptor::instantiate() with URI
 http://lv2plug.in/ns/ext/urid#unmap and data pointed to an
-instance of LV2_URID_Unmap.
+instance of LV2_URID_Unmap.

 """ .
-- 
cgit v1.2.1