Browse Source

Fix HTML character entities in documentation

Not all of these actually show up in the output, but it's unnecessary to use
these in Markdown anyway.
zrythm_meson
David Robillard 2 years ago
parent
commit
f207706a7c
  1. 8
      lv2/atom/atom.meta.ttl
  2. 11
      lv2/core/lv2core.meta.ttl
  3. 4
      lv2/event/event.meta.ttl
  4. 4
      lv2/options/options.meta.ttl
  5. 16
      lv2/patch/patch.meta.ttl
  6. 11
      lv2/presets/presets.meta.ttl
  7. 8
      lv2/state/state.meta.ttl
  8. 4
      lv2/units/units.meta.ttl
  9. 4
      lv2/worker/worker.meta.ttl

8
lv2/atom/atom.meta.ttl

@ -214,8 +214,8 @@ string in any language or a value of any type. A Literal has a @@ -214,8 +214,8 @@ string in any language or a value of any type. A Literal has a
encoding. The length of the string data in bytes is `size -
sizeof(LV2_Atom_Literal)`, including the terminating NULL character. The
`lang` field SHOULD be a URI of the form
<http://lexvo.org/id/iso639-3/LANG> or
<http://lexvo.org/id/iso639-1/LANG> where LANG is a 3-character ISO 693-3
`http://lexvo.org/id/iso639-3/LANG` or
`http://lexvo.org/id/iso639-1/LANG` where LANG is a 3-character ISO 693-3
language code, or a 2-character ISO 693-1 language code, respectively.
A Literal may have a `datatype` or a `lang`, but never both.
@ -484,7 +484,7 @@ MUST be a sub-class of atom:Atom. For example, an input port that is connected @@ -484,7 +484,7 @@ MUST be a sub-class of atom:Atom. For example, an input port that is connected
directly to an LV2_Atom_Double value is described like so:
:::turtle
<plugin>
<plugin>
lv2:port [
a lv2:InputPort , atom:AtomPort ;
atom:bufferType atom:Double ;
@ -508,7 +508,7 @@ expected by a port. For example, a port that receives MIDI events is described @@ -508,7 +508,7 @@ expected by a port. For example, a port that receives MIDI events is described
like so:
:::turtle
&lt;plugin&gt;
<plugin>
lv2:port [
a lv2:InputPort , atom:AtomPort ;
atom:bufferType atom:Sequence ;

11
lv2/core/lv2core.meta.ttl

@ -323,8 +323,7 @@ LV2 specifications are documented using this property with an lv2:Markdown @@ -323,8 +323,7 @@ LV2 specifications are documented using this property with an lv2:Markdown
datatype.
If the value has no explicit datatype, it is assumed to be a valid XHTML Basic
1.1 fragment suitable for use as the content of the <code>&lt;body&gt;</code>
element of a page.
1.1 fragment suitable for use as the content of the `body` element of a page.
XHTML Basic is a W3C Recommendation which defines a simplified subset of XHTML
intended to be reasonable to implement with limited resources, for exampe on
@ -350,7 +349,7 @@ To be discovered by hosts, plugins MUST explicitly have an rdf:type of lv2:Plugi @@ -350,7 +349,7 @@ To be discovered by hosts, plugins MUST explicitly have an rdf:type of lv2:Plugi
in their bundle's manifest, for example:
:::turtle
&lt;http://example.org/my-plugin&gt; a lv2:Plugin .
<http://example.org/my-plugin> a lv2:Plugin .
Plugins should have a doap:name property that is at most a few words in length
using title capitalization, for example <q>Tape Delay Unit</q>.
@ -548,10 +547,10 @@ SHOULD specify this in their `manifest.ttl` so the host can associate them with @@ -548,10 +547,10 @@ SHOULD specify this in their `manifest.ttl` so the host can associate them with
the correct plugin. For example:
:::turtle
&lt;thing&gt;
<thing>
a ext:Thing ;
lv2:appliesTo &lt;plugin&gt; ;
rdfs:seeAlso &lt;thing.ttl&gt; .
lv2:appliesTo <plugin> ;
rdfs:seeAlso <thing.ttl> .
Using this pattern is preferable for large amounts of data, since the host may
choose whether/when to load the data.

4
lv2/event/event.meta.ttl

@ -109,11 +109,11 @@ OSC, or any other type of event payload. The type(s) of event supported by @@ -109,11 +109,11 @@ OSC, or any other type of event payload. The type(s) of event supported by
a port is defined in the data file for a plugin, for example:
:::turtle
&lt;http://example.org/some-plugin&gt;
<http://example.org/some-plugin>
lv2:port [
a ev:EventPort, lv2:InputPort ;
lv2:index 0 ;
ev:supportsEvent &lt;http://lv2plug.in/ns/ext/midi#MidiEvent&gt; ;
ev:supportsEvent <http://lv2plug.in/ns/ext/midi#MidiEvent> ;
lv2:symbol "midi_input" ;
lv2:name "MIDI input" ;
] .

4
lv2/options/options.meta.ttl

@ -83,9 +83,9 @@ plugins only, and is not a <q>live</q> plugin control mechanism. @@ -83,9 +83,9 @@ plugins only, and is not a <q>live</q> plugin control mechanism.
The plugin data file should advertise this interface like so:
:::turtle
@prefix opts: &lt;http://lv2plug.in/ns/ext/options#&gt; .
@prefix opts: <http://lv2plug.in/ns/ext/options#> .
&lt;plugin&gt;
<plugin>
a lv2:Plugin ;
lv2:extensionData opts:interface .

16
lv2/patch/patch.meta.ttl

@ -222,7 +222,7 @@ remove all properties with the given predicate. For example: @@ -222,7 +222,7 @@ remove all properties with the given predicate. For example:
:::turtle
[]
a patch:Patch ;
patch:subject &lt;something&gt; ;
patch:subject <something> ;
patch:add [
eg:name "New name" ;
eg:age 42 ;
@ -244,7 +244,7 @@ previous version is replaced. @@ -244,7 +244,7 @@ previous version is replaced.
:::turtle
[]
a patch:Put ;
patch:subject &lt;something&gt; ;
patch:subject <something> ;
patch:body [
eg:name "New name" ;
eg:age 42 ;
@ -273,7 +273,7 @@ the property before setting the new value. For example: @@ -273,7 +273,7 @@ the property before setting the new value. For example:
:::turtle
[]
a patch:Set ;
patch:subject &lt;something&gt; ;
patch:subject <something> ;
patch:property eg:name ;
patch:value "New name" .
@ -282,7 +282,7 @@ Which is equivalent to: @@ -282,7 +282,7 @@ Which is equivalent to:
:::turtle
[]
a patch:Patch ;
patch:subject &lt;something&gt; ;
patch:subject <something> ;
patch:add [
eg:name "New name" ;
] ;
@ -357,10 +357,10 @@ This is used to list properties that can be changed, for example to allow user @@ -357,10 +357,10 @@ This is used to list properties that can be changed, for example to allow user
interfaces to present appropriate controls. For example:
:::turtle
@prefix eg: &lt;http://example.org/&gt; .
@prefix rdf: &lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#&gt; .
@prefix rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt; .
@prefix xsd: &lt;http://www.w3.org/2001/XMLSchema#&gt; .
@prefix eg: <http://example.org/> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
eg:title
a rdf:Property ;

11
lv2/presets/presets.meta.ttl

@ -78,7 +78,7 @@ bundle containing presets should list them like so: @@ -78,7 +78,7 @@ bundle containing presets should list them like so:
eg:mypreset
a pset:Preset ;
lv2:appliesTo eg:myplugin ;
rdfs:seeAlso &lt;mypreset.ttl&gt; .
rdfs:seeAlso <mypreset.ttl> .
"""^^lv2:Markdown .
@ -90,7 +90,7 @@ predicates can be used to describe any data associated with the preset. For @@ -90,7 +90,7 @@ predicates can be used to describe any data associated with the preset. For
example:
:::turtle
@prefix eg: &lt;http://example.org/&gt; .
@prefix eg: <http://example.org/> .
eg:mypreset
a pset:Preset ;
@ -108,10 +108,9 @@ A Preset SHOULD have at least one lv2:appliesTo property. Each Port on a @@ -108,10 +108,9 @@ 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.
Hosts SHOULD save user presets to a bundle in the user-local LV2 directory (for
example `~/.lv2`) with a name like
`&lt;Plugin_Name&gt;_&lt;Preset_Name&gt;.preset.lv2` (for example
`LV2_Amp_At_Eleven.preset.lv2`), where names are transformed to be valid LV2
symbols for maximum compatibility.
example `~/.lv2`) with a name like `<Plugin_Name>_<Preset_Name>.preset.lv2`
(for example `LV2_Amp_At_Eleven.preset.lv2`), where names are transformed to be
valid LV2 symbols for maximum compatibility.
"""^^lv2:Markdown .

8
lv2/state/state.meta.ttl

@ -301,9 +301,9 @@ when it is called with URI LV2_STATE__interface. @@ -301,9 +301,9 @@ when it is called with URI LV2_STATE__interface.
The plugin data file should describe this like so:
:::turtle
@prefix state: &lt;http://lv2plug.in/ns/ext/state#&gt; .
@prefix state: <http://lv2plug.in/ns/ext/state#> .
&lt;plugin&gt;
<plugin>
a lv2:Plugin ;
lv2:extensionData state:interface .
@ -338,9 +338,9 @@ state:state @@ -338,9 +338,9 @@ state:state
This property may be used anywhere a state needs to be described, for example:
:::turtle
@prefix eg: &lt;http://example.org/&gt; .
@prefix eg: <http://example.org/> .
&lt;plugin-instance&gt;
<plugin-instance>
state:state [
eg:somekey "some value" ;
eg:someotherkey "some other value" ;

4
lv2/units/units.meta.ttl

@ -117,8 +117,8 @@ processing. @@ -117,8 +117,8 @@ processing.
For example, to say that a gain control is in decibels:
:::turtle
@prefix units: &lt;http://lv2plug.in/ns/extensions/units#&gt; .
@prefix eg: &lt;http://example.org/&gt; .
@prefix units: <http://lv2plug.in/ns/extensions/units#> .
@prefix eg: <http://example.org/> .
eg:plugin lv2:port [
a lv2:ControlPort , lv2:InputPort ;

4
lv2/worker/worker.meta.ttl

@ -59,9 +59,9 @@ The work interface provided by a plugin, LV2_Worker_Interface. @@ -59,9 +59,9 @@ The work interface provided by a plugin, LV2_Worker_Interface.
:::turtle
@prefix work: &lt;http://lv2plug.in/ns/ext/worker#&gt; .
@prefix work: <http://lv2plug.in/ns/ext/worker#> .
&lt;plugin&gt;
<plugin>
a lv2:Plugin ;
lv2:extensionData work:interface .

Loading…
Cancel
Save