Add User Guide

content/pages/guide/guide-de.rst

@@ -0,0 +1,282 @@
+Luppp
+########
+
+:slug: guide
+:lang: de
+
+.. image:: {static}/images/guide/luppp.png
+   :align: center
+
+Luppp ist ein Programm zur Musikerstellung – vorallem für den Live-Einsatz. Der
+Fokus liegt auf Echtzeitverarbeitung und intuitivem Workflow. Durch
+umfangreiche MIDI-Steuerung wird der Einsatz von Loops zum Kinderspiel! In den
+nächsten Abschnitten wird beschrieben, wie Luppp zusammen mit JACK für
+Audioein- und -ausgabe eingerichtet wird. Außerdem werden die Konzepte von
+Szenen und Clips vorgestellt, sodass du deiner Kreativität freien Lauf lassen
+kannst.
+
+Luppp und JACK
+==============
+
+Wenn dir Luppp und Jack komplett neu sind, schaue dir dieses Beispielvideo an,
+das eine typische Looping-Session mit Luppp zeigt:
+https://www.youtube.com/watch?v=R6WiWDDKRCQ
+
+Bevor du Loops aufnehmen kannst, müssen wir eine Audioquelle mit Luppps
+“master_in”-Anschluss verbinden. Außerdem müssen “master_right” und
+“master_left” mit den Systemanschlüssen (Soundkarte oder Audiointerface)
+verbunden werden. Der folgende Screenshot zeigt die Verbindungen:
+
+.. image:: {static}/images/guide/luppp_jack_connections.png
+   :align: center
+
+Schaue dir nun die Oberfläche von Luppp an. Diese mag auf den ersten Blick
+komplex wirken, ist aber wirklich einfach, wenn man die einzelnen Bereiche
+ersteinmal versteht.
+
+.. image:: {static}/images/guide/luppp_interface.png
+   :align: left
+
+Du siehst acht Tracks mit jeweils zehn Clips. Um zu testen, ob dein Audiosetup
+funktioniert, spiele deine Audioquelle ab und du solltest den Ausschlag auf der
+Anzeige ganz oben rechts sehen. Wenn das klappt, kannst du loslegen!
+
+Nun klicke auf einen Clip, um die Aufnahme zu starten und klicke erneut, um das
+Aufgenommene zu loopen. Alle Aktionen in Luppp werden mit dem Takt
+synchronisiert. Dieser wird durch die vier Quadrate unten rechts angezeigt.  Du
+kannst das Tempo durch Drehen des Reglers mit der BPM-Nummer ändern (der
+Standardwert ist 120).
+
+.. image:: {static}/images/guide/luppp_scenes.png
+	:align: right
+
+Szenen
+======
+
+Ein sehr wichtiges Konzezt von Luppp sind die Szenen. Auf jedem Track kann nur
+ein Clip zur gleichen Zeit abgespielt werden. Im Masterbereich von Luppp
+befindet sich die Liste der Szenen. Eine Szene kann durch Klicken auf den Namen
+gestartet werden, wodurch alle Clips in dieser Reihe gleichzeitig gestartet
+werden.
+
+.. Tip::
+
+   Wenn du Clips mit einer Länge von mehr als einem Takt verwendest, achte
+   darauf, die Aufnahme zur gleichen Zeit mit dem Start der anderen Clips in
+   der Reihe zu starten. Ansonsten kann das Starten einer Szene ein bisschen
+   chaotisch werden ;)
+
+-----
+
+.. image:: {static}/images/guide/luppp_track.png
+   :align: left
+
+Tracks
+======
+
+Alle Tracks in Luppp haben ein paar Regler, um unglaubliche Dinge zu tun. Wir
+gehen diese nun von oben nach unten durch. Ganz oben befindet sich der Name des
+Tracks. Durch Rechtsklick kannst du diesen ändern. Darunter befindet sich ein
+Kreis, der den Fortschritt des momentan abgespielten Loops in diesem Track
+anzeigt. Bei der Aufnahme von weiteren Clips in der selben Reihe ist es sehr
+hilfreich, den Fortschritt im Auge zu behalten. Als nächstes kommen die Clips.
+Auch hier kannst du durch Rechtsklick einen Namen vergeben. Außerdem wird hier
+für jeden Clips der momentane Status angezeigt, ob er gerade aufnimmt, abspielt
+oder leer ist. Unten befindet sich ein Schieberegler (Fader), mit dem die
+Lautstärke des Tracks angepasst werden kann. Um den Fader herum befinden sich
+weitere Regler, die wir uns im nächsten Abschnitt ansehen werden.
+
+.. Tip::
+
+    Du kannst die Tastatur verwenden, um die Clips zu steuern. Die Clips der
+    ersten Szene haben die Tasten 1 – 8, 9 löst die Szene selbst aus. Die
+    darunterliegenden Tastenreihen steuern die folgenden Szenen. Probier’ es
+    aus!
+
+-----
+
+Panning
+=======
+
+Bevor wir uns der Welt der Bearbeitung in Lupp zuwenden, schauen wir uns eine
+einfache, aber wirkungsvolle Funktion an. Es wurde in Version 1.1.1 eingeführt:
+das Panning. Der Regler über dem Fader jeden Tracks kann das Signal zum
+Masterkanal splitten. Du hast also die Möglichkeit, jedem Kanal einen Platz im
+Mix zu geben. Das ist sehr simpel, gehen wir also weiter …
+
+FX-Bereich
+==========
+
+Die Regler direkt unter dem Clip-Bereich sind der Effektbereich. In dem
+JACK-Verbindungsmanager deiner Wahl werden dir die „Send_track_X“- und
+„Return_track_X“-Anschlüsse aufgefallen sein. Die Verbindung des
+„send“-Anschlusses mit dem Eingang eines Plugins und des Ausganges mit dem
+„return“-Anschluss von Luppp leitet das Audiosignal durch dieses Plugin. Um den
+Effekt zu nutzen, klicke auf die gelbe FX-Schaltfläche. Mit dem Drehregler
+kannst du die Lautstärke des Effekts regeln. Diese Funktion gibt dir endlose
+möglichkeiten. Du kannst beliebig viele Effekte hinzufügen, in der Reihenfolge
+deiner Wahl. Sei einfach kreativ!
+
+Halleinbindung
+==============
+
+Diese Funktion gibt dir die großartige Möglichkeit, leicht etwas Hall zu einem
+Track hinzuzufügen. Bevor wir dies ausprobieren können, müssen wir Luppps
+„send_out“-Anschluss mit einem Halleffekt verbinden und
+die Ausgänge des Halls an die „master_return”-Anschlüsse von Luppp. Ist das
+erledigt, können wir den Hall für jeden Track mittels der „Snd”-Schaltfläche
+aktivieren. Mit dem Drehregler darüber kann die Stärke des Halls bestimmt
+werden.
+
+Die Verbindungen für einen Halleffekt sehen wie folgt aus:
+
+.. image:: {static}/images/guide/luppp_reverb_send_connections.png
+   :align: center
+
+.. image:: {static}/images/guide/luppp_reverb_roomy.png
+   :align: right
+
+Die empfohlenen Roomy-Einstellungen sind in diesem Screenshot
+abgebildet: Am wichtigsten ist es, den „Dry/Wet“-Regler auf „100% Wet“ zu
+stellen, da dadurch nur der Hall ohne das originale Signal ausgegeben wird. Da
+das originale Audiosignal bereits von Luppp ausgegeben wird, wollen wir nicht,
+dass der Reverb dies noch zusätzlich tut!
+
+Zu diesem Thema gibt es auch ein video: https://www.youtube.com/watch?v=wLy9oG_WpHg
+
+-----
+
+Sidechaining
+============
+
+Luppp macht die Verwendung von Sidechaining sehr einfach; zum Beispiel das
+Erstellen einer House-Bassline … Das Konzezpt ist einfach: Du verwendest ein
+Audiosignal, um die Manipulation eines anderen Signals zu steuern. Als
+Manipulation könnte ein Kompressor oder ein Enveloper zum
+Einsatz kommen. Wie wird Sidechaining nun verwendet? Zuerst müssen wir wieder
+ein paar Verbindungen herstellen. Luppps „sidechain_key“-Anschluss muss an den
+Sidechain-Eingang und Luppps „sidechain_signal“-Ausgang an den regulären
+Audioeingang von Ducka angeschlossen werden. Verbinde außerdem die
+Ausgänge des Plugins mit den „return“-Anschlüssen von Luppp.
+
+Zurück zu Luppp. Bei einem Track musst du nun die „Key“-Schaltfläche
+aktivieren. Dadurch wird die Ausgabe des Tracks zum Auslöser für den
+Sidechain-Effekt. Mit dem Regler über der „Key“-Schaltfläche kannst du nun
+jeden Track an das Plugin senden. Wenn du dir ansehen willst, wie das
+funktioniert, schaue dir diese Videos an:
+
+* Erklärung: https://www.youtube.com/watch?v=-AwtMUeBc9w
+* Showcase: https://www.youtube.com/watch?v=bPJQs6w2XQc
+
+Eingabebereich
+==============
+
+Am Anfang dieser Anleitung haben wir eine Audioquelle mit dem „master_in“-Kanal
+von Luppp verbunden. Du kannst verschiedene andere Quelle anschließen, jede
+Ausgabe eines Mixers oder was auch immer du dir vorstellen kannst! In der Ecke
+ganz oben rechts der Oberfläche siehst du den Eingabebereich von Luppp.
+
+.. Tip ::
+    Luppp hat nur einen Monoeingang. Wenn du eine Stereoquelle wie einen
+    Synthesizer anschließen willst, gibt es mehrere Möglichkeiten. In den
+    meisten Fällen reicht es aus, nur einen Kanal zu verbinden, da beide Kanäle
+    gleich sind. Wenn du tatsächlich beide Kanäle brauchst, ziehe in betracht,
+    sie mit einem Mixer zu mischen. Einfach beide Kanäle an den selben Ausgang
+    anzuschließen, könnte zu Problemen führen.
+
+Hier gibt es eine Pegelanzeige und einen Fader zur Anpassung der Lautstärke des
+Eingangssignals. Die Regler bewirken folgendes:
+
+.. image:: {static}/images/guide/luppp_inputsection.png
+   :align: left
+
+* „Snd“-Schaltfläche aktiviert die „Send“-Funktion
+* Der Regler darüber regelt die Stärke, z. B. des Halls
+* „Key“-Schaltfläche setzt das Eingangssignal als „Key“-Signal für das Sidechaining
+* Der Regler darüber regelt welcher Anteil als Sidechain-Signal verwendet wird
+* „Mix“-Schaltfläche aktiviert das Weiterleiten des Eingangssignals zum Masterausgang von Luppp
+* Der Regler darüber regelt welcher Anteil zum Masterausgang weitergegeben wird.
+
+Du hast also großartige Möglichkeiten: ein bisschen Hall für den Eingang,
+Verwendung eines Eingangssignals für einen speziellen Sidechaining-Key? Kein
+Problem! Direkt mit Luppp kannst du hören was du spielst und die
+Aufnahmelautstärke an die Lautstärke der anderen Tracks anpassen.
+
+Masterbereich
+=============
+
+.. image:: {static}/images/guide/luppp_master_section.png
+   :align: right
+
+Lasst uns einen Blick auf den letzten Bereich der Oberfläche werfen: den
+Masterbereich. Die Funktion der meisten Elemente ist ziemlich offensichtlich,
+es folgt daher nur eine kurze Erklärung:
+
+* das grüne, gelbe, orangefarbene und rote Quadrat zeigen den Takt an (von unten nach oben)
+* die Stop/Play-Schaltfläche stoppt oder started den Transport
+* mit der „Tap“-Schaltfläche kannst du das Tempo durch Klicken des Taktes einstellen
+* die „Metro“-Schaltfläche aktiviert das Metronom, das über die „headphones_out“-Anschlüsse von Luppp ausgegeben wird (du kannst zwischen verschiedenen Lautstärkeleveln durch Rechtsklick auf die Schaltfläche wählen)
+* der Regler mit der Nummer legt das Tempo fest
+* der „Return“-Regler passt die Lautstärke des zurückgegebenen Audiosignals an (z. B. Hall)
+* der Fader regelt die Lautstärke des Masterkanals
+
+Konfiguration
+=============
+
+Über eine Datei im Konfigurationsordner des Benutzers stellt Luppp
+Konfigurationseinstellungen bereit. Hierüber können ein paar Einstellungen
+geändert werden, die nicht über die GUI zu erreichen sind.
+
+Diese Konfigurationsdatei findet sich unter
+``~/.config/openAV/luppp/luppp.prfs`` und benutzt das `JSON
+<https://en.wikipedia.org/wiki/Json>`_-Format.
+
+Die Voreinstellungen sehen wie folgt aus::
+
+    {
+        "saveDirectory":                "luppp",
+        "resampleQuality":              1,
+        "defaultControllers":           [],
+        "enablePerTrackSendReturns":    0
+    }
+
+Speicherort
+--------------
+
+Die Option ``saveDirectory`` definiert den Ordner, in dem Sessions gespeichert
+werden. Der Pfad ist relativ zum Benutzerverzeichnis und ist standardmäßig
+``luppp``::
+
+    "saveDirectory": "luppp"
+
+Qualität der Abtastratenkonvertierung
+-------------------------------------
+
+Die Qualität der Abtastratenkonvertierung kann über die Einstellung
+``resampleQuality`` definiert werden. Mögliche Werte sind
+
+* 0 = LINEAR
+* 1 = SINC_FASTEST
+* 2 = SINC_BEST
+
+Der Standardwert ist ``SINC_FASTEST`` (``1``)::
+
+    "resampleQuality": 1,
+
+Standard-Controller
+-------------------
+
+Mit der Option ``defaultControllers`` können Controller definiert werden, die
+beim Programmstart automatisch geladen werden. Mehrere Controller können mit
+Komma getrennt angegeben werden::
+
+    "defaultControllers": ["akai_apc.ctlr", "launchpad_s.ctlr"]
+
+Send/Returns pro Track
+----------------------
+
+Die Einstellung ``enablePerTrackSendReturns`` kontrolliert, ob
+Send/Return-Kanäle für jeden Track bereitgestellt werden sollen.
+Ein Wert von ``0`` deaktiviert, ``1`` aktiviert dies::
+
+    "enablePerTrackSendReturns": 0

