Browse Source

Update documentation

master
Nils 4 years ago
parent
commit
30c9436c6e
  1. 9
      README.md
  2. 17
      documentation/english.adoc
  3. 98
      documentation/out/english.html
  4. 2
      documentation/out/german.html

9
README.md

@ -1,19 +1,20 @@
#Patroneo
For program version 1.3
Program version 1.3
Patroneo (which is Esperanto for "Pattern") is an easy to use pattern based midi sequencer that
handles the three most important musical parameters: pitch, rhythm and dynamics.
Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a
program that sends digital "notes" to software instruments such as synthesizers and samplers.
Patroneo is primarily designed for educational purposes, where the main goal is to teach the
importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
you can use to create real music. The constraints it presents will more likely boost your
creativity than suppressing it.
Workflow summary: You have tracks with one pattern each. Turn on steps in the pattern to play
You have tracks with one pattern each. Turn on steps in the pattern to play
musical notes. Switch the patterns on and off in a sequence to create a song structure.
Connect external synthesizers and samplers to create sounds.
This README is just a short introduction. Consult the manual (see below) for more information.
# Contact and Information

17
documentation/english.adoc

@ -27,18 +27,21 @@ https://asciidoctor.org/docs/user-manual/
// Don't write in the empty line above line. It will be interpreted as author html tag
For program version 1.3
== Usage
== Introduction
We are happy you chose Patroneo. Patroneo is an easy-to-use sequencer, a program that sends digital "notes" to software instruments such as synthesizers and samplers.
Patroneo means "pattern" in Esperanto. The reason for this is that you don't put single notes in a row but build whole measures, which you can repeat - or leave out - at any place.
Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a
program that sends digital "notes" to software instruments such as synthesizers and samplers.
== How to use Patroneo
The following explains how to use Patroneo.
Patroneo is primarily designed for educational purposes, where the main goal is to teach the
importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
you can use to create real music. The constraints it presents will more likely boost your
creativity than suppressing it.
The program is almost exclusively operated with the mouse. You need three mouse buttons and a mouse wheel. Most of the time the mouse wheel itself is the middle mouse button, and you can press it down.
You have tracks with one pattern each. Turn on steps in the pattern to play
musical notes. Switch the patterns on and off in a sequence to create a song structure.
Connect external synthesizers and samplers to create sounds.
We encourage you to experiment a lot. Very often good music is created when users have not only used programs as it was intended.
=== Quick Start
To get to know the most important functions and workflows, this video has been created.

98
documentation/out/english.html

@ -445,35 +445,34 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_usage">1. Usage</a></li>
<li><a href="#_how_to_use_patroneo">2. How to use Patroneo</a>
<li><a href="#_introduction">1. Introduction</a>
<ul class="sectlevel2">
<li><a href="#_quick_start">2.1. Quick Start</a></li>
<li><a href="#_basic_principles">2.2. Basic Principles</a></li>
<li><a href="#_keyboard_controls">2.3. Keyboard Controls</a></li>
<li><a href="#_quick_start">1.1. Quick Start</a></li>
<li><a href="#_basic_principles">1.2. Basic Principles</a></li>
<li><a href="#_keyboard_controls">1.3. Keyboard Controls</a></li>
</ul>
</li>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">3. Description of the graphical user interface and its functions</a>
<li><a href="#_description_of_the_graphical_user_interface_and_its_functions">2. Description of the graphical user interface and its functions</a>
<ul class="sectlevel2">
<li><a href="#_toolbar">3.1. Toolbar</a></li>
<li><a href="#_form_editor">3.2. Form Editor</a></li>
<li><a href="#_pattern_editor">3.3. Pattern Editor</a>
<li><a href="#_toolbar">2.1. Toolbar</a></li>
<li><a href="#_form_editor">2.2. Form Editor</a></li>
<li><a href="#_pattern_editor">2.3. Pattern Editor</a>
<ul class="sectlevel3">
<li><a href="#_pattern_context_menu">3.3.1. Pattern Context Menu</a></li>
<li><a href="#_duration_and_volume">3.3.2. Duration and Volume</a></li>
<li><a href="#_pitches_and_scales">3.3.3. Pitches and Scales</a></li>
<li><a href="#_shadows">3.3.4. Shadows</a></li>
<li><a href="#_pattern_context_menu">2.3.1. Pattern Context Menu</a></li>
<li><a href="#_duration_and_volume">2.3.2. Duration and Volume</a></li>
<li><a href="#_pitches_and_scales">2.3.3. Pitches and Scales</a></li>
<li><a href="#_shadows">2.3.4. Shadows</a></li>
</ul>
</li>
<li><a href="#_grouping_in_the_pattern">3.4. Grouping in the Pattern</a></li>
<li><a href="#_grouping_in_the_pattern">2.4. Grouping in the Pattern</a></li>
</ul>
</li>
<li><a href="#_installation_and_start">4. Installation and Start</a></li>
<li><a href="#_help_and_development">5. Help and Development</a>
<li><a href="#_installation_and_start">3. Installation and Start</a></li>
<li><a href="#_help_and_development">4. Help and Development</a>
<ul class="sectlevel2">
<li><a href="#_testing_and_reporting_errors">5.1. Testing and Reporting Errors</a></li>
<li><a href="#_programming">5.2. Programming</a></li>
<li><a href="#_translations">5.3. Translations</a></li>
<li><a href="#_testing_and_reporting_errors">4.1. Testing and Reporting Errors</a></li>
<li><a href="#_programming">4.2. Programming</a></li>
<li><a href="#_translations">4.3. Translations</a></li>
</ul>
</li>
</ul>
@ -488,30 +487,25 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</div>
</div>
<div class="sect1">
<h2 id="_usage">1. Usage</h2>
<h2 id="_introduction">1. Introduction</h2>
<div class="sectionbody">
<div class="paragraph">
<p>We are happy you chose Patroneo. Patroneo is an easy-to-use sequencer, a program that sends digital "notes" to software instruments such as synthesizers and samplers.</p>
<p>Patroneo (which is Esperanto for "Pattern") is an easy to use, pattern based midi sequencer, a
program that sends digital "notes" to software instruments such as synthesizers and samplers.</p>
</div>
<div class="paragraph">
<p>Patroneo means "pattern" in Esperanto. The reason for this is that you don&#8217;t put single notes in a row but build whole measures, which you can repeat - or leave out - at any place.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_how_to_use_patroneo">2. How to use Patroneo</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following explains how to use Patroneo.</p>
</div>
<div class="paragraph">
<p>The program is almost exclusively operated with the mouse. You need three mouse buttons and a mouse wheel. Most of the time the mouse wheel itself is the middle mouse button, and you can press it down.</p>
<p>Patroneo is primarily designed for educational purposes, where the main goal is to teach the
importance of patterns and repetitions in any kind of music. However, Patroneo is a full sequencer
you can use to create real music. The constraints it presents will more likely boost your
creativity than suppressing it.</p>
</div>
<div class="paragraph">
<p>We encourage you to experiment a lot. Very often good music is created when users have not only used programs as it was intended.</p>
<p>You have tracks with one pattern each. Turn on steps in the pattern to play
musical notes. Switch the patterns on and off in a sequence to create a song structure.
Connect external synthesizers and samplers to create sounds.</p>
</div>
<div class="sect2">
<h3 id="_quick_start">2.1. Quick Start</h3>
<h3 id="_quick_start">1.1. Quick Start</h3>
<div class="paragraph">
<p>To get to know the most important functions and workflows, this video has been created.</p>
</div>
@ -532,7 +526,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_basic_principles">2.2. Basic Principles</h3>
<h3 id="_basic_principles">1.2. Basic Principles</h3>
<div class="paragraph">
<p>Patroneo organizes its music in tracks that contain measures. All measures of a track play the same "pattern" that creates music through a sequence of "steps".</p>
</div>
@ -553,7 +547,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect2">
<h3 id="_keyboard_controls">2.3. Keyboard Controls</h3>
<h3 id="_keyboard_controls">1.3. Keyboard Controls</h3>
<div class="paragraph">
<p>In principle, Patroneo can be operated with the mouse. The keyboard is needed for only a few functions, such as changing track names or setting half-tone transposition. However, the keyboard makes some workflows faster and more convenient.</p>
</div>
@ -575,7 +569,7 @@ Your browser does not support the video tag.
</div>
</div>
<div class="sect1">
<h2 id="_description_of_the_graphical_user_interface_and_its_functions">3. Description of the graphical user interface and its functions</h2>
<h2 id="_description_of_the_graphical_user_interface_and_its_functions">2. Description of the graphical user interface and its functions</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Use your browser&#8217;s search function to locate the individual letters like [B] and their explanation.</p>
@ -589,7 +583,7 @@ Your browser does not support the video tag.
<p>Patroneo consists of three parts: The Toolbar, the Form Editor, and the Pattern Editor. Between form- and pattern editor there is a <strong>[L] Handle</strong> which you can grab with the left mouse button and move it up or down to give more space to one or the other area.</p>
</div>
<div class="sect2">
<h3 id="_toolbar">3.1. Toolbar</h3>
<h3 id="_toolbar">2.1. Toolbar</h3>
<div class="paragraph">
<p>The <strong>[A] Toolbar</strong> combines various commands with properties of the entire piece.</p>
</div>
@ -627,7 +621,7 @@ If the checkbox is activated, the specified tempo is considered to be beats per
</div>
</div>
<div class="sect2">
<h3 id="_form_editor">3.2. Form Editor</h3>
<h3 id="_form_editor">2.2. Form Editor</h3>
<div class="paragraph">
<p>In the <strong>[B] Form Editor</strong> you create the structure of a piece. To do this, the measures in each track can be switched on and off as desired. One can imagine, for example, a drum set that plays three bars in a row and makes a "break" every fourth bar. For this common drum technique you need two tracks. In the screenshot this "3+1" pattern can be seen in the third section (bars 17 to 24) in the orange bass track.<br>
Whole parts (e.g. verse and chorus) are implemented by using different tracks. To make the creation of related tracks as comfortable as possible, the "clone" command exists (see letter D).</p>
@ -703,7 +697,7 @@ However, if the scale is chosen freely, there are non-intuitive outcomes; "up an
</div>
</div>
<div class="sect2">
<h3 id="_pattern_editor">3.3. Pattern Editor</h3>
<h3 id="_pattern_editor">2.3. Pattern Editor</h3>
<div class="paragraph">
<p>The <strong>[C] Pattern Editor</strong> is used for composing. The tones, also called "steps", are used to form a measure. The pattern is exactly as long as a measure and is played from left to right. There are several possibilities for tonal arrangement, which are now explained.</p>
</div>
@ -720,7 +714,7 @@ However, if the scale is chosen freely, there are non-intuitive outcomes; "up an
<p>The pattern itself is arranged in rows and columns. The rows symbolise the (adjustable) pitches, the columns show their rhythmic sequence and position in time.</p>
</div>
<div class="sect3">
<h4 id="_pattern_context_menu">3.3.1. Pattern Context Menu</h4>
<h4 id="_pattern_context_menu">2.3.1. Pattern Context Menu</h4>
<div class="paragraph">
<p>A right click on a step opens a context menu that provides the following exclusive functions.
For all functions that reverse or invert ("On" becomes "Off" and vice versa), please note that all volume information (see below) is lost.</p>
@ -758,7 +752,7 @@ For all functions that reverse or invert ("On" becomes "Off" and vice versa), pl
</div>
</div>
<div class="sect3">
<h4 id="_duration_and_volume">3.3.2. Duration and Volume</h4>
<h4 id="_duration_and_volume">2.3.2. Duration and Volume</h4>
<div class="paragraph">
<p>A <strong>[S] Step</strong> is a grey or coloured box. Grey means pause, coloured means <strong>[T] Sounding Tone</strong>. A click with the left mouse button switches the steps on and off.<br>
A right click opens the context menu. Here you can switch all (currently visible) steps on, off or invert all: Off On becomes Off and vice versa. All volume information (see below) will be lost.</p>
@ -780,7 +774,7 @@ A right click opens the context menu. Here you can switch all (currently visible
</div>
</div>
<div class="sect3">
<h4 id="_pitches_and_scales">3.3.3. Pitches and Scales</h4>
<h4 id="_pitches_and_scales">2.3.3. Pitches and Scales</h4>
<div class="paragraph">
<p>Click with the middle mouse button on a step to hear the sound it plays. This allows you to "pre-listen" before you decide to set a note. Tip: Hold down the middle mouse button and move the mouse up and down the steps.</p>
</div>
@ -809,7 +803,7 @@ If you select a scale from the list, it will be built upon the bottom row. As a
</div>
</div>
<div class="sect3">
<h4 id="_shadows">3.3.4. Shadows</h4>
<h4 id="_shadows">2.3.4. Shadows</h4>
<div class="paragraph">
<p>Often you want to add more tones to an existing track in a different pattern. A second voice, question/answer technique etc.
To help you, it is possible to display other tracks as <strong>[2] Shadows</strong>. Just click with the middle mouse button on the track you want to see. This is only possible in the measure area, not on the track name or on the timeline.</p>
@ -820,7 +814,7 @@ To help you, it is possible to display other tracks as <strong>[2] Shadows</stro
</div>
</div>
<div class="sect2">
<h3 id="_grouping_in_the_pattern">3.4. Grouping in the Pattern</h3>
<h3 id="_grouping_in_the_pattern">2.4. Grouping in the Pattern</h3>
<div class="paragraph">
<p>Grouping is part of the time signature.</p>
</div>
@ -942,7 +936,7 @@ To help you, it is possible to display other tracks as <strong>[2] Shadows</stro
</div>
</div>
<div class="sect1">
<h2 id="_installation_and_start">4. Installation and Start</h2>
<h2 id="_installation_and_start">3. Installation and Start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Patroneo is exclusive for Linux. The best way to install is to use your package manager.
@ -1029,13 +1023,13 @@ be helpful for testing and development.</p>
</div>
</div>
<div class="sect1">
<h2 id="_help_and_development">5. Help and Development</h2>
<h2 id="_help_and_development">4. Help and Development</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can help Patroneo in several ways: Testing and reporting errors, translating, marketing, support, programming and more.</p>
</div>
<div class="sect2">
<h3 id="_testing_and_reporting_errors">5.1. Testing and Reporting Errors</h3>
<h3 id="_testing_and_reporting_errors">4.1. Testing and Reporting Errors</h3>
<div class="paragraph">
<p>If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.
We are thankful for any help.</p>
@ -1059,14 +1053,14 @@ We are thankful for any help.</p>
</div>
</div>
<div class="sect2">
<h3 id="_programming">5.2. Programming</h3>
<h3 id="_programming">4.2. Programming</h3>
<div class="paragraph">
<p>If you want to do some programming and don&#8217;t know where to start please get in contact with us directly.
The short version is: clone the git, change the code, create a git patch or point me to your public git.</p>
</div>
</div>
<div class="sect2">
<h3 id="_translations">5.3. Translations</h3>
<h3 id="_translations">4.3. Translations</h3>
<div class="paragraph">
<p>Patroneo is very easy to translate with the help of the Qt-Toolchain, without any need for programming.
The easiest way is to contact the developers and they will setup the new language.</p>
@ -1169,7 +1163,7 @@ The program is split in two parts. A shared "template" between the Laborejo Soft
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-10-03 11:41:31 +0200
Last updated 2019-10-04 23:57:53 +0200
</div>
</div>
</body>

2
documentation/out/german.html

@ -1177,7 +1177,7 @@ Ansonsten starten Sie patroneo mit diesem Befehl, Sprachcode ändern, vom Termin
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-10-03 11:41:31 +0200
Last updated 2019-10-04 23:57:53 +0200
</div>
</div>
</body>

Loading…
Cancel
Save