From bfcdcde2b9a5c20688fe73a841c288218acd975d Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sat, 27 Apr 2019 15:09:18 +0200 Subject: Flatten documentation to fix fragment links This removes all the extra bundle content from the documentation output and instead makes pages directly at the URI of specifications. This way, links to fragments in spec pages (which are often copy and pasted) are correct fragment identifiers like instead of . --- lv2/buf-size/buf-size.ttl | 2 +- lv2/midi/midi.ttl | 4 ++-- lv2/patch/patch.ttl | 4 ++-- lv2/state/state.ttl | 14 +++++++------- lv2/uri-map/uri-map.ttl | 2 +- lv2/urid/urid.ttl | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) (limited to 'lv2') diff --git a/lv2/buf-size/buf-size.ttl b/lv2/buf-size/buf-size.ttl index f8a9d60..3464284 100644 --- a/lv2/buf-size/buf-size.ttl +++ b/lv2/buf-size/buf-size.ttl @@ -18,7 +18,7 @@ the block length.

This extension defines features and properties but has no special purpose API of its own. The host provides all the relevant information to the plugin -as options.

+as options.

To require restrictions on the block length, plugins can require additional features: bufsz:boundedBlockLength, bufsz:powerOf2BlockLength, and diff --git a/lv2/midi/midi.ttl b/lv2/midi/midi.ttl index 23e41b3..571ff7a 100644 --- a/lv2/midi/midi.ttl +++ b/lv2/midi/midi.ttl @@ -20,8 +20,8 @@ controlling digital music devices.

For plugins that process MIDI (or other situations where MIDI is sent via a generic transport) the main type defined here, midi:MidiEvent, can be mapped to an integer and used as the type of an LV2 Atom or Event.

+href="atom.html#Atom">Atom or Event.

This specification also defines a complete human and machine readable description of the MIDI standard (except for standard controller numbers). diff --git a/lv2/patch/patch.ttl b/lv2/patch/patch.ttl index 71c51a3..87432fe 100644 --- a/lv2/patch/patch.ttl +++ b/lv2/patch/patch.ttl @@ -18,7 +18,7 @@ plugins, but is useful in many contexts.

The main feature of this design is that the messages themselves are described in the same format as the data they work with. In particular, messages can be serialised as a binary Object or in Turtle (or any other RDF +href="atom.html#Object">Object or in Turtle (or any other RDF serialisation).

The idea behind using a property-based interface for control is to prevent @@ -37,7 +37,7 @@ One benefit of this approach is that a persistent state model is available

This specification is strictly metadata and does not define any binary mechanism, though it can be completely expressed by standard types in the LV2 Atom extension. Thus, hosts can be expected +href="atom.html">LV2 Atom extension. Thus, hosts can be expected to be capable of transmitting it between plugins, or between a plugin and its UI, making it a good choice for advanced plugin control.

""" . diff --git a/lv2/state/state.ttl b/lv2/state/state.ttl index c86fea7..9c49195 100644 --- a/lv2/state/state.ttl +++ b/lv2/state/state.ttl @@ -44,9 +44,9 @@ single property. The host is free to implement property storage and retrieval in any way.

Since value types are defined by URI, any type is possible. However, a set -of standard types is defined by the LV2 Atom +of standard types is defined by the LV2 Atom extension. Use of these types is recommended. Hosts MUST implement at least -atom:String, which is simply a C +atom:String, which is simply a C string.

Referring to Files

@@ -55,7 +55,7 @@ string.

state. This is done by storing the file's path as a property just like any other value. However, there are some rules which MUST be followed when storing paths, see state:mapPath for details. Plugins MUST use the type atom:Path for all paths in their state.

+href="atom.html#Path">atom:Path for all paths in their state.

Plugins are strongly encouraged to avoid creating files, instead storing all state as properties. However, occasionally the ability to create files is @@ -204,9 +204,9 @@ plugins.

Don't stop; set playing to false.

This extension does not define a dynamic mechanism for state access and -manipulation. The LV2 Patch extension +manipulation. The LV2 Patch extension defines a generic set of messages which can be used to access or manipulate -properties, and the LV2 Atom extension defines +properties, and the LV2 Atom extension defines a port type and data container capable of transmitting those messages.

""" . @@ -355,7 +355,7 @@ state:threadSafeRestore is thread-safe and may be called concurrently with audio class functions.

To support this feature, the host MUST pass a work:schedule feature to the restore +href="worker.html#schedule">work:schedule feature to the restore method, which will be used to complete the state restoration. The usual mechanics of the worker apply: the host will call the plugin's work method, which emits a response which is later applied in the audio thread.

@@ -372,7 +372,7 @@ state:Changed way that the host can not otherwise know about.

This is a one-way notification, intended to be used as the type of an Object sent from plugins when +href="atom.html#Object">Object sent from plugins when necessary.

Plugins SHOULD emit such an event whenever a change has occurred that would diff --git a/lv2/uri-map/uri-map.ttl b/lv2/uri-map/uri-map.ttl index 7f6b0e7..d9f7f5a 100644 --- a/lv2/uri-map/uri-map.ttl +++ b/lv2/uri-map/uri-map.ttl @@ -11,7 +11,7 @@ ; lv2:documentation """

This extension is deprecated. New -implementations should use LV2 URID +implementations should use LV2 URID instead.

This extension defines a simple mechanism for plugins to map URIs to diff --git a/lv2/urid/urid.ttl b/lv2/urid/urid.ttl index 29b196a..836d525 100644 --- a/lv2/urid/urid.ttl +++ b/lv2/urid/urid.ttl @@ -15,7 +15,7 @@ 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 extension, since the map +uri-map extension, since the map 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.

-- cgit v1.2.1