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/options/options.ttl | 78 ++++++------------------------------------------- 1 file changed, 9 insertions(+), 69 deletions(-) (limited to 'lv2/options/options.ttl') diff --git a/lv2/options/options.ttl b/lv2/options/options.ttl index 7f9ed44..c7fe77e 100644 --- a/lv2/options/options.ttl +++ b/lv2/options/options.ttl @@ -8,98 +8,38 @@ a owl:Ontology , lv2:Specification ; + rdfs:label "LV2 Options" ; + rdfs:comment "Runtime options for LV2 plugins and UIs." ; rdfs:seeAlso , - ; - lv2:documentation """ -

This extension defines a facility for options, which are dynamic -properties that may be changed at run time.

- -

There are two facilities for passing options to an instance: opts:options -allows passing options at instantiation time, and the opts:interface interface -allows options to be dynamically set and retrieved after instantiation.

- -

Note that this extension is only for allowing hosts to configure plugins, -and is not a live control mechanism. For real-time control, use -event-based control via an atom:AtomPort with an atom:Sequence buffer.

- -

Instances may indicate they require an option with the -opts:requiredOption property, or that they optionally support an option -with the opts:supportedOption property.

-""" . + . opts:Option a rdfs:Class ; rdfs:label "Option" ; rdfs:subClassOf rdf:Property ; - lv2:documentation """ -

A property intended to be used as a static option for an instance.

- -

It is not required for a property to explicitly be an Option in order to be -used as such. However, properties which are primarily intended for use as -options, or are at least particularly useful as options, should be explicitly -given this type for documentation purposes, and to assist hosts in discovering -option definitions.

-""" . + rdfs:comment "A value for a static option passed to an instance." . opts:interface a lv2:ExtensionData ; - lv2:documentation """ -

An interface (LV2_Options_Interface) for dynamically setting and getting -options. Note this is intended for use by the host for configuring plugins -only, and and is not a live plugin control mechanism.

- -

The plugin data file should describe this like so:

-
-@prefix opts: <http://lv2plug.in/ns/ext/options#> .
-
-<plugin>
-    a lv2:Plugin ;
-    lv2:extensionData opts:interface .
-
-""" . + rdfs:label "interface" ; + rdfs:comment "An interface for dynamically setting and getting options." . opts:options a lv2:Feature ; rdfs:label "options" ; - lv2:documentation """ -

The feature used to provide options to an instance.

- -

To implement this feature, hosts MUST pass an LV2_Feature to the appropriate -instantiate method with this URI and data pointed to an array of -LV2_Options_Option terminated by an element with both key and value set to -zero. The instance should cast this data pointer to const -LV2_Options_Option* and scan the array for any options of interest. The -instance MUST NOT modify the options array in any way.

- -

Note that requiring this feature may reduce the number of compatible hosts. -Unless some options are strictly required by the instance, this feature SHOULD -be listed as a lv2:optionalFeature.

-""" . + rdfs:comment "The feature used to provide options to an instance." . opts:requiredOption a rdf:Property , owl:ObjectProperty ; rdfs:range rdf:Property ; rdfs:label "required option" ; - lv2:documentation """ -

An option required by the instance to function at all. The host MUST pass a -value for the specified option via opts:options in order to create an -instance.

- -

Note that use of this property may reduce the number of compatible hosts. -Wherever possible, it is better to list options with opts:supportedOption and -fall back to a reasonable default value if it is not provided.

-""" . + rdfs:comment "An option required by the instance to function at all." . opts:supportedOption a rdf:Property , owl:ObjectProperty ; rdfs:range rdf:Property ; rdfs:label "supported option" ; - lv2:documentation """ -

An option supported or understood by the instance. The host SHOULD -provide a value for the specified option if one is known, or provide the user -an opportunity to specify one if one is Indicates that the instance host MUST -pass a value for the specified option in order to instantiate the instance.

-""" . + rdfs:comment "An option supported or by the instance." . -- cgit v1.2.1