WIP Manual 2.1.x updates

.tx/config

@@ -5,119 +5,213 @@ type = PO
 
 [mixxxdj-manual.chaptersadvanced_topicspot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/advanced_topics.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/advanced_topics.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersappendixpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/appendix.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/appendix.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersconfigurationpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/configuration.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/configuration.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersdjing_with_mixxxpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/djing_with_mixxx.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/djing_with_mixxx.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersgetting_involvedpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/getting_involved.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/getting_involved.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersinstallationpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/installation.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/installation.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersintroductionpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/introduction.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/introduction.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chapterslibrarypot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/library.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/library.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chapterslivebroadcastingpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/livebroadcasting.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/livebroadcasting.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chaptersquickstartpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/quickstart.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/quickstart.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.chapterssetuppot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/setup.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/setup.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.user_interfacepot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/user_interface.po
-source_file = source/locale/pot/chapters/user_interface.pot
-source_lang = en_US
 minimum_perc = 0
-type = PO
-
-[mixxxdj-manual.vinyl_controlpot]
-file_filter = source/locale/<lang>/LC_MESSAGES/chapters/vinyl_control.pot
 source_file = source/locale/pot/chapters/user_interface.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.vinyl_controlpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/chapters/vinyl_control.po
+minimum_perc = 0
 source_file = source/locale/pot/chapters/user_interface.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.glossarypot]
 file_filter = source/locale/<lang>/LC_MESSAGES/glossary.po
+minimum_perc = 0
 source_file = source/locale/pot/glossary.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.indexpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/index.po
+minimum_perc = 0
 source_file = source/locale/pot/index.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
 
 [mixxxdj-manual.sphinxpot]
 file_filter = source/locale/<lang>/LC_MESSAGES/sphinx.po
+minimum_perc = 0
 source_file = source/locale/pot/sphinx.pot
 source_lang = en_US
-minimum_perc = 0
 type = PO
+
+[mixxxdj-manual.glossary_]
+file_filter = source/locale/<lang>/LC_MESSAGES/glossary.po
+source_file = source/locale/pot/glossary.pot
+source_lang = en
+
+[mixxxdj-manual.index]
+file_filter = source/locale/<lang>/LC_MESSAGES/index.po
+source_file = source/locale/pot/index.pot
+source_lang = en
+
+[mixxxdj-manual.index_developer]
+file_filter = source/locale/<lang>/LC_MESSAGES/index_developer.po
+source_file = source/locale/pot/index_developer.pot
+source_lang = en
+
+[mixxxdj-manual.manual_guidelines]
+file_filter = source/locale/<lang>/LC_MESSAGES/manual_guidelines.po
+source_file = source/locale/pot/manual_guidelines.pot
+source_lang = en
+
+[mixxxdj-manual.sphinx]
+file_filter = source/locale/<lang>/LC_MESSAGES/sphinx.po
+source_file = source/locale/pot/sphinx.pot
+source_lang = en
+
+[mixxxdj-manual.todolist]
+file_filter = source/locale/<lang>/LC_MESSAGES/todolist.po
+source_file = source/locale/pot/todolist.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--advanced_topics]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/advanced_topics.po
+source_file = source/locale/pot/chapters/advanced_topics.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--appendix]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/appendix.po
+source_file = source/locale/pot/chapters/appendix.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--configuration]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/configuration.po
+source_file = source/locale/pot/chapters/configuration.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--controlling_mixxx]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/controlling_mixxx.po
+source_file = source/locale/pot/chapters/controlling_mixxx.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--djing_with_mixxx]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/djing_with_mixxx.po
+source_file = source/locale/pot/chapters/djing_with_mixxx.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--getting_involved]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/getting_involved.po
+source_file = source/locale/pot/chapters/getting_involved.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--installation]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/installation.po
+source_file = source/locale/pot/chapters/installation.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--introduction]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/introduction.po
+source_file = source/locale/pot/chapters/introduction.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--library]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/library.po
+source_file = source/locale/pot/chapters/library.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--livebroadcasting]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/livebroadcasting.po
+source_file = source/locale/pot/chapters/livebroadcasting.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--quickstart]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/quickstart.po
+source_file = source/locale/pot/chapters/quickstart.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--setup]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/setup.po
+source_file = source/locale/pot/chapters/setup.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--user_interface]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/user_interface.po
+source_file = source/locale/pot/chapters/user_interface.pot
+source_lang = en
+
+[mixxxdj-manual.chapters--vinyl_control]
+file_filter = source/locale/<lang>/LC_MESSAGES/chapters/vinyl_control.po
+source_file = source/locale/pot/chapters/vinyl_control.pot
+source_lang = en
+

README.md

@@ -12,16 +12,19 @@ First [Download] the latest Mixxx manual source or clone the repository
 
     $ git clone https://github.com/mixxxdj/manual.git
 
-Next, install the dependencies using pip. From within the repository root
+Next, install the dependencies using [pip]. From within the repository root
 (type ```cd manual``` after typing the above command):
 
     $ pip install -r requirements.txt
 
 If you do not wish to use pip:
-* [Install Sphinx], the documentation generator. *Note:* Version 1.3.1 seems to have a bug
-  with graphviz. We suggest using version 1.2.3 until this is resolved.
+* [Install Sphinx], the documentation generator.
 * [Install Graphviz], graph visualization software (used to draw some diagrams)
 
+To upgrade dependencies using pip:
+
+    $ pip install -r requirements.txt --upgrade
+
 If you'd like to build manual PDFs, you will need a functioning LaTeX installation.
 * On Mac, install [MacTeX].
 * On Debian-based systems, install `texlive-fonts-recommended` and
@@ -69,26 +72,35 @@ The Mixxx manual is translated using the [Transifex] web service for team transl
 
 ### Prerequisites
 
-If you did not install requirements with `pip install -r requirements.txt` above
-then you must manually install the following dependencies:
+If you did **not** install requirements with `pip install -r requirements.txt`
+above then you must manually install the following dependencies:
 
 * [sphinx-intl], a utility that makes it easy to translate and compile
   translations to Sphinx projects.
 * [transifex-client]. Transifex allows collaborative translation via a web
   interface. The Python-based command line client makes it easy to fetch and
   push translations.
 
-  Install transifex-client on Linux and Mac OS X
+**Install transifex-client on Linux and macOS**
+
+    $ pip install transifex-client
+
+**Install transifex-client on Windows**
+
+   The easiest way to install it is with pip:
 
-  `pip install transifex-client`
+    $  easy_install pip
+    $  pip install transifex-client
 
-  Install transifex-client on Windows
+  The first line installs pip on a system level. Then it installs the Transifex
+  Client using pip.
 
-  `http://files.transifex.com/transifex-client/0.11b3/tx.exe`
+  If you do not wish to use pip, download the latest releases from
+  https://github.com/transifex/transifex-client/releases
 
-  You will need to make a `.transifexrc` in your home directory with your
-  username and password to use the Transifex client. See
-  [transifex-configuration] for more details.
+You will need to make a `.transifexrc` in your home directory with your
+username and password to use the Transifex client. See
+[transifex-configuration] for more details.
 
 ### Maintaining translations
 
@@ -104,7 +116,7 @@ For every change to the manual source files (.rst) the source translation files
 the text of every English phrase in the manual in a common format used for
 translation.
 
-Additionally, for every new source file added (i.e. new chapters or manaul
+Additionally, for every new source file added (i.e. new chapters or manual
 pages) the Transifex configuration file (stored in `.tx/config`) needs updating.
 
 To do both of these, run:
@@ -190,7 +202,7 @@ For more information on Translating with Sphinx, see [Sphinx i18n].
 
 ### Editors with Restructured Text (reST) syntax highlighting
 
-* Windows, Linux, Mac OSX : [Atom], [Sublime]
+* Windows, Linux, Mac OSX : [Atom], [Visual Studio Code], [Sublime]
 * Linux: [Kate], [Retext]
 * Windows: [Intype]
 * Webapp: [Notex]
@@ -200,6 +212,7 @@ For more information on Translating with Sphinx, see [Sphinx i18n].
 Even more [reStructuredText] resources:
 <http://stackoverflow.com/questions/2746692/restructuredtext-tool-support>
 
+[pip]: https://pip.pypa.io/
 [reStructuredText]: http://docutils.sourceforge.net/rst.html
 [Sphinx]: http://sphinx-doc.org
 [Install Sphinx]: http://sphinx-doc.org/latest/install.html
@@ -208,9 +221,10 @@ Even more [reStructuredText] resources:
 [sphinx-intl]: https://pypi.python.org/pypi/sphinx-intl
 
 [Transifex]: https://www.transifex.com/organization/mixxx-dj-software/dashboard/mixxxdj-manual
-[transifex-client]: http://docs.transifex.com/client/setup/
-[transifex-configuration]: http://docs.transifex.com/client/config/
+[transifex-client]: https://docs.transifex.com/client/installing-the-client
+[transifex-configuration]: https://docs.transifex.com/client/client-configuration/
 [Atom]: https://atom.io/
+[Visual Studio Code]: https://code.visualstudio.com/
 [Sublime]: http://www.sublimetext.com
 [Kate]: http://kate-editor.org/
 [Retext]: http://sourceforge.net/p/retext/

requirements.txt

@@ -1,5 +1,5 @@
 fabric
-sphinx==1.2.3
+sphinx
 sphinx-intl
 graphviz
 pycrypto

source/_templates/layout.html

@@ -5,7 +5,7 @@
     Master layout for Mixxx manual. Adapted from Basic theme.
 
     :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
-    :copyright: Copyright 2011 by the Mixxx Team
+    :copyright: Copyright 2011-2017 by the Mixxx Development Team
     :license: BSD, see LICENSE for details.
 #}
 {%- block doctype -%}