content/pages/guide/guide-en.rst

@@ -0,0 +1,286 @@
+Guide
+########
+
+:slug: guide
+:lang: en
+
+.. image:: {static}/images/guide/luppp.png
+   :align: center
+
+Luppp is a music creation tool, intended for live use. The focus is on real
+time processing and a fastintuitive workflow. With extensive MIDI mapping
+support, you can get looping just how you like! The next sections will show
+you how to set up Luppp with JACK for audio input and output, and introduce
+the concepts of "Scenes" and "Clips" to let you start arranging your
+creativity for live performances!
+
+Luppp and JACK
+==============
+
+If you are totally new to JACK and Luppp, this is an example video that
+shows what a typical Luppp looping session looks like:
+https://www.youtube.com/watch?v=R6WiWDDKRCQ
+
+Before we can record we need to connect some audio source to Luppps
+master_in and connect master_right and master_left to the output jacks
+of the system. See screenshot of the connections:
+
+.. image:: {static}/images/guide/luppp_jack_connections.png
+   :align: center
+
+Next we will take a look at the Luppp interface, which may seem complex at
+the start, but really it's quite simple once we understand what each part of
+the UI does.
+
+.. image:: {static}/images/guide/luppp_interface.png
+   :align: left
+
+You can see 8 Tracks with each 10 Clips. To check if your setup work
+just play your audio source and you should see the amplitude of the audio
+on the top right meter. If this works, you are ready to go!
+
+Clips
+======
+
+Now click on a Clip to start recording and click again to start looping!
+Right clicking on a clip lets you:
+
+* Load Audio loop in the clip
+* Save the clip
+* Select 'Special' then record,play or stop the clip with space bar
+* Choose the number of beats
+* Use the clip as tempo
+* Rename the clip
+* Clear the clip (can also be done with MIDI Binding)
+
+All actions of Luppp are synced to the Beat, which is indicated by the four
+squares on the bottom right of the window. You can change the tempo by
+turning the knob with the BPM number (which should be 120 by default).
+
+
+.. image:: {static}/images/guide/luppp_scenes.png
+   :align: right
+
+Scenes 
+======
+
+A pretty important concept of Luppp are the scenes. On each track you can
+just play one clip at the same time. In the master section of Luppp you can
+see a list of Scenes. You can launch a scene by clicking on
+it. When you do this, all clips in this row start at the same time.
+
+.. Tip::
+   When you use clips with a length higher than one bar, be careful to
+   start the recording at the same time when other clips in the row are
+   starting. If not, launching a scene will create a little mess ;)
+
+
+-----
+
+.. image:: {static}/images/guide/luppp_track.png
+   :align: left
+
+Tracks
+======
+
+All tracks of Luppp have some controllers to do incredible things. I will
+walk through them from top to bottom. At first, there is the name of the
+track. You can change it by right-clicking on it. Below this,
+there is a circle showing the progress of the playing loop in the track.
+It's pretty useful to look at it when recording other clips in the same row.
+The next thing to come are the clips. You can give them a name with a right
+click, too. They also show the currect status of a clip, if it's recording,
+playing or empty. On the buttom is a fader, which adjust the volume of the
+track mixed to the master. Around the faders there are some controls
+we look at in the next sections.
+
+.. Tip::
+	You can use your keyboard, to control the clips! The first scene
+	are the numbers from 1-8, 9 triggers the first scene. The following
+	rows are binded to the subjacent scenes. Just try!
+
+-----
+
+Panning
+=======
+
+Before we get into the world of processing in Luppp, let’s look on a pretty
+basic but powerful feature. It is introduced by version 1.1.1: The Panning.
+The knob above the fader of each track can split the signal to the two master 
+channels as you want. So you have the possibility to give each channel a place
+in the master mix. This is pretty simple, so let’s move on …
+
+FX Section
+==========
+
+The first controls below the clip section are the effect section. In your 
+JACK connection manager of your choice you will notice the Send_track_X and
+Return_track_X ports. Connecting the send to the input of a JACK client and the
+output back to the returns of Luppp will send the audio through this other JACK client.
+To enable the processing, click on the yellow FX Button. With the knob you can
+adjust the volume of the effect.
+This feature gives you endless possibilities. You could add as many effects as
+you want in any order. Just be creative!
+
+Reverb Send
+===========
+
+This feature gives you the great possibility to simply add some reverb on a
+track. Before we can try, we need to connect Luppps send_out to a reverb of
+our choice and the outputs of the reverb back to Luppps
+master_returns. If it's done, we can enable the reverb for each track with
+the Snd-Button and adjust the amount of reverb with the above knob. 
+
+The connections for a reverb send are as follows:
+
+.. image:: {static}/images/guide/luppp_reverb_send_connections.png
+   :align: center
+
+.. image:: {static}/images/guide/luppp_reverb_roomy.png
+   :align: right
+
+And the recommended Roomy settings are shown here - the most important part
+is to set the Dry/Wet dial to 100% Wet, as then only the reverb is output,
+and the original signal is totally muted. Given that Luppp is already
+outputting the original signal, we do not want the reverb to also do that!
+
+There is a video about this topic, too: https://www.youtube.com/watch?v=wLy9oG_WpHg
+
+-----
+
+Sidechaining
+============
+
+Using Luppp it's very easy to use sidechaining, for example to create some
+house bass lines.. It's a pretty simple concept: you use one audio signal to
+control the processing of another signal. This processing could be a
+compressor or an enveloper. So, how to use it? At first
+we again need to do some connections. Luppps sidechain_key needs to be
+connected to a sidechain input and Luppps sidechain_signal needs to be
+connected to the regular audio inputs of the JACK client.
+Send the outputs of the Ducka JACK client to the master returns.
+
+Back to Luppp. On one track you need to enable the Key-Button. This way the
+output of the track is the trigger for the sidechain effect. Now you can
+send each track with the knob above the Key-Button to JACK. If you
+want to see how it's works, watch these videos: 
+
+* Explanation: https://www.youtube.com/watch?v=-AwtMUeBc9w
+* Showcase: https://www.youtube.com/watch?v=bPJQs6w2XQc
+
+Input Section
+=============
+
+At the beginning of this tutorial we connected an audio source to Luppps master_in. 
+You can input several different sources, or any output of a mixer or what ever you can 
+imagine! In the top right corner of the GUI you can see the Luppp Input Section.
+
+.. Tip ::
+	Luppp only has a mono input. If you want to connect a stereo source like a synthesizer, 
+	there are severel possibilities. In the most cases it's enough to connect just one side since 
+	there are equal or similar. If you need both sides, consider a mixer to mix them together.
+	But there might be some trouble if you simply connect both to the input port.
+
+Here you have a meter, and a fader to adjust the volume of the input. The knobs below
+do the following:
+
+.. image:: {static}/images/guide/luppp_inputsection.png
+   :align: left
+
+* Snd-Button activates the Send
+* Knob above sets the amount, e. g. Reverb
+* Key-Button sets the input as Key-Signal for Sidechaining 
+* Knob above the Key-Button how much of the input goes to the Sidechain-Signal
+* Mix-Button activates the routing of the input to the master outs of Luppp
+* Knob above the Mix-Button sets amount of the input on the master outs.
+
+So you have great possibilities here: a little reverb on the input, using an
+input for a special sidechaining key? Easy! You can monitor what you play just with 
+Luppp and adjust the recorded volume to fit with the other tracks.
+
+Master Section
+==============
+
+.. image:: {static}/images/guide/luppp_master_section.png
+   :align: right
+
+Let’s take a look at the last part of the GUI: the master section. The function of the most elements
+are quite obvious, so i will only explain them in short:
+
+* the green, yellow, orange and red square show the beat (from bottom to top)
+* the Stop/Play button stops or restarts the transport
+* with the tap button you can adjust the tempo by clicking the beat
+* right click on tap button allow to input manually BPM input 
+* the metro button activates a metronom on the headphones_out of Luppp (note that you can choose between a selection of different volume levels by right-clicking on the "metro" button)
+* the knob with the number sets the tempo
+* the return knob adjusts the volume of the returned audio (e. g. reverb)
+* the fader adjusts the master volume
+
+Saving and Loading Sessions
+===========================
+
+.. image:: {static}/images/guide/luppp_load.png
+   :align: right
+
+Loading and saving is done by using the "Luppp" titled menu on the
+top left. Clicking the "Luppp" word opens the menu, allowing to control
+the session (New, Load, Save), setup controllers, and quit the program.
+
+-----
+
+Configuration
+=============
+
+Luppp provides some configuration features in a file under the user's
+config directory. It allows setting some options apart from the GUI.
+
+The file to edit is ``~/.config/openAV/luppp/luppp.prfs`` which uses the
+`JSON <https://en.wikipedia.org/wiki/Json>`_ format.
+
+The default content looks like this::
+
+    {
+        "saveDirectory":                "luppp",
+        "resampleQuality":              1,
+        "defaultControllers":           [],
+        "enablePerTrackSendReturns":    0
+    }
+
+Save Directory
+--------------
+
+The option ``saveDirectory`` defines the directory where sessions are stored.
+The path is relative to the user’s home directory and defaults to ``luppp``::
+
+    "saveDirectory": "luppp"
+
+Resample Quality
+----------------
+
+The quality for resampling can be defined with the ``resampleQuality`` key.
+Possible values are:
+
+* 0 = LINEAR
+* 1 = SINC_FASTEST
+* 2 = SINC_BEST
+
+The default value is ``SINC_FASTEST`` (``1``)::
+
+    "resampleQuality": 1,
+
+Default Controllers
+-------------------
+
+The ``defaultControllers`` option allows to specify which controllers are
+loading automatically at startup. Note that multiple controllers can be added,
+listed as separate strings with a comma inbetween::
+
+    "defaultControllers": ["akai_apc.ctlr", "launchpad_s.ctlr"]
+
+Enable Per Track Send/Returns
+-----------------------------
+
+The option ``enablePerTrackSendReturns`` controls if send/return channels will
+be enabled for each track. A value of ``0`` disabled, ``1`` enables it::
+
+    "enablePerTrackSendReturns": 0

content/pages/guide/guide-fr.rst

@@ -0,0 +1,182 @@
+Luppp
+########
+
+:slug: guide
+:lang: fr
+
+.. image:: {static}/images/guide/luppp.png
+   :align: center
+
+Luppp est un outil de création musicale, destiné à l’utilisation en direct (live). 
+L’objectif principal est le traitement en temps réel ainsi qu’une utilisation rapide et intuitive. 
+Avec un support étendu du mappage midi, vous pouvez gérer les boucles comme vous aimez ! 
+Les paragraphes suivants vous expliqueront comment connecter Luppp avec Jack pour les entrées et sorties audio et vous présenteront les concepts de "scènes" et de "clips" pour utiliser votre créativité pour des performances en direct !
+
+Luppp et JACK
+=============
+
+Si vous débutez avec Jack et Luppp, voici un exemple en vidéo qui vous montre à quoi ressemble une session d’utilisation typique de boucles dans Luppp :
+https://www.youtube.com/watch?v=R6WiWDDKRCQ
+
+Avant de pouvoir enregistrer, il faut connecter les sources audio aux entrées principales (master_in_left et master_in_right) de Luppp et connecter les sorties principales (master_left et master_right) aux sorties du système (playback_1 et playback_2). Voir la capture d’écran des connexions :
+
+.. image:: {static}/images/guide/luppp_jack_connections.png
+   :align: center
+
+Ensuite, nous jeterons un œil à l'interface de Luppp, qui peut sembler complexe au départ, 
+mais qui est vraiment plutôt simple une fois que l'on comprend à quoi sert chaque partie de l'interface graphique.
+
+.. image:: {static}/images/guide/luppp_interface.png
+   :align: left
+
+Vous pouvez voir 8 pistes contenant 10 clips chacune. Afin de vérifier que votre configuration fonctionne, 
+faites jouer votre source audio et vous devriez voir l'amplitude de l’audio dans le vu-mètre en haut à droite de l’interface. Si cela fonctionne, vous êtes prêt !
+
+Clips 
+======
+
+Maintenant, cliquez sur un clip pour démarrer l’enregistrement puis cliquez une nouvelle fois 
+pour lancer la lecture en boucle ! 
+Un clic droit sur un clip vous propose de :
+
+* Charger une boucle audio dans le clip
+* Sauvegarder le clip
+* Sélectionner 'Spécial' afin d'enregistrer, lire ou arrêter le clip avec la barre d'espace.
+* Choisir le nombre de battements du clip
+* Utiliser le clip comme tempo
+* Renommer le clip
+* Effacer le clip (peut aussi être fait avec MIDI Binding)
+
+Toutes les actions de Luppp sont synchronisées à la pulsation,
+qui est indiqué par les quatre carrés en bas à droite de la fenêtre. 
+Vous pouvez changer le tempo en tournant le bouton dans lequel est indiqué le nombre de BPM 
+(qui doit être à 120 par défaut).
+
+.. image:: {static}/images/guide/luppp_scenes.png
+	:align: right
+
+Scènes 
+======
+
+Un concept de Luppp plutôt important est les ‘scènes’. Dans chaque piste, vous pouvez seulement jouer un clip à la fois. 
+la section ‘Master’ de Luppp, vous pouvez voir une liste de ’scènes’. Vous pouvez lancer une scène en cliquant dessus. 
+Quand vous faites cela, tous les clips de cette ligne commencent en même temps.
+
+.. Tip::
+   Quand vous utilisez des clips dont la longueur est supérieur à une mesure, 
+   faites attention à démarrer l’enregistrement en même temps que les autres clips de la ligne qui sont lancés. 
+   Sinon, lancer une scène créera un peu de désordre ;)
+
+-----
+
+.. image:: {static}/images/guide/luppp_track.png
+   :align: left
+
+Pistes
+======
+
+Toutes les pistes de Luppp possèdent des contrôleurs faisant des choses incroyables. Nous allons les passer en revue à partir du haut vers le bas. Premièrement, il y a le nom de la piste. Vous pouvez le modifier en cliquant-droit dessus. En dessous, se trouve un cercle affichant la progression de la lecture de la boucle dans la piste. C'est plutôt utile de le regarder lors de l'enregistrement d'autres clips dans la même ligne. La chose suivante est "les clips". Vous pouvez leurs donner un nom avec un clic-droit également. Ils affichent également le statut correct d'un clip, s'il est en train d'enregistrer, d'être lu, ou vide. En bas, il y a un chariot qui ajuste le volume de la piste mixé dans le master. Sur la gauche des chariots, se trouvent certains contrôles que nous décrirons dans les sections suivantes.
+
+.. Tip::
+	Vous pouvez utiliser votre clavier alpha-numérique pour contrôler les clips ! 
+	La première scène est représentée par les nombres de 1 à 8, le 9 déclenche la première scène.
+	Les lignes suivantes sont branchées sur les scènes sous-jacentes. Essayez !
+
+-----
+
+
+Panoramisation
+==============
+
+Avant de rentrer dans le monde du traitement dans Luppp, regardons une fonctionnalité plutôt basique mais puissante. Elle est arrivée avec la version 1.1.1 : la panoramisation. Le bouton au dessus de chaque piste peut diviser le signal en deux canaux maître si vous le souhaitez. Vous avez ainsi la possibilité de placer chaque canal dans le mixage général. Ceci est plutôt simple, donc on continue…
+
+Section effets spéciaux
+=======================
+
+Les premiers contrôle en dessous de la section de clip sont la section d'effet. Dans le gestionaire de connexion JACK de votre choix, vous verrez des ports Send_track_X et Return_track_X. En connectant le send à l'entrée d'un client JACK et la sortie dans les retours de Luppp enverra l'audio à travers cet autre client JACK. Pour activer le traitement, cliquez sur le bouton FX jaune. Avec le bouton, vous pouvez ajuster le volume de l'effet. Cette fonctionnalité vous offre des possibilités infines. Vous pourriez avoir autant d'effets que vous le voulez dans n'importe quel ordre. Soyez créatifs !
+
+
+Envoi de réverb'
+================
+
+Cette fonctionnalité vous offre la possibilité d'ajouter simplement de la réverbération sur une piste. Avant de pouvoir essayer ceci, nous devons connecter les send_out de Luppp à une réverb' de notre choix et les sorties de la réverb' en retour dans les master_returns de Luppp. Lorsque c'est fait, nous pouvons activer la réverb' pour chaque piste avec le bouton Snd-Button et ajuster la quantité de réverb' avec le bouton rotatif au dessus.
+
+Les connexions pour un envoi de réverb' sont comme suit :
+
+.. image:: {static}/images/guide/luppp_reverb_send_connections.png
+   :align: center
+
+.. image:: {static}/images/guide/luppp_reverb_roomy.png
+   :align: right
+
+Et les paramètres recommandés pour Roomy sont affichés ici - la partie la plus importante est de paramétrer le bouton Dry/Wet (original/traité) à 100% Wet, ainsi seule la réverb' ressort, et le signal original est complètement mis en sourdine. 
+Étant donné que Luppp sort déjà le signal original, nous ne voulons pas que la réverb' le fasse aussi !
+
+Il y a une vidéo (en anglais) à ce sujet: https://www.youtube.com/watch?v=wLy9oG_WpHg
+
+-----
+
+Chaînage latéral
+================
+
+Il est très facile de pratiquer un chaînage latéral (NdT : "sidechaining" en anglais) en utilisant Luppp, 
+par exemple pour créer des lignes de basse house. Le concept est plutôt simple : vous utilisez un signal audio pour contrôler le traitement d'un autre signal. 
+Ce traitement peut être un compresseur ou un enveloppeur. Alors, comment l'utiliser ?
+Premièrement, nous devons ici aussi faire des connexions. Les sidechain_key de Luppp doivent être connectés à une entrée de chaînage latéral et les sidechain_signal de Luppp doivent être connectés aux entrées audio régulières du client JACK Ducka. 
+Envoyez les sorties du client JACK Ducka aux sorties master.
+
+Retour à Luppp. Sur une piste, vous devez activer le bouton "Key". Ce faisant, la sortie de la piste est le déclencheur de l'effet de chaînage latéral. Maintenant, vous pouvez envoyer chaque piste avec le bouton rotatif au dessus du bouton "Key" 
+vers JACK. Si vous souhaitez voir comment ceci fonctionne, regardez ces vidéos (en anglais) : 
+
+* Explication: https://www.youtube.com/watch?v=-AwtMUeBc9w
+* Démonstration: https://www.youtube.com/watch?v=bPJQs6w2XQc
+
+La section d'entrée
+===================
+
+Au début de ce tutoriel, nous avons connecté une source audio aux master_in de Luppp. 
+Vous pouvez connecter plusieurs entrées de differentes sources, ou chaque sortie d'un mixeur, ou tout ce que pouvez imaginer ! Dans le coin droit supérieur de l'interface, vous pouvez voir la section d'entrée de Luppp.
+
+Ici, vous avez un vu-mètre, et un chariot pour ajuster le volume des entrées. 
+Les boutons en dessous font les choses suivantes :
+
+.. image:: {static}/images/guide/luppp_inputsection.png
+   :align: left
+
+* le bouton "Snd" active l'envoi (le bouton ci-dessus dose la quantité, comme la réverb') 
+* le bouton "Key" défini les entrées comme signal source pour le chaînage latéral 
+* le bouton au dessus du bouton "Key" règle la quantité de signal pour le chaînage latéral
+* le bouton "Mix" active le routage des entrées vers les sorties principales de Luppp 
+* le bouton au dessus du bouton "Mix" règle la quantité de signal des entrées dans les sorties principales 
+
+Vous avez donc de grandes possibilités : une petite réverb' sur les entrées, utiliser des entrées pour un chaînage latéral special ? Facile! Vous pouvez surveiller ce que vous jouez avec Luppp et ajuster le volume enregistré 
+pour l'adapter aux autres pistes.
+
+La section Master
+=================
+
+.. image:: {static}/images/guide/luppp_master_section.png
+   :align: right
+
+Jetez un oeil à la dernière partie de l'interface : la section master. 
+Les fonctions de la plupart des éléments sont vraiment évidents, donc je les expliquerai rapidement :
+
+* les carrés vert, jaune, orange et rouge montrent le battement (de bas en haut) 
+* le bouton "Stop/Play" arrête ou redémarre la lecture 
+* avec le bouton "Tap", vous pouvez ajuster le tempo en cliquant la pulsation 
+* un clic droit sur le bouton TAP permet d'entrer manuellement les données du BPM
+* le bouton "Metro" active le métronome dans les sorties casque (headphones_out) de Luppp (notez que vous pouvez choisir entre une sélection de différents niveaux de volume en cliquant-droit sur le bouton "Metro") 
+* le bouton avec les chiffres indique le tempo 
+* le bouton "Return" ajuste le volume du retour audio (comme la réverb')
+* le chariot ajuste le volume principal. 
+
+Configuration
+=============
+
+Luppp fournit quelques fonctionnalités de configuration dans un fichier se trouvant dans le répertoire de configuration de l'utilisateur. Il permet de mettre des contrôleurs par défaut en les ajoutant à la liste des contrôleurs par défaut, comme indiqué ci dessous. Notez bien que plusieurs contrôleurs peuvent être ajoutés, listés comme des shaines séparées avec une virgule intercalée entre eux.
+
+Le fichier à éditer est:
+``~/.config/openAV/luppp/luppp.prfs``
+
+notamment, mettez à jour cette ligne qui contient  le nom du fichier de votre contrôleur par défaut :
+``"defaultControllers":   ["akai_apc.ctlr"],``

content/wtf-why-the-fork.md

@@ -8,7 +8,7 @@ Luppp is a fantastic tool and has a great potential. Its built in a lot of spare
 You are great!
 
 Sadly there are no active developers anymore, but me. In the last months there were only Commits made by me. As you might
-now Luppp is part of a bigger Software suite, brought to you by openAVproductions. This causes some restrictions for Luppp in 
+know Luppp is part of a bigger Software suite, brought to you by openAVproductions. This causes some restrictions for Luppp in 
 the presentation and hosting of the project and its infrastructure. With forking the project I can get rid of them.
 
 I used the new possibilities to move the project to [a self-hosted Gitlab instance](https://git.netzspielplatz.de/soundship/loopp) (thanks [Micha](https://micha.stoecker.me/) for it), configured a Gitlab CI 

pelicanconf.py

@@ -23,7 +23,7 @@ AUTHOR_FEED_RSS = None
 
 # Blogroll
 LINKS = (('Blog', '/blog.html'),
-        ('User Guide', '/pages/guide/guide.html'),
+        ('User Guide', '/pages/guide.html'),
         ('OpenAV Productions', 'http://openavproductions.com/'),)
 
 # Social widget
@@ -33,7 +33,7 @@ SOCIAL = (('You can add links in your config file', '#'),
 DEFAULT_PAGINATION = 10
 
 # Uncomment following line if you want document-relative URLs when developing
-#RELATIVE_URLS = True
+RELATIVE_URLS = True
 
 # Landing Page Content
 

themes/Loopp/static/css/style.css

@@ -87,6 +87,25 @@ a.pure-button-primary {
     margin-top: 60px;
 }
 
+.admonition {
+    background-color: rgba(255, 153, 0, 0.2);
+    padding: 0px 10px;
+    margin: 0px;
+}
+
+.admonition-title {
+    background-color: rgba(255, 153, 0, 0.7);
+    color: #ffffff;
+    margin: 0px -10px !important;
+    padding: 4px;
+    padding-left: 10px !important;
+}
+
+.admonition p {
+    margin: 0px;
+    padding: 4px;
+}
+
 address {
     display: inline;
 }
@@ -114,4 +133,16 @@ code {
     background-color: rgba(27, 31, 35, .05);
     color: black;
     font-family: "Menlo", "DejaVu Sans Mono", "Liberation Mono", "Consolas", "Ubuntu Mono", "Courier New", "andale mono", "lucida console", monospace;
+}
+
+hr {
+    color: #ff9900;
+}
+
+ul.translations {
+    list-style-type: none;
+}
+
+li.translations {
+    display: inline-block;
 }

themes/Loopp/templates/page.html

@@ -5,7 +5,15 @@
         <h2 class="content-head is-center">{{ page.title }}</h2>
 
         <div class="pure-g">
-            <div class="l-box-lrg pure-u-md-1-5"></div>
+            <div class="l-box-lrg pure-u-md-1-5">
+                <ul class="translations">
+                    {% if page.translations %}
+                        {% for t in page.translations %}
+                            <li class="translations"><a href="{{ t.url }}">[{{ t.lang }}]</a></li>
+                        {% endfor %}
+                    {% endif %}
+                </ul>
+            </div>
             <div class="l-box-lrg pure-u-1 pure-u-md-3-5">
                 {{ page.content }}
             </div>