aboutsummaryrefslogtreecommitdiffstats
path: root/ext/files.lv2/files.ttl
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-11-20 23:08:57 +0000
committerDavid Robillard <d@drobilla.net>2011-11-20 23:08:57 +0000
commit725d4a404b838da6b67d9da66228a1125bddef57 (patch)
treea1daab3d767c85b1b67ff3a9eb60d54721b2e5fc /ext/files.lv2/files.ttl
parent5ae0165d6d0420e95e22c1451e319b9e83398c28 (diff)
downloadlv2-725d4a404b838da6b67d9da66228a1125bddef57.tar.xz
Lay out repository structure to match include and URI structure.
Treat lv2core like all the other specifications in gendoc.py.
Diffstat (limited to 'ext/files.lv2/files.ttl')
-rw-r--r--ext/files.lv2/files.ttl115
1 files changed, 0 insertions, 115 deletions
diff --git a/ext/files.lv2/files.ttl b/ext/files.lv2/files.ttl
deleted file mode 100644
index d3ff8a5..0000000
--- a/ext/files.lv2/files.ttl
+++ /dev/null
@@ -1,115 +0,0 @@
-# LV2 Files Extension
-# Copyright 2010-2011 David Robillard <d@drobilla.net>
-#
-# Permission to use, copy, modify, and/or distribute this software for any
-# purpose with or without fee is hereby granted, provided that the above
-# copyright notice and this permission notice appear in all copies.
-#
-# THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-
-@prefix atom: <http://lv2plug.in/ns/ext/atom#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix files: <http://lv2plug.in/ns/ext/files#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
-
-<http://lv2plug.in/ns/ext/files>
- a lv2:Specification ;
- doap:name "LV2 Files" ;
- doap:shortdesc "A standard for referring to files in plugin state." ;
- doap:license <http://opensource.org/licenses/isc-license> ;
- doap:release [
- doap:revision "0.2" ;
- doap:created "2011-04-05"
- ] ;
- doap:maintainer [
- a foaf:Person ;
- foaf:name "David Robillard" ;
- foaf:homepage <http://drobilla.net/> ;
- rdfs:seeAlso <http://drobilla.net/drobilla.rdf>
- ] ;
- lv2:documentation """
-<p>This extension provides a mechanism for plugins to portably refer to files
-in persistent plugin state (using the <a
-href="http://lv2plug.in/ns/ext/persist">LV2 Persist</a> extension), and create
-instance-local files in host-defined locations (e.g. for recording).</p>
-
-<p>The motivating idea behind this extension is that all details of file
-management MUST be handled by the host since different hosts may have very
-different requirements. Plugins MUST NOT make any assumption about file system
-locations beyond what is explicitly guaranteed by this extension.</p>
-
-<p>This extension defines two features: files:newFileSupport allows plugins to
-create new files within an instance-specific namespace at any time (except in
-realtime contexts); while files:pathSupport allows plugins to refer to file
-paths in plugin state in a way transparent to the host.</p>
-
-<p>To create a new file, the plugin MUST request a path from the host using
-LV2_Files_New_File_Support::new_file_path(). Thus, the host may choose an
-appropriate location for the file (e.g. a writable path on the appropriate disk
-volume or a path within a session directory) using information not available to
-the plugin.</p>
-
-<p>To store a path in persistent state, the plugin MUST map it to an
-<q>abstract path</q> using LV2_Files_Path_Support::abstract_path(). To use a
-path loaded from persistent state, the plugin MUST map the (abstract) path to
-an absolute path using LV2_Files_Path_Support::absolute_path(). Thus, the host
-can manage all paths used in a session and support exporting sessions to a
-portable self-contained format for archival or distribution.</p> """ .
-
-files:pathSupport a lv2:Feature ;
- rdfs:label "Support for storing file paths in plugin state" ;
- lv2:documentation """
-<p>This feature allows plugins to refer to pre-existing or newly created files
-in persistent plugin state in a portable way. To support this feature a host
-MUST pass a LV2_Files_Path_Support structure to the plugin's
-LV2_Descriptor::instantiate() method as an LV2_Feature with LV2_Feature::URI =
-LV2_FILES_PATH_SUPPORT_URI and LV2_Feature::data pointed to an instance of
-LV2_Files_Path_Support.</p>
-
-<p>Plugins MUST use the functions provided by this feature to handle
-<em>all</em> paths saved to, or restored from, persistent plugin state;
-otherwise broken and/or non-portable state will silently be created resulting
-in a broken user experience.</p>
-""" .
-
-files:newFileSupport a lv2:Feature ;
- rdfs:label "Support for creating new files" ;
- lv2:documentation """
-<p>This feature allows plugins to create new files local to that plugin
-instance. To support this feature a host MUST pass a
-LV2_Files_New_File_Support structure to the plugin's
-LV2_Descriptor::instantiate() method as an LV2_Feature with LV2_Feature::URI =
-LV2_FILES_NEW_FILE_SUPPORT_URI and LV2_Feature::data pointed to an instance of
-LV2_Files_New_File_Support.</p>
-""" .
-
-files:AbstractPath a rdfs:Class ;
- rdfs:label "File Path" ;
- lv2:documentation """
-<p>An abstract path to a file in persistent plugin state.</p>
-
-<p>The format of a files:AbstractPath is a C string escaped or otherwise
-restricted in a system-specific manner. This URI,
-<q>http://lv2plug.in/ns/ext/files#AbstractPath</q>, mapped to an integer,
-should be used as the <code>type</code> parameter to a
-LV2_Persist_Store_Function; and will likewise be returned by the corresponding
-call to a LV2_Persist_Retrieve_Function.</p>
-
-<p>Abstract paths reside in a namespace specific to a plugin instance.
-Typical hosts are expected to implement this by giving each plugin instance its
-own state directory.</p>
-
-<p>When storing and retrieving an abstract path, the plugin MUST NOT assume the
-same path will be restored. However, the restored path will refer to a file
-with equivalent contents to the original.</p>
-""" .