aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/urid
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/urid
parentc4514483da1ab4f49148f9c4fe4ff5b559323217 (diff)
downloadlv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/urid')
-rw-r--r--lv2/urid/urid.meta.ttl39
-rw-r--r--lv2/urid/urid.ttl33
2 files changed, 45 insertions, 27 deletions
diff --git a/lv2/urid/urid.meta.ttl b/lv2/urid/urid.meta.ttl
index d4e5fdc..b2a74fa 100644
--- a/lv2/urid/urid.meta.ttl
+++ b/lv2/urid/urid.meta.ttl
@@ -1,7 +1,9 @@
@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 rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix urid: <http://lv2plug.in/ns/ext/urid#> .
<http://lv2plug.in/ns/ext/urid>
a doap:Project ;
@@ -43,5 +45,40 @@
rdfs:label "Initial release."
]
]
- ] .
+ ] ;
+ lv2:documentation """
+
+This extension defines a simple mechanism for plugins to map URIs to and from
+integers. This is usually used for performance reasons, for example for
+processing events with URI types in real-time audio code). 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.
+
+This extension is intended as an improved and simplified replacement for the
+[uri-map](uri-map.html) extension, since the `map` context parameter there has
+proven problematic. This extension is functionally equivalent to the uri-map
+extension with a NULL context. New implementations are encouraged to use this
+extension for URI mapping.
+
+"""^^lv2:Markdown .
+
+urid:map
+ lv2:documentation """
+
+To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with URI LV2_URID__map and data pointed to an
+instance of LV2_URID_Map.
+
+"""^^lv2:Markdown .
+
+urid:unmap
+ lv2:documentation """
+
+To support this feature, the host must pass an LV2_Feature to
+LV2_Descriptor::instantiate() with URI LV2_URID__unmap and data pointed to an
+instance of LV2_URID_Unmap.
+
+"""^^lv2:Markdown .
diff --git a/lv2/urid/urid.ttl b/lv2/urid/urid.ttl
index d59a5ef..c3ae624 100644
--- a/lv2/urid/urid.ttl
+++ b/lv2/urid/urid.ttl
@@ -4,37 +4,18 @@
<http://lv2plug.in/ns/ext/urid>
a lv2:Specification ;
+ rdfs:label "LV2 URID" ;
+ rdfs:comment "Features for mapping URIs to and from integers." ;
rdfs:seeAlso <urid.h> ,
- <urid.meta.ttl> ;
- lv2:documentation """
-<p>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.</p>
-
-<p>This extension is intended as an improved and simplified replacement for the
-<a href="uri-map.html">uri-map</a> extension, since the <q>map</q>
-context parameter has been found problematic. This extension is functionally
-equivalent to the uri-map extension with a NULL context. New implementations
-are encouraged to use this extension for URI mapping.</p>
-""" .
+ <urid.meta.ttl> .
urid:map
a lv2:Feature ;
- lv2:documentation """
-<p>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
-LV2_URID__map and data pointed to an instance of LV2_URID_Map.</p>
-""" .
+ rdfs:label "map" ;
+ rdfs:comment "A feature to map URI strings to integer URIDs." .
urid:unmap
a lv2:Feature ;
- lv2:documentation """
-<p>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 LV2_URID__unmap and data pointed to
-an instance of LV2_URID_Unmap.</p>
-""" .
+ rdfs:label "unmap" ;
+ rdfs:comment "A feature to unmap URIDs back to strings." .