diff options
author | David Robillard <d@drobilla.net> | 2011-11-14 07:43:05 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2011-11-14 07:43:05 +0000 |
commit | 5cc0056e23a09a768891f04d30dbb07f84a62449 (patch) | |
tree | 54f8bec05e0706655710b1b4b235beb96ecaf687 /extensions/ui.lv2/ui.ttl | |
parent | 35eb0a0b8bdf1cbdcc44d6590218d3ab62aaa87d (diff) | |
download | lv2-5cc0056e23a09a768891f04d30dbb07f84a62449.tar.xz |
Prettify UI extension documentation.
Diffstat (limited to 'extensions/ui.lv2/ui.ttl')
-rw-r--r-- | extensions/ui.lv2/ui.ttl | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/extensions/ui.lv2/ui.ttl b/extensions/ui.lv2/ui.ttl index 16b156f..9c03a6c 100644 --- a/extensions/ui.lv2/ui.ttl +++ b/extensions/ui.lv2/ui.ttl @@ -47,7 +47,7 @@ This extension defines an interface that can be used in LV2 plugins and hosts to create UIs for plugins. The UIs are similar to plugins and reside in shared object files in an LV2 bundle. UIs are associated with a plugin in RDF using the triples:</p> -<pre> +<pre class="turtle-code"> @prefix ui: <http://lv2plug.in/ns/extensions/ui#> . <http://my.plugin> ui:ui <http://my.pluginui> . @@ -86,7 +86,7 @@ functionality that could be useful to control with a UI, this extension allows for meta-extensions that can extend the interface between the UI and the host. These extensions mirror the extensions used for plugins - there are required and optional "features" that you declare in the RDF data for the UI:</p> -<pre> +<pre class="turtle-code"> <http://my.pluginui> lv2:requiredFeature <http://my.feature> . <http://my.pluginui> lv2:optionalFeature <http://my.feature> . </pre> @@ -140,21 +140,21 @@ UI, e.g. <code>gcc -Wl,nodelete</code>. """ . ui:noUserResize a lv2:Feature ; - rdfs:comment """ -If a UI requires this feature it indicates that it does not make sense + lv2:documentation """ +<p>If a UI requires this feature it indicates that it does not make sense to let the user resize the main widget, and the host should prevent that. This feature may not make sense for all UI types. The data pointer for the -LV2_Feature for this feature should always be set to NULL. +LV2_Feature for this feature should always be set to NULL.</p> """ . ui:fixedSize a lv2:Feature ; - rdfs:comment """ -If a UI requires this feature it indicates the same thing as + lv2:documentation """ +<p>If a UI requires this feature it indicates the same thing as ui:noUserResize, and additionally it means that the UI will not resize the main widget on its own - it will always remain the same size (e.g. a pixmap based GUI). This feature may not make sense for all UI types. The data pointer for the LV2_Feature for this feature should always be set -to NULL. +to NULL.</p> """ . ui:PortNotification a rdfs:Class ; @@ -178,9 +178,9 @@ A PortNotification MUST have exactly one ui:portIndex which is an xsd:decimal. ui:portNotification a rdf:Property ; rdfs:domain ui:UI ; rdfs:range ui:PortNotification ; - rdfs:comment """ -Indicates that a UI should receive notification (via port_event on -LV2UI_Descriptor) when a particular port's value changes. + lv2:documentation """ +<p>Indicates that a UI should receive notification (via +LV2UI_Descriptor::port_event()) when a particular port's value changes.</p> """ . ui:plugin a rdf:Property ; |