diff options
author | David Robillard <d@drobilla.net> | 2014-11-21 23:11:21 -0500 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-11-21 23:11:21 -0500 |
commit | 4dabee5461648bb040e73e7c90a3ce1902d70f77 (patch) | |
tree | 4a9e61ae264a21c71affe673d70795353a704bd5 | |
parent | ed73356e710d9b20fce8bf98a15c9a63e54bd9d9 (diff) | |
download | lv2site-4dabee5461648bb040e73e7c90a3ce1902d70f77.tar.xz |
Organize site explicitly using pages.
-rw-r--r-- | content/pages/bundle-definition.md | 2 | ||||
-rw-r--r-- | content/pages/developing.md | 44 | ||||
-rw-r--r-- | content/pages/filesystem-hierarchy-standard.md | 4 | ||||
-rw-r--r-- | content/pages/index.md | 10 | ||||
-rw-r--r-- | content/pages/validating-lv2-data.md | 2 | ||||
-rw-r--r-- | content/pages/why-lv2.md | 30 | ||||
-rw-r--r-- | pelicanconf.py | 9 | ||||
-rw-r--r-- | themes/lv2/static/css/style.css | 4 | ||||
-rw-r--r-- | themes/lv2/templates/base.html | 2 |
9 files changed, 69 insertions, 38 deletions
diff --git a/content/pages/bundle-definition.md b/content/pages/bundle-definition.md index e82e3d8..fffe011 100644 --- a/content/pages/bundle-definition.md +++ b/content/pages/bundle-definition.md @@ -1,6 +1,4 @@ Title: Bundle Definition -Date: 2014-11-20 20:16 -Category: Documentation An _LV2 Bundle_ is a directory containing the file `manifest.ttl` at the top level, which is written in [Turtle](http://www.dajobe.org/2004/01/turtle/). diff --git a/content/pages/developing.md b/content/pages/developing.md index dde7b49..9e64267 100644 --- a/content/pages/developing.md +++ b/content/pages/developing.md @@ -1,17 +1,15 @@ -Title: Developer Information +Title: Developing The way to learn about implementing LV2 is by example. The documentation and example projects listed below have been created specifically for this purpose, look at these first. Copying an example as a template is recommended. -## What *not* to do - -If you are interested in implementing LV2, do *not* look at the specifications -and API references first! They are just that: references, and do not provide a -high-level view of how to get the job done. Once you have a basic working -implementation based on the examples, if you need more specific detail, then -the references are useful. +**What *not* to do:** If you are interested in implementing LV2, do *not* look +at the specifications and API references first! These are *references* that do +not always provide a clear high-level view. Once you've gotten started based +on the information below, if you need more specific detail, then the references +are useful. ## Implementing Plugins @@ -63,6 +61,36 @@ there for documentation about a specific function, struct, or define. * [API Reference](http://lv2plug.in/doc/html) +## Other Documentation + +* [Filesystem Hierarchy Standard](filesystem-hierarchy-standard.html) + +* [Validating LV2 Data](validating-lv2-data.html) + +* [Bundle Defnition](bundle-definition.html) + + +## Contributing to LV2 + +Both LV2 itself and this site are stored in [git](http://lv2plug.in/git): + + :::sh + git clone http://lv2plug.in/git/lv2 + git clone http://lv2plug.in/git/lv2site + +Contributions are most welcome. If you plan to implement something +significant, it is a good idea to discuss it with the community on the mailing +list to be sure you're headed in the right direction. Feel free to get +creative, but note that all released LV2 APIs are permanently stable, so +changes that break them can not be accepted. + +A good entry point for beginners is writing new example plugins (using an +existing example as a template) to demonstrate some functionality in the +simplest possible way. + +Happy hacking! + + ## Help If you have any trouble or questions in general, ask on the diff --git a/content/pages/filesystem-hierarchy-standard.md b/content/pages/filesystem-hierarchy-standard.md index 4f06a9f..3039557 100644 --- a/content/pages/filesystem-hierarchy-standard.md +++ b/content/pages/filesystem-hierarchy-standard.md @@ -1,6 +1,4 @@ Title: Filesystem Hierarchy Standard -Date: 2014-11-20 20:16 -Category: Documentation This page defines the standard locations where LV2 data should be installed. All LV2 data is installed in [bundles](bundle-definition.html) which are discovered by hosts and other tools. @@ -35,4 +33,4 @@ Hosts may wish to write data to bundles at run time (e.g. to save a preset, meta ## Bundle Names -Bundle directory names are NOT strong identifiers, and may be different from system to system (or at different times on the same system). Users may change them freely for any reason without fear of breakage. Accordingly, hosts *MUST NOT_' attach significance to bundle names between invocations (e.g. in save files). LV2 plugins and other resources '_MUST* be referred to by URI in save files, NOT by file system path.
\ No newline at end of file +Bundle directory names are NOT strong identifiers, and may be different from system to system (or at different times on the same system). Users may change them freely for any reason without fear of breakage. Accordingly, hosts *MUST NOT_' attach significance to bundle names between invocations (e.g. in save files). LV2 plugins and other resources '_MUST* be referred to by URI in save files, NOT by file system path. diff --git a/content/pages/index.md b/content/pages/index.md index 2f894ae..e5ec36b 100644 --- a/content/pages/index.md +++ b/content/pages/index.md @@ -1,10 +1,10 @@ Title: LV2 save_as: index.html -LV2 is a standard for audio plugins, -used by hundreds of plugins and many other projects. -At its core, LV2 is a simple and stable interface, -but several *extensions* add functionality to support the needs of increasingly powerful audio software. +LV2 is a standard for audio plugins, used by hundreds of plugins and many other +projects. At its core, LV2 is a simple and stable interface, upon which +several *extensions* add functionality to support the needs of increasingly +powerful audio software. * [**Download LV2 1.10.0**](http://lv2plug.in/spec/lv2-1.10.0.tar.bz2) [(sig)](http://lv2plug.in/spec/lv2-1.10.0.tar.bz2.sig) @@ -16,5 +16,3 @@ but several *extensions* add functionality to support the needs of increasingly * Chat in [#lv2](http://webchat.freenode.net/?channels=lv2) on irc.freenode.net * [Projects Using LV2](pages/projects.html) - -* [Information for Developers](pages/developer-information.html) diff --git a/content/pages/validating-lv2-data.md b/content/pages/validating-lv2-data.md index 2a48e89..f144d04 100644 --- a/content/pages/validating-lv2-data.md +++ b/content/pages/validating-lv2-data.md @@ -1,6 +1,4 @@ Title: Validating LV2 Data -Date: 2014-11-20 21:33 -Category: Documentation Because LV2 data written in Turtle does not need to be compiled like C, the author must take care to ensure it is valid. For example, if there is a typo diff --git a/content/pages/why-lv2.md b/content/pages/why-lv2.md index bf7c3b3..707f9e7 100644 --- a/content/pages/why-lv2.md +++ b/content/pages/why-lv2.md @@ -2,12 +2,7 @@ Title: Why LV2? Unlike many popular audio plugin APIs, LV2 is a platform-agnostic [Free Software](http://www.gnu.org/philosophy/free-sw.html) specification with -a liberal license permitting virtually any implementation (both free and -proprietary). - -LV2 has been designed with extensibility in mind right from the start, so if -LV2 currently can't do what you need, functionality can be added without -breaking any pre-existing hosts or plugins. +a liberal license. ## Features @@ -21,7 +16,7 @@ breaking any pre-existing hosts or plugins. * Multi-channel port groups (e.g. stereo, 5.1 surround, ambisonics). -* Decentralized extensibility: any developer can implement (almost) any feature within LV2. +* Extensibility: almost any feature is possible within LV2. * Graceful compatibility: features can be optional. @@ -29,7 +24,7 @@ breaking any pre-existing hosts or plugins. * Plugin "bundles" may include any files, such as samples. -* Presets (bundled and/or user saved). +* Presets, both bundled and user saved, in the same format. * Plugin state saving and restoring. @@ -39,7 +34,7 @@ breaking any pre-existing hosts or plugins. * Message-based plugin communication, for advanced plugin control from UIs or other code. -* Transport awareness, both real time and tempo time (bars, beats, etc.). +* Transport awareness, both real time and musical time. ## Bundles @@ -67,9 +62,14 @@ with the basic methods typical to audio plugins. ## Extensibility -While the core API of LV2 is very simple, extensions can add arbitrary -functionality. The community works together to define standard extensions for -commonly needed functionality, but developers are free to implement any -extensions they need for their own applications. This is particularly useful -for developing new functionality and testing it in a real application before -proposing a new standard extension. +The more powerful features of LV2 are built as "extensions" on the core API. +The community works together to define standard extensions for commonly needed +functionality, but developers are free to implement any extensions they need +for their own applications. This is particularly useful for developing new +functionality and testing it in a real application before proposing a new +standard extension. + +This makes improving the LV2 standard a frictionless process for developers, +but standard extensions are not second-class citizens. If you have no need for +new features, or interest in developing LV2 itself, you can simply treat the +core and standard extensions as a unified API. diff --git a/pelicanconf.py b/pelicanconf.py index 5d3fad7..a3ca2d2 100644 --- a/pelicanconf.py +++ b/pelicanconf.py @@ -14,6 +14,8 @@ DEFAULT_LANG = u'en' THEME = 'themes/lv2' +FAVICON = 'images/favicon.png' + # Feed generation is usually not desired when developing FEED_ALL_ATOM = None CATEGORY_FEED_ATOM = None @@ -31,12 +33,17 @@ LINKS = () # ('Another social link', '#'),) SOCIAL = () +MENUITEMS = [('Developing', '/pages/developing.html'), + ('Git', 'http://lv2plug.in/git')] + +DISPLAY_PAGES_ON_MENU = False +DISPLAY_CATEGORIES_ON_MENU = False + DEFAULT_PAGINATION = False # Uncomment following line if you want document-relative URLs when developing RELATIVE_URLS = True -DISPLAY_PAGES_ON_MENU = False DISPLAY_TAGS_ON_SIDEBAR = False DISPLAY_RECENT_POSTS_ON_SIDEBAR = False diff --git a/themes/lv2/static/css/style.css b/themes/lv2/static/css/style.css index 7dc91ce..8e4d83a 100644 --- a/themes/lv2/static/css/style.css +++ b/themes/lv2/static/css/style.css @@ -213,4 +213,8 @@ h1 { .page-header { margin-top: 10px; +} + +.navbar-right { + display: none; }
\ No newline at end of file diff --git a/themes/lv2/templates/base.html b/themes/lv2/templates/base.html index ae04fb1..b23234c 100644 --- a/themes/lv2/templates/base.html +++ b/themes/lv2/templates/base.html @@ -71,7 +71,7 @@ {% else %} <link rel="stylesheet" href="{{ SITEURL }}/theme/css/bootstrap.min.css" type="text/css"/> {% endif %} - <link href="{{ SITEURL }}/theme/css/font-awesome.min.css" rel="stylesheet"> + <!--<link href="{{ SITEURL }}/theme/css/font-awesome.min.css" rel="stylesheet">--> <link href="{{ SITEURL }}/theme/css/pygments/{{ PYGMENTS_STYLE|default('native') }}.css" rel="stylesheet"> {% if DOCUTIL_CSS %} |