|author||David Robillard <firstname.lastname@example.org>||2013-12-25 17:59:16 +0000|
|committer||David Robillard <email@example.com>||2013-12-25 17:59:16 +0000|
Bookify examploscope documentation.
Fix book generator to include single-star C comments in code blocks.
Diffstat (limited to 'plugins/eg01-amp.lv2')
2 files changed, 23 insertions, 25 deletions
diff --git a/plugins/eg01-amp.lv2/README.txt b/plugins/eg01-amp.lv2/README.txt
index f024a4d..41683d3 100644
@@ -2,20 +2,18 @@
This plugin is a simple example of a basic LV2 plugin with no additional features.
It has audio ports which contain an array of `float`,
-and a control port which contain a single `float`.
+and a control port which contains a single `float`.
LV2 plugins are defined in two parts: code and data.
The code is written in C, or any C compatible language such as C++.
Static data is described separately in the human and machine friendly http://www.w3.org/TeamSubmission/turtle/[Turtle] syntax.
-Turtle is a syntax for the RDF data model,
-but familiarity with RDF is not required to understand this documentation.
-Generally, code is kept minimal,
-and all static information is described in the data.
+Generally, the goal is to keep code minimal,
+and describe as much as possible in the static data.
There are several advantages to this approach:
- * Hosts can discover and inspect plugins without loading or executing any plugin code
- * It is simple to work with plugin data using scripting languages, command line tools, etc.
- * The standard format allow the use of existing vocabularies to describe plugins and related information
- * The data inherently integrates with the web, databases, etc.
- * Labels and documentation are translatable, and available to hosts for display in user interfaces
+ * Hosts can discover and inspect plugins without loading or executing any plugin code.
+ * Plugin data can be used from a wide range of generic tools like scripting languages and command line utilities.
+ * The standard data model allows the use of existing vocabularies to describe plugins and related information.
+ * The language is extensible, so authors may describe any data without requiring changes to the LV2 specification.
+ * Labels and documentation are translatable, and available to hosts for display in user interfaces.
diff --git a/plugins/eg01-amp.lv2/manifest.ttl.in b/plugins/eg01-amp.lv2/manifest.ttl.in
index 0da78b0..8a1f696 100644
@@ -1,27 +1,27 @@
-# LV2 Bundle Manifest
+# ==== Bundles ====
-# All LV2 plugins are installed as "bundles", a directory with a particular
-# format. Inside the bundle, the entry point is a file called "manifest.ttl".
-# This file lists what plugins are in this bundle, and which files are (.so,
-# .ttl, etc.) are associated with those plugins.
+# LV2 plugins are installed in ``bundles'', a directory with a particular
+# format. Inside the bundle, the entry point is a file called `manifest.ttl`.
+# The manifest lists the plugins (or other resources) that are in this bundle,
+# and the files that contain further information.
-# Hosts read bundles' manifest.ttl to discover what plugins (and other
-# resources) are available. Manifest files should be as small as possible for
-# performance reasons.
+# Hosts typically read the `manifest.ttl` of every bundle when starting up to
+# discover what LV2 plugins and other resources are present. Accordingly,
+# manifest files should be as small as possible for performance reasons.
# ==== Namespace Prefixes ====
-# Turtle files contain many URIs. To make this more readable, prefixes
-# can be defined. For example, with the `lv2:` prefix below, instead of
+# Turtle files contain many URIs. To make this more readable, prefixes can be
+# defined. For example, with the `lv2:` prefix below, instead of
# <http://lv2plug.in/ns/lv2core#Plugin> the shorter form `lv2:Plugin` can be
-# used. This is just a shorthand for URIs within a file, the prefixes are not
-# significant otherwise.
+# used. This is just a shorthand for URIs within one file, the prefixes are
+# not significant otherwise.
@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-# ==== Data ====
+# ==== A Plugin Entry ====
a lv2:Plugin ;
@@ -36,8 +36,8 @@
# For reability, the following text will assume `.so` is the extension used.
# In short, this declares that the resource with URI
-# "http://lv2plug.in/plugins/eg-amp" is an LV2 plugin, with executable code in
-# the file "amp.so" and a full description in "amp.ttl". These paths are
+# `http://lv2plug.in/plugins/eg-amp` is an LV2 plugin, with executable code in
+# the file `amp.so` and a full description in `amp.ttl`. These paths are
# relative to the bundle directory.
# There are 3 statements in this description: