From 430284545345539c9ffb31df889debac1d3888b5 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 22 Mar 2020 16:36:44 +0100 Subject: Move documentation to metadata files and convert it to Markdown --- lv2/data-access/data-access.meta.ttl | 20 +++++++++++++++++++- lv2/data-access/data-access.ttl | 19 +++---------------- 2 files changed, 22 insertions(+), 17 deletions(-) (limited to 'lv2/data-access') diff --git a/lv2/data-access/data-access.meta.ttl b/lv2/data-access/data-access.meta.ttl index e9fd6da..1b8c552 100644 --- a/lv2/data-access/data-access.meta.ttl +++ b/lv2/data-access/data-access.meta.ttl @@ -1,6 +1,8 @@ +@prefix da: . @prefix dcs: . @prefix doap: . @prefix foaf: . +@prefix lv2: . @prefix rdfs: . @@ -55,5 +57,21 @@ rdfs:label "Initial release." ] ] - ] . + ] ; + lv2:documentation """ + +This extension defines a feature, LV2_Extension_Data_Feature, which provides +access to LV2_Descriptor::extension_data() for plugin UIs or other potentially +remote users of a plugin. + +Note that the use of this extension by UIs violates the important principle of +UI/plugin separation, and is potentially a source of many problems. +Accordingly, **use of this extension is highly discouraged**, and plugins +should not expect hosts to support it, since it is often impossible to do so. + +To support this feature the host must pass an LV2_Feature struct to +LV2_Descriptor::extension_data() with URI LV2_DATA_ACCESS_URI and data pointed +to an instance of LV2_Extension_Data_Feature. + +"""^^lv2:Markdown . diff --git a/lv2/data-access/data-access.ttl b/lv2/data-access/data-access.ttl index d638d3a..c06d3ce 100644 --- a/lv2/data-access/data-access.ttl +++ b/lv2/data-access/data-access.ttl @@ -5,21 +5,8 @@ a lv2:Feature , lv2:Specification ; + rdfs:label "data access" ; + rdfs:comment "A feature that provides access to plugin extension data." ; rdfs:seeAlso , - ; - lv2:documentation """ -

This extension defines a feature, LV2_Extension_Data_Feature, which provides -access to LV2_Descriptor::extension_data() for plugin UIs or other potentially -remote users of a plugin.

- -

Note that the use of this extension by UIs violates the important principle -of UI/plugin separation, and is potentially a source of many problems. -Accordingly, use of this extension is highly discouraged, and -plugins should not expect hosts to support it, since it is often impossible to -do so.

- -

To support this feature the host must pass an LV2_Feature struct to the -instantiate method with URI LV2_DATA_ACCESS_URI and data pointed to an instance -of LV2_Extension_Data_Feature.

-""" . + . -- cgit v1.2.1