From 0e75365396eb338fe7f5f839787cd577d5dc531d Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 2 May 2013 23:13:08 +0200 Subject: [PATCH] docs: Add glossary (fixes #430) --- docs/ext/scrobbler.rst | 2 ++ docs/glossary.rst | 37 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 40 insertions(+) create mode 100644 docs/glossary.rst diff --git a/docs/ext/scrobbler.rst b/docs/ext/scrobbler.rst index a0496b37..84188d02 100644 --- a/docs/ext/scrobbler.rst +++ b/docs/ext/scrobbler.rst @@ -1,3 +1,5 @@ +.. _ext-scrobbler: + **************** Mopidy-Scrobbler **************** diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 00000000..2aa63887 --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,37 @@ +******** +Glossary +******** + +.. glossary:: + + backend + A part of Mopidy providing music library, playlist storage and/or + playback capability to the :term:`core`. Mopidy have a backend for each + music store or music service it supports. See :ref:`backend-api` for + details. + + core + The part of Mopidy that makes multiple frontends capable of using + multiple backends. The core module is also the owner of the + :term:`tracklist`. To use the core module, see :ref:`core-api`. + + extension + A Python package that can extend Mopidy with on or more + :term:`backends `, :term:`frontends `, or GStreamer + elements like :term:`mixers `. See :ref:`ext` for a list of + existing extensions and :ref:`extensiondev` for how to make a new + extension. + + frontend + A part of Mopidy *using* the :term:`core` API. Existing frontends + include the :ref:`MPD server `, the :ref:`MPRIS/D-Bus + integration `, the :ref:`Last.fm scrobbler `, + and the :ref:`HTTP server ` with JavaScript API. See + :ref:`frontend-api` for details. + + mixer + A GStreamer element that controls audio volume. + + tracklist + Mopidy's name for the play queue or current playlist. The name is + inspired by the MPRIS specification. diff --git a/docs/index.rst b/docs/index.rst index 199ba31c..fb91244d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -71,6 +71,7 @@ Reference .. toctree:: :maxdepth: 2 + glossary api/index modules/index