Browse Source

Put the correct properties of extui; Add doc script and gitignore

tags/2020-07-14
falkTX 6 years ago
parent
commit
a18f080df2
5 changed files with 101 additions and 79 deletions
  1. +2
    -0
      .gitignore
  2. +25
    -0
      generate-lv2-html-docs.sh
  3. +48
    -79
      kx-external-ui.lv2/external-ui.ttl
  4. +8
    -0
      kx-meta/manifest.ttl
  5. +18
    -0
      kx-meta/meta.ttl

+ 2
- 0
.gitignore View File

@@ -0,0 +1,2 @@
documentation/


+ 25
- 0
generate-lv2-html-docs.sh View File

@@ -0,0 +1,25 @@
#!/bin/bash

set -e

if [ ! -d kx-external-ui.lv2 ]; then
echo "kx-external-ui.lv2 bundle missing"
exit
fi

if (! which lv2specgen.py >/dev/null); then
echo "lv2specgen.py tool missing"
exit
fi

if [ ! -d documentation ]; then
mkdir documentation
fi

if [ ! -f documentation/style.css ]; then
git clone git://github.com/KXStudio/LV2-Extensions --depth 1 -b gh-pages documentation
fi

cp kx-external-ui.lv2/* documentation/extui/

lv2specgen.py $(pwd)/kx-external-ui.lv2/manifest.ttl /usr/share/lv2specgen/ ../style.css $(pwd)/documentation/extui/index.html $(pwd)/documentation/extui "" -i -p extui

+ 48
- 79
kx-external-ui.lv2/external-ui.ttl View File

@@ -3,6 +3,7 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix ui: <http://lv2plug.in/ns/extensions/ui#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<http://kxstudio.sf.net/ns/lv2ext/external-ui>
@@ -12,101 +13,69 @@
<../kx-meta/meta.ttl> ;
lv2:documentation """
<p>
LV2 External UI extension is an <a href="http://lv2plug.in/ns/extensions/ui" target="_blank">LV2 UI</a> extension,
subclass of <a href="http://lv2plug.in/ns/extensions/ui/#UI" target="_blank">http://lv2plug.in/ns/extensions/ui/#UI</a>
just like <a href="http://lv2plug.in/ns/extensions/ui/#GtkUI" target="_blank">http://lv2plug.in/ns/extensions/ui/#GtkUI</a> is.<br/>
It defines LV2UI_Widget pointer/handle as a pointer to LV2_External_UI_Widget, defined in the lv2_external_ui.h header (see below).<br/>
LV2 External UI extension is an <a href="http://lv2plug.in/ns/extensions/ui" target="_blank">LV2 UI</a> extension, subclass of ui:UI just like ui:GtkUI is.<br/>
The ui:Widget type used in this extension is extui:Widget, see the C header file for more details.<br/>
</p>
<p>
This extension used to be available under the <b style="text-decoration: line-through;">http://lv2plug.in/ns/extensions/ui#external</b> URI,
and later <b style="text-decoration: line-through;">http://nedko.arnaudov.name/lv2/external_ui/</b>.<br/>
These old URIs are deprecated and the extension is available under the new <b>http://kxstudio.sf.net/ns/lv2ext/external-ui</b> URI.<br/>
Or if you prefer, the old extensions are deprecated and a new one with exactly same semantics but different URI is available.<br/>
<br/>
NOTE: The old <b style="text-decoration: line-through;">http://nedko.arnaudov.name/lv2/external_ui/</b> URI has been removed from the header file,
since there were no plugins using it.
This extension used to be (wronly) defined in a <a href="http://lv2plug.in/ns/extensions/ui#external">lv2plug.in domain</a>.<br/>
The old URI is deprecated and the extension is available under the new <a href="http://kxstudio.sf.net/ns/lv2ext/external-ui">URI</a>.<br/>
Or if you prefer, the old extension is deprecated and a new one with exactly same semantics but different URI is available.
</p>
<hr/>

<p>
List of plugins that use this extension:
<ul>
<li><a href="http://distrho.sourceforge.net/" target="_blank">DISTRHO Plugins and Ports</a></li>
<li><a href="http://www.drumgizmo.org/" target="_blank">DrumGizmo</a></li>
<li><a href="http://drumkv1.sourceforge.net/" target="_blank">drumkv1</a></li>
<li><a href="http://www.linuxdsp.co.uk/" target="_blank">linuxDSP</a></li>
<li><a href="https://github.com/x42/meters.lv2" target="_blank">meters.lv2</a></li>
<li><a href="https://www.pianoteq.com/pianoteq4" target="_blank">Pianoteq</a></li>
<li><a href="http://samplv1.sourceforge.net/" target="_blank">samplv1</a></li>
<li><a href="https://github.com/x42/sisco.lv2" target="_blank">sisco.lv2</a></li>
<li><a href="http://synthv1.sourceforge.net/" target="_blank">synthv1</a></li>
<li><a href="https://github.com/x42/tuna.lv2" target="_blank">tuna.lv2</a></li>
</ul>
</p>
<ul>
<li><a href="http://distrho.sourceforge.net/" target="_blank">DISTRHO Plugins and Ports</a></li>
<li><a href="http://www.drumgizmo.org/" target="_blank">DrumGizmo</a></li>
<li><a href="http://drumkv1.sourceforge.net/" target="_blank">drumkv1</a></li>
<li><a href="https://github.com/x42/meters.lv2" target="_blank">meters.lv2</a></li>
<li><a href="https://www.pianoteq.com/pianoteq4" target="_blank">Pianoteq</a></li>
<li><a href="http://samplv1.sourceforge.net/" target="_blank">samplv1</a></li>
<li><a href="https://github.com/x42/sisco.lv2" target="_blank">sisco.lv2</a></li>
<li><a href="http://synthv1.sourceforge.net/" target="_blank">synthv1</a></li>
<li><a href="https://github.com/x42/tuna.lv2" target="_blank">tuna.lv2</a></li>
</ul>

<p>
List of hosts that use this extension:
<ul>
<li><a href="http://ardour.org" target="_blank">Ardour</a></li>
<li><a href="<?php echo $ROOT; ?>/Applications:Carla" target="_blank">Carla</a></i></li>
<li><a href="http://drobilla.net/software/jalv/" target="_blank">Jalv</a> (using <a href="jalv_extui_svn5273b.diff" target="_blank">this patch</a>)</li>
<li><a href="http://qtractor.sourceforge.net" target="_blank">Qtractor</a></li>
</ul>
</p>
<ul>
<li><a href="http://ardour.org" target="_blank">Ardour</a></li>
<li><a href="http://kxstudio.sf.net/Applications:Carla" target="_blank">Carla</a></li>
<li><a href="http://drobilla.net/software/jalv/" target="_blank">Jalv</a> (using <a href="jalv_extui_svn5273b.diff" target="_blank">this patch</a>)</li>
<li><a href="http://qtractor.sourceforge.net" target="_blank">Qtractor</a></li>
</ul>
""" .

extui:brand
a rdf:Property ,
owl:DatatypeProperty ;
rdfs:label "brand" ;
rdfs:range xsd:string ;
rdfs:comment "TODO, maximum 10 characters" .

extui:label
a rdf:Property ,
owl:DatatypeProperty ;
rdfs:label "label" ;
rdfs:range xsd:string ;
rdfs:comment "TODO, maximum 16 characters" .

extui:default
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
rdfs:label "default" ;
rdfs:seeAlso lv2:default ;
rdfs:comment "A custom default value specific to MOD devices, used in place of lv2:default." .

extui:minimum
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
rdfs:label "minimum" ;
rdfs:seeAlso lv2:minimum ;
rdfs:comment "A custom minimum value specific to MOD devices, used in place of lv2:minimum." .

extui:maximum
a rdf:Property ,
owl:DatatypeProperty ,
owl:FunctionalProperty ;
rdfs:label "maximum" ;
rdfs:seeAlso lv2:maximum ;
rdfs:comment "A custom maximum value specific to MOD devices, used in place of lv2:maximum." .
extui:Host
a lv2:Feature ;
lv2:documentation """
<p>
TODO
</p>
""" .

extui:rangeSteps
a rdf:Property ;
rdfs:domain lv2:Port ;
rdfs:range xsd:nonNegativeInteger ;
rdfs:label "number of value steps" ;
rdfs:seeAlso pprops:rangeSteps ;
rdfs:comment "A custom rangeSteps value specific to MOD devices, used in place of pprops:rangeSteps." .
extui:Widget
a rdfs:Class ,
owl:Class ;
rdfs:subClassOf ui:UI ;
rdfs:label "External UI" ;
lv2:documentation """
<p>
TODO
</p>
""" .

extui:notStompboxCapable
a lv2:Feature ;
rdfs:label "not stompbox capable" ;
<http://lv2plug.in/ns/extensions/ui#external>
a lv2:Feature ,
rdfs:Class ,
owl:Class ;
owl:deprecated true ;
rdfs:seeAlso extui:Host, extui:Widget ;
rdfs:label "Old External UI" ;
lv2:documentation """
<p>
Indicates that the plugin is not suitable for use in the MOD Stompbox mode.<br/>
Plugins are assumed to be suitable for Stompbox mode by default, and MUST provide this as an optional feature in case that's not true.
TODO
</p>
""" .

+ 8
- 0
kx-meta/manifest.ttl View File

@@ -0,0 +1,8 @@
@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

<http://kxstudio.sf.net>
a lv2:Specification ;
lv2:minorVersion 1 ;
lv2:microVersion 0 ;
rdfs:seeAlso <meta.ttl> .

+ 18
- 0
kx-meta/meta.ttl View File

@@ -0,0 +1,18 @@
@prefix doap: <http://usefulinc.com/ns/doap#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

<http://kxstudio.sf.net>
a owl:Ontology ;
doap:license "Public Domain" ;
doap:name "KXStudio Meta" ;
doap:shortdesc "KXStudio project metadata" ;
doap:created "2015-07-03" ;
doap:maintainer <http://falktx.com/myself.html> ;
rdfs:comment "This document describes metadata relevant to the KXStudio project." .

<http://falktx.com/myself.html>
a foaf:Person ;
foaf:name "Filipe Coelho" ;
foaf:mbox <mailto:falktx@falktx.com> .

Loading…
Cancel
Save