Browse Source

initial commit, mostly template

tags/v1.5
Nils 1 year ago
commit
5e6876d122
50 changed files with 9103 additions and 0 deletions
  1. +1
    -0
      .gitignore
  2. +4
    -0
      .gitmodules
  3. +674
    -0
      LICENSE
  4. +36
    -0
      README.md
  5. +5
    -0
      configure
  6. +13
    -0
      desktop/desktop.desktop
  7. BIN
      desktop/icon32x32.png
  8. +430
    -0
      documentation/LICENSE
  9. +7
    -0
      documentation/README.txt
  10. +18
    -0
      documentation/build-documentation.sh
  11. +291
    -0
      documentation/english.adoc
  12. BIN
      documentation/favicon.ico
  13. BIN
      documentation/favicon.png
  14. +297
    -0
      documentation/german.adoc
  15. +30
    -0
      documentation/index.adoc
  16. +1078
    -0
      documentation/out/english.html
  17. BIN
      documentation/out/favicon.ico
  18. BIN
      documentation/out/favicon.png
  19. +1080
    -0
      documentation/out/german.html
  20. +459
    -0
      documentation/out/index.html
  21. BIN
      documentation/out/overview-english.png
  22. BIN
      documentation/out/overview-german.png
  23. BIN
      documentation/overview-english.png
  24. BIN
      documentation/overview-german.png
  25. BIN
      documentation/overview.xcf
  26. +31
    -0
      engine/__init__.py
  27. +25
    -0
      engine/api.py
  28. +40
    -0
      engine/config.py
  29. +50
    -0
      engine/main.py
  30. +9
    -0
      patroneo
  31. +0
    -0
      qtgui/__init__.py
  32. +39
    -0
      qtgui/designer/mainwindow.py
  33. +42
    -0
      qtgui/designer/mainwindow.ui
  34. +82
    -0
      qtgui/mainwindow.py
  35. +4087
    -0
      qtgui/resources.py
  36. BIN
      qtgui/resources/aboutlogo.png
  37. +4
    -0
      qtgui/resources/buildresources.sh
  38. BIN
      qtgui/resources/icon.png
  39. BIN
      qtgui/resources/loop.png
  40. +85
    -0
      qtgui/resources/loop.svg
  41. BIN
      qtgui/resources/playpause.png
  42. +79
    -0
      qtgui/resources/playpause.svg
  43. +10
    -0
      qtgui/resources/resources.qrc
  44. BIN
      qtgui/resources/tostart.png
  45. +78
    -0
      qtgui/resources/tostart.svg
  46. +2
    -0
      qtgui/resources/translations/config.pro
  47. BIN
      qtgui/resources/translations/de.qm
  48. +11
    -0
      qtgui/resources/translations/de.ts
  49. +5
    -0
      qtgui/resources/translations/update.sh
  50. +1
    -0
      template

+ 1
- 0
.gitignore View File

@@ -0,0 +1 @@
template/gitignore.template

+ 4
- 0
.gitmodules View File

@@ -0,0 +1,4 @@
[submodule "template"]
path = template
url = ssh://laborejo/~/lss/template.git
branch = master

+ 674
- 0
LICENSE View File

@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Preamble

The GNU General Public License is a free, copyleft license for
software and other kinds of works.

The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.

When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.

Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and
modification follow.

TERMS AND CONDITIONS

0. Definitions.

"This License" refers to version 3 of the GNU General Public License.

"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.

To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

A "covered work" means either the unmodified Program or a work based
on the Program.

To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

1. Source Code.

The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.

A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

The Corresponding Source for a work in source code form is that
same work.

2. Basic Permissions.

All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.

3. Protecting Users' Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.

b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".

c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.

d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.

A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

6. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.

b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.

c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.

d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.

e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.

A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

7. Additional Terms.

"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or

b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or

c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or

d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or

e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or

f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.

All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

8. Termination.

You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.

An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

11. Patents.

A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".

A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

12. No Surrender of Others' Freedom.

If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

13. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.

If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

+ 36
- 0
README.md View File

@@ -0,0 +1,36 @@
# Patroneo
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.

This README is just a short introduction. You better read the manual, which also includes detailed instructions how to build Patroneo from source and start it.

Workflow summary: 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.

* Website https://www.laborejo.org
* Documentation and Manual https://www.laborejo.org/documentation/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.

# Installation and Starting

## Download
Download the latest release through your package manger or the code on https://github.com/diovudau/Patroneo/releases

* `./configure --prefix=/usr`
* `make`
* `sudo make install`

Patroneo can then be started using the Non Session Manager.

## Dependencies
* Python 3.6 (maybe earlier)
* PyQt5 for Python 3

### Build Dependencies
* Nuitka >= 0.6 (maybe earlier)
* GCC (development is done on 8.2, but most likely you can use a much earlier version)

### Environment:
* Jack Audio Connection Kit must be running
* Patroneo must be started via the Non Session Manager

+ 5
- 0
configure View File

@@ -0,0 +1,5 @@
#!/bin/sh
program=patroneo #MUST be the same as engine/config.py shortName
cboxconfigure="--without-fluidsynth --without-libsmf"

. template/configure.template #. is the posix compatible version of source

+ 13
- 0
desktop/desktop.desktop View File

@@ -0,0 +1,13 @@
[Desktop Entry]
Type=Application
Name=Patroneo
GenericName=Sequencer
Comment=Easy to use pattern sequencer for JACK and NSM
Comment[de]=Einfach zu bedienender Pattern-Sequencer
Exec=patroneo
Icon=patroneo
Terminal=false
StartupNotify=false
Categories=AudioVideo;Audio;X-Recorders;X-Multitrack;X-Jack;
X-NSM-capable=true
Version=1.1

BIN
desktop/icon32x32.png View File

Before After
Width: 32  |  Height: 32  |  Size: 942B

+ 430
- 0
documentation/LICENSE View File

@@ -0,0 +1,430 @@
from: https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt

Attribution-ShareAlike 4.0 International

=======================================================================

Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.

Using Creative Commons Public Licenses

Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.

Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors

Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees

=======================================================================

Creative Commons Attribution-ShareAlike 4.0 International Public
License

By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-ShareAlike 4.0 International Public License ("Public
License"). To the extent this Public License may be interpreted as a
contract, You are granted the Licensed Rights in consideration of Your
acceptance of these terms and conditions, and the Licensor grants You
such rights in consideration of benefits the Licensor receives from
making the Licensed Material available under these terms and
conditions.


Section 1 -- Definitions.

a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.

b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.

c. BY-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
Commons as essentially the equivalent of this Public License.

d. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.

e. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.

f. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.

g. License Elements means the license attributes listed in the name
of a Creative Commons Public License. The License Elements of this
Public License are Attribution and ShareAlike.

h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.

i. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.

j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.

k. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.

l. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.

m. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.


Section 2 -- Scope.

a. License grant.

1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:

a. reproduce and Share the Licensed Material, in whole or
in part; and

b. produce, reproduce, and Share Adapted Material.

2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.

3. Term. The term of this Public License is specified in Section
6(a).

4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.

5. Downstream recipients.

a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.

b. Additional offer from the Licensor -- Adapted Material.
Every recipient of Adapted Material from You
automatically receives an offer from the Licensor to
exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.

c. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.

6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).

b. Other rights.

1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.

2. Patent and trademark rights are not licensed under this
Public License.

3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.


Section 3 -- License Conditions.

Your exercise of the Licensed Rights is expressly made subject to the
following conditions.

a. Attribution.

1. If You Share the Licensed Material (including in modified
form), You must:

a. retain the following if it is supplied by the Licensor
with the Licensed Material:

i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);

ii. a copyright notice;

iii. a notice that refers to this Public License;

iv. a notice that refers to the disclaimer of
warranties;

v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;

b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and

c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.

2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.

3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.

b. ShareAlike.

In addition to the conditions in Section 3(a), if You Share
Adapted Material You produce, the following conditions also apply.

1. The Adapter's License You apply must be a Creative Commons
license with the same License Elements, this version or
later, or a BY-SA Compatible License.

2. You must include the text of, or the URI or hyperlink to, the
Adapter's License You apply. You may satisfy this condition
in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.

3. You may not offer or impose any additional or different terms
or conditions on, or apply any Effective Technological
Measures to, Adapted Material that restrict exercise of the
rights granted under the Adapter's License You apply.


Section 4 -- Sui Generis Database Rights.

Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:

a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;

b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,

including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.

For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.


Section 5 -- Disclaimer of Warranties and Limitation of Liability.

a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.

b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.

c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.


Section 6 -- Term and Termination.

a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.

b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:

1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or

2. upon express reinstatement by the Licensor.

For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.

c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.

d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.


Section 7 -- Other Terms and Conditions.

a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.

b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.


Section 8 -- Interpretation.

a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.

b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.

c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.

d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.


=======================================================================

Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.

Creative Commons may be contacted at creativecommons.org.


+ 7
- 0
documentation/README.txt View File

@@ -0,0 +1,7 @@
Run ./build-documentation.sh for html output in the /out directory.

.adoc is asciidoctor, not simple asciidoc.

This documentation is licensed under Creative Commons-BY-SA-4.0.
Please read the provided documentation/LICENSE file or visit
https://creativecommons.org/licenses/by-sa/4.0/legalcode

+ 18
- 0
documentation/build-documentation.sh View File

@@ -0,0 +1,18 @@
#!/bin/sh

#The documentation is built statically and does not belong to the normal build process with configure and make
#Its updating is part of the development process, not packaging and running.
#The correct out/ dir is already part of git.

set -e
asciidoctor index.adoc -o out/index.html

asciidoctor german.adoc -o out/german.html
cp overview-german.png out/overview-german.png

asciidoctor english.adoc -o out/english.html
cp overview-english.png out/overview-english.png

#cp *-quickstart*.mp4 out/

cp favicon.* out/

+ 291
- 0
documentation/english.adoc View File

@@ -0,0 +1,291 @@
:Author: Nils Hilbricht
:Version: 1.0
:iconfont-remote!:
:!webfonts:


////
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
A copy of the license has been provided in the file documentation/LICENSE.
////

////
https://powerman.name/doc/asciidoc
https://asciidoctor.org/docs/user-manual/
////

:sectnums:

:toc: left
:toc-title: Table of Contents
:toclevels: 3

== Patroneo User Manual

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.

== Installation and Starting

Patroneo is exclusive for Linux. The best way to install Patroneo is to use your package manager. If it is not there, or only in an outdated version, please ask your Linux distribution to provide a recent version.

If available in the package repository, please continue reading directly at "Start Patroneo from Non Session Manager".
If not, you can build Patroneo yourself.


.Dependencies
* First install the packages Python3, PyQt5, Nuitka, GCC and Git
* And these audio packages: Jack Audio Connection Kit, QJackCtl (or something else to establish Jack connections), Non Session Manager
* Now Patroneo itself:
** `git clone git@github.com:diovudau/Patroneo.git && cd Patroneo`
** `cd Patroneo`
** `./configure`
** `make`
** `sudo make install`

.Start Patroneo from Non Session Manager (NSM)
* Run `non-session-manager`
* Press the `New` button, and enter a name for your piece of music.
* Press the `Add Client to Session` button, enter `patroneo` here, in lower case.
* Add Client again, this time `jackpatch`.
* Add any compatible programs, e.g. synthesizers.
** See the list of NSM compatible programs: http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm
** And the NSM manual: http://non.tuxfamily.org/nsm/
* To save Patroneo, use the `Save` button in NSM.

== How to use Patroneo
The following explains how to use Patroneo.

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.

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.

video::patroneo-quickstart-english.mp4[width=500]

Or as Youtube Mirror

video::ygpwn0gzO8g[youtube, width=500]

=== Basic Principles
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".

The track is connected to an instrument through JACK, so Patroneo itself does not produce any sounds.

If you press Play, the track plays back from left to right. Whenever a measure is highlighted in the Form Editor, the pattern is played.

If you want to hear different patterns from the same instrument, you create several tracks for the same JACK instrument.

The selection of the tones per pattern is freely selectable. You can use normal musical scales or set any tones in any order. If you change the scale later, the pattern sounds different without having to switch tones on and off again.

Saving and loading your project is done by the Non Session Manager. There you will find a "Save" button.

=== Keyboard Controls
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.

.Shortcuts
* Space: Start and pause playback
* L: Play the current measure as a loop
* Backspace: Set playback to the beginning of the track.

== Description of the graphical user interface and its functions
Use your browser's search function to locate the individual letters like [B] and their explanation.

image::overview-english.png[Screenshot with Captions, link="overview-english.png"]

Patroneo consists of three parts: The Toolbar, the Form Editor, and the Pattern Editor. Between form- and pattern editor there is a *[L] Handle* 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.

=== Toolbar

The *[A] Toolbar* combines various commands with properties of the entire piece.

*[D] Clone Selected Track* adds a new track based on the currently selected one. This is an important and often used command that is mainly used to enable variants. The cloned track is empty, but inherits the scale of the original, its average velocity or volume, color and name. If the name ends in a single letter like "A", "g" or a number, it is automatically incremented, as you can see in the screenshot. The new track automatically connects to the same JACK instrument.

*[E] Add Track* adds an empty track. It is given a random name and is not connected in JACK.

*[F] BPM / Tempo*: The tempo can be completely deactivated by unchecking the box. In this case, the "JACK Transport" system takes over, as indicated by the "JACK" logo in the deactivated input field. This allows programs running in parallel to create complex tempo sequences, which is not possible in Patroneo alone. +
If the checkbox is activated, the specified tempo is considered to be beats per minute. A "beat" is the selected note value of the list [H]. More on that later.

*[G] Measures per Track* controls the total length of the piece, whereby the absolute number of seconds can change depending on how the tempo is selected and how long a measure should be. If the number of measures is reduced, no measures are actually deleted, but just ignored. If you later set the number of measures higher again, you will get your old configuration back.

*[H] Steps per Pattern, in groups of ... so that each group produces a ...* note. Here you can set how long the patterns are and what grouping below the beat they have. This is the most complicated part in Patroneo and will be discussed later in this manual. For now it is recommended to ignore the "groups" field. Steps per Pattern is simply the number of tones that can be switched on and off. The drop down list selects how long each of these steps is.

*[I] Playback Controls* are three buttons. From left to right:

* Play / Pause. Press to play or pause the music at the current location. You can also press the space bar.
* Loop on and off. The currently played measure (in all tracks) is continuously repeated. This function is suitable for working in a certain place by getting to hear your changes quickly. The loop is broken up by pressing the button again or jumping around in the timeline (see letter Z below).
* To the start: Jumps back to the beginning, whether the music is playing or not.


=== Form Editor

In the *[B] Form Editor* 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. +
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).

It is possible to zoom in on the measures. To do this, hold down the *CTRL* key and turn the mouse wheel up or down. Please make sure that the mouse cursor is actually over the measures and not over the track names or on the timeline.

*[Z] Timeline*: a click with the left mouse button sets the playback position, even during playback. +
In addition, the measure groups (not to be confused with grouping in the pattern, see letter H) can be seen and set here. If you hover over the timeline with the mouse cursor, you can reduce or increase the size of the groups with the mouse wheel. The groups not only have an cosmetical function but are also used as units of measurement if you want to delete or add entire ranges (see letter K).

*[J] Track Names*. Here you can move tracks, rename them, give them a different color and more:

* A single click with the left mouse button on a name selects a track without changing anything. This is the best way to just look at a track. (A click on the measure area changes a measure immediately!)
* The double arrow on the far left can be used to move tracks up and down to organize them. It has no effect on the sound or the JACK connections. To move, click on the arrow with the left mouse button, hold it down and move the mouse up and down.
* The colored square shows the current color. A left mouse click opens a dialog.
* Track names can be changed at any time by a double-clicking with the left mouse button. Press the Return key to finish renaming. The JACK connection is retained when renaming. +
It is a good habit to end tracks on a single letter or number. These are used in "cloning" to construct a variant of the name. See the screenshot above.
* A click with the right mouse button on a name opens the context menu of a track. Here you can
** Switch all measures on or off (only applies to the visible measures)
** Invert the activated measures: Off becomes On and vice versa.
** Clone this track (same function as in the toolbar)
** Delete the track permanently and irreversibly
** Copy the measure sequence of another track onto the selected one. Measures that have already been set are preserved. If you use this function from an empty track you will practically get "copy track".

Now finally the *[K] Track* itself. A left click on a measure switches it on or off again. You can switch several measures in a row on and off by holding down the left mouse button after clicking and moving the mouse left or right.
A right click on a specific measure opens a context menu: Insert new measures in all tracks(!) at this position or delete measures from all tracks. The number of measures results from the current measure group setting from the time line (see letter Z). +
These functions are especially understandable if you apply them to the first measure of a group (after the white line). This allows you to insert new "parts" or delete an entire part. +
A good method is also to change the group size for these functions briefly and then reset them immediately afterwards.

*[X] Half Tone Transposition* is adjusted by holding down the SHIFT key and then turning the mouse wheel up or down over an activated measure. In the measure itself a small text appears, e.g. +5h. Five semitones upwards; C becomes F, MIDI note 60 becomes 65; the transposition is only valid for the respective measure and is not visible in the pattern itself (see below). If the measure is switched off (and on again), the transposition is deleted.

*[Y] In-Scale Transposition*. It is recommended to familiarize yourself with the pattern and its scale (see letters O to R) first. Are you back? All right, here we go: +
If you hold the mouse cursor over an activated measure, you can adjust the transposition, based on the scale, with the mouse wheel up or down. The label shows how many steps up or down (-6s to +6s) this measure is shifted. If the measure is switched off, the transposition also disappears. In the pattern itself (see below) you cannot see whether a measure is transposed or not.

One can imagine that the steps in the pattern are shifted up or down in the rows behind the scenes. Whatever tone is set in this row gets played. With a normal scale, this is musically easy to understand: The tones are moved up or down in the scale. +
However, if the scale is chosen freely, there are non-intuitive outcomes; "up and down" with respect to pitches may lose their meaning. It is possible to use two interleaved scales in the pattern and to switch between them by scale transposition +1. Or even uses completely different tones, so that only the rhythm remains the same.

Scale and half-tone transposition can be combined. First the scale is changed, then the semitone. These combinations open up many creative possibilities!

=== Pattern Editor

The *[C] Pattern Editor* 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.

The pattern is always as long as set in the toolbar (see letter H). Steps that have been set are never deleted by rezising! If you make the measures shorter, tones "too far to the right" are simply ignored. You can see them again as soon as you make the measures longer again.

If the pattern is larger than the screen you can either use the scroll bars or zoom. To zoom hold down the *CTRL* key and turn the mouse wheel up or down.

At the top you can see a label for the *[M] Active Track*.

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.

==== Duration and Volume

A *[S] Step* is a grey or coloured box. Grey means pause, coloured means *[T] Sounding Tone*. A click with the left mouse button switches the steps on and off. +
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.

All steps are equal length. *[V] Other Durations* are also possible: If you hold down the left mouse button after activating a step, you can shorten or lengthen the tone by moving it to the left or right. It must be at least half the length. A tone is at most as long as the measure itself.

You can activate as many steps in a row or simultaneously as you like. Thus *[W] Chords* can be built.

Steps can have different *[U] Volumes*. For this Patroneo uses so-called MIDI Velocity. If you hold the mouse cursor over an activated step, you can make its sound softer or louder by turning the mouse wheel. The volumes are displayed as numbers between 1 and 127. If you want to see all volumes at once you can click with the mouse wheel (middle mouse button) into the free area left or right of the pattern. In addition, a step looks more transparent the quieter it is. If the step is switched on and off, the volume is set back to the normal value, derived from the average volume of all tones of this pattern. +

You can use the *[M] Velocity* buttons to make all tones of a pattern quieter or louder. If you click on it, the volume changes by 1 each, but if you hold the mouse cursor over a button and rotate your mouse wheel the velocity changes by 10 each. It doesn't matter which velocity button (plus or minus) you hover over.

==== Pitches and Scales

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.

Which actual pitch is played ("MIDI Key") is determined by the *[R] Scale*. Patroneo always works with eight-note scales. Normally, this is a common musical scale: seven different notes and the octave of the root note.

Such common *[Q] Scales* can be selected directly. For example, major, minor, various so-called "church modes" but also the blues scale or chromatic (e.g. to GM drum mapping) +
If you select a scale from the list, it will be built upon the bottom row. As a rule of thumb this is also the lowest note. In the screenshot this is midi note 60 / C4, located bottom left. You must first select the root directly and then select a *[Q] Scale*.

There are four buttons to change the pitch of both the root note and the entire scale:

* *[O] Half Tone* Plus or minus shifts the whole scale up or down by one semitone each. This should not be confused with the temporary transposition from the form editor (see letter X). This is called destructive change, since the values themselves are permanently changed.
* *[P] Octave* Plus or minus shifts directly by a whole octave. You could also press the half-tone button 12 times. Don't.

As already described in the scale transposition (see letter Y), it is also possible to directly input any value between 0 and 127 in the *[R] Fields of the Scale*. The tones do not have to have musically meaningful intervals, nor do they have to be sorted in ascending or descending order.

==== Shadows

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 *[2] Shadows*. 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.

You can display as many shadows as you want, until you lose track. All shadows disappear as soon as the active track changes.

=== Grouping in the Pattern

Grouping is part of the time signature.

As mentioned above *steps per pattern*, sets the length of the pattern. Patroneo starts with 8 steps per measure for a new project (see screenshot). On the far right is a drop down list, which is set to "Quarter" for a new project. You start with a traditional 8/4 time signature.

The field *in groups of* allows you to group steps together, each group being as long as specified in the drop down list. This allows you to further subdivide your time signature. The "beat", i.e. the tempo, is based on the main beats, the first step of each group.

.Examples
* 4/4 time signature with eights notes as smallest rhythmical unit
** 8 steps per pattern / in groups of 2 / so that each group produces a quarter
* 4/4 time signature subdivided as triplet eights notes (swing)
** 9 steps per pattern / in groups of 3 / so that each group produces a quarter
* 12/8 time signature
** 12 steps per pattern / in groups of 1 / so that each group produces an eigth
* 8/4 time signature subdivided as sixteenth notes
** 32 steps per pattern / in groups of 4 / so that each group produces a quarter

Normally, the time signature is set relatively at the beginning of a new project. However, it happens every now and then that you need smaller rhythm values than you thought at the beginning. If you simply increase the value of the grouping, you get more subdivisions, but the number of steps remains the same. Likewise, the notes remain exactly in the "column" in which they were previously placed. In other words, the music will sound different. Overall, the measure is also getting shorter, since the same number of steps is now used for shorter steps.

Patroneo therefore offers the function *[3] Convert Grouping* to change the existing measure structure and to resize steps already set so that the music sounds the same.

If you click on the button in the toolbar, a small dialog box opens in which you can enter the desired grouping. It is also possible to set what should happen if the conversion would not work properly for musical reasons (see below).

Conversion is often possible without any problems:

* If the grouping of `1` is set to a higher value, it always works
* If the grouping is set from `2` to `4` it always works

For all other transformations it depends on whether the existing tones lie between the new grid after the conversion or not. The former case is not possible and you have to decide:

.Error Handling
* Do nothing (default)
** The operation is aborted, everything remains as before.
* Delete wrong steps
** Anything that would appear between the grid will be deleted or discarded.
* Merge wrong steps
** Impossible positions are moved to the next possible position. In any case, this means that the music now sounds different. Usually several notes are pushed on top of each other and form chords.

With a little experience you will be able to estimate what error handling you need.

== Development
The further development of Patroneo will consist of improvements in the areas of stability and program performance.
New functions are not categorically excluded, but are only possible after long-term observation of user behaviour.


=== Translations
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.

However, here are the complete instructions for doing a translation completely on your own and integrating it into the program.

* Open a terminal and navigate to the Patroneo directory
* In the Patroneo directory: `cd gui/translations`
* Edit the file `config.pro` with a text editor
** Append the name of your language in the 2nd line, in the form `tXY.ts`, where XY is the language code.
** Make sure to leave a space between the individual languages entries.
* Run `pylupdate5 config.pro`
** The program has now generated a new `.ts` file in the `translations` subdirectory
* Start Qt Linguist with `linguist-qt5` (may be named differently) and open your newly generated file
* Select your "Target Language" and use the program to create a translation
* Send us the.ts file, such as by e-mail to info@laborejo.org (see below for more contact options)


You can also incorporate the translation into Patroneo for testing purposes. This requires rudimentary Python knowledge.

* In the Qt Linguist "File" menu is a "Release" option. This creates a `.qm` file in the same directory as your `.ts` file.
* Open the `patroneo` starter file in your text editor
** Scroll down to the bottom to set the language.
** To find out your language string (German, Esperanto etc.) remove the # hash from the existing line `#print (language)`. Start NSM from a terminal, start Patroneo and the language string will be printed there (you have to search a bit)
** At the end of the file is a dictionary `supportedLanguages`. Add your language. For example `{"German": "de.qm", "Esperanto: "eo.qm"}`

=== Bugs
If you find a bug in the program (or it runs too slow) please contact us in a way that suits you best.

.How to contact us
* E-Mail: info@laborejo.org
* Bugtracker: https://github.com/diovudau/Patroneo/issues
* IRC: #laborejo on server irc.freenode.org
* If you see the opportunity and know that a developer will read it also forums, Facebook etc..

BIN
documentation/favicon.ico View File

Before After

BIN
documentation/favicon.png View File

Before After
Width: 32  |  Height: 32  |  Size: 942B

+ 297
- 0
documentation/german.adoc View File

@@ -0,0 +1,297 @@
:Author: Nils Hilbricht
:Version: 1.0
:iconfont-remote!:
:!webfonts:


////
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
A copy of the license has been provided in the file documentation/LICENSE.
////

////
https://powerman.name/doc/asciidoc
https://asciidoctor.org/docs/user-manual/
////

:sectnums:

:toc: left
:toc-title: Inhaltsverzeichnis
:toclevels: 3

== Patroneo Bedienungsanleitung

Schön, dass du dich für Patroneo entschieden hast. Patroneo ist ein leicht zu bedienender "Sequencer", also ein Programm, dass digitale "Noten" an Softwareinstrumente, wie Synthesizer und Sampler, schickt.

"Patroneo" heißt "Muster" auf Esperanto. Das kommt daher, dass man hier nicht einzelne Noten hintereinander setzt sondern ganze Takte baut, die man dann beliebig oft an beliebigen Stellen wiederholen - oder auslassen - kann.

== Installation und Start

Patroneo ist exklusiv für Linux. Am besten installierst du Patroneo über deinen Paketmanager. Falls es dort nicht vorhanden ist, oder nur in einer veralteten Version, bitte deine Linuxdistribution Patroneo bereitzustellen.

Falls in den Paketquellen vorhanden bitte direkt bei "Patroneo im Non Session Manager starten" weiterlesen.

Falls nicht kann man Patroneo auch selbst "bauen".

.Abhängigkeiten
* Installiere zunächst die Pakete Python3, PyQt5, Nuitka, GCC und Git
* Und diese Audiopakete: Jack Audio Connection Kit, QJackCtl (oder etwas anderes um Jack Verbindungen herzustellen), Non Session Manager
* Jetzt Patroneo selbst:
** `git clone git@github.com:diovudau/Patroneo.git && cd Patroneo`
** `cd Patroneo`
** `./configure`
** `make`
** `sudo make install`

.Patroneo im Non Session Manager (NSM) starten
* Starte `non-session-manager`
* Knopf `New`, gib einen Namen für dein Musikstück ein.
* Knopf `Add Client to Session`, gib hier `patroneo` ein, kleingeschrieben.
* Nochmal Add Client, diesmal `jackpatch`.
* Füge beliebige kompatible Programme hinzu, z.B. Synthesizer.
** Siehe auch das NSM Handbuch: http://non.tuxfamily.org/nsm/
** Und die Liste der NSM kompatiblen Programme: http://non.tuxfamily.org/wiki/ApplicationsSupportingNsm
* Um Patroneo zu speichern benutzte den `Save`-Knopf in NSM.

== Bedienung
Im folgenden wird erklärt, wie Patroneo bedient wird.

Das Programm wird fast ausschließlich mit der Maus bedient. Du benötigst zwingend drei Maustasten und ein Mausrad. Meistens ist das Mausrad selbst die mittlere Maustaste, und man kann es herunterdrücken.

Wir ermutigen dich, viel zu experimentieren. Sehr oft ensteht gute Musik wenn Benutzer Programme nicht nur so benutzt haben, wie es eigentlich angedacht war.

=== Schnellstart
Um die wichtigsten Funktionen und Arbeitsabläufe kennenzulernen ist dieses Video erstellt worden.

video::patroneo-quickstart-german.mp4[width=500]

Oder auf Youtube

video::mr-_d9gw0Xw[youtube, width=500]


=== Grundlagen
Patroneo organisiert seine Musik in Spuren, die Takte enthalten. Alle Takte einer Spur spielen das selbe "Muster", dass durch eine Abfolge von "Schritten" Musik erzeugt.

Die Spur ist durch JACK mit einem Instrument verbunden, Patroneo selbst erzeugt also keine Klänge.

Drückt man Play läuft das Stück von links nach rechts durch. Immer wenn ein Takt im Formeditor markiert ist wird das Muster gespielt.

Möchte man verschiedene Muster vom gleichen Instrument hören so erstellt man mehrere Spuren für das gleiche Zielinstrument.

Die Auswahl der Töne pro Muster ist frei wählbar. Man kann normale Tonleitern / Skalen nehmen oder auch beliebige Töne in belieber Reihenfolge setzen. Ändert man die Skala nachträglich, dann klingt das Muster auch direkt anders, ohne das man Töne neu ein- und ausschalten muss.

Das Speichern und Laden deines Projektes wird durch den Non Session Manager erledigt. Dort befindet sich ein "Save" Knopf.

=== Tastatursteuerung
Patroneo kann prinzipiell mit der Maus bedient werden. Die Tastatur ist nur für wenige Funktionen dringend nötig, etwa um Spurnamen zu ändern oder um Halbtontransposition einzustellen. Allerdings macht die Tastatur manche Arbeitsabläufe schneller und bequemer.

.Shortcuts
* Leertaste: Start und Pause der Wiedergabe.
* L: aktuelle Taktpositionen in Schleife spielen.
* Backspace ("Rückwärts löschen"): Wiedergabe an den Anfang des Stückes setzen.


== Beschreibung der grafischen Oberfläche und ihrer Funktionen
Benutze die Suchfunktion deines Browsers um nach den einzelnen Buchstaben wie [B] und deren Erläuterung zu suchen.

image::overview-german.png[Screenshot mit Beschriftung, link="overview-german.png"]


Patroneo besteht aus drei Teilen: Der Werkzeugleiste, dem Form-Editor und dem Takt- oder Mustereditor. Zwischen Form- und Mustereditor befindet sich ein *[L] Verschiebegriff*, den man mit der linken Maustaste anklicken und bei gedrückter Taste hoch oder runter schieben kann um dem einen oder anderen Bereich mehr Platz zu geben.

=== Werkzeugleiste

Die *[A] Werkzeugleiste* kombiniert verschiedene Befehle mit Eigenschaften des gesamten Stückes.

*[D] Klon* der ausgewählten Spur fügt eine neue Spur auf Grundlage der momentan ausgewählten hinzu. Dies ist ein wichtiger und oft benutzer Befehl, der hauptsächlich benutzt wird um Varianten zu ermöglichen. Die "Klonspur" ist zwar leer, erbt allerdings die Skala der Originals, seine Durchschnittslautstärke, die Farbe sowie den Namen. Endet der Name auf einem Einzelbuchstaben wie "A", "g" oder einer Zahl so wird diese automatisch erhöht, wie man am Bild gut sehen kann. Die neue Spur verbindet sich darüberhinaus automatisch zum gleichen JACK-Instrument.

*[E] Neue Spur* fügt eine leere Spur hinzu. Diese bekommt einen Zufallsnamen und ist nicht in JACK verbunden.

*[F] BPM / Tempo*: Das Tempo kann zunächst durch setzen des Hakens komplett deaktiviert werden. In diesem Fall übernimmt das "JACK Transport" System die Geschwindigkeit, erkennbar am Schriftzug "JACK" im deaktivierten Eingabefeld. Somit können parallel laufende Programme komplexe Tempoverläufe erstellen, was in Patroneo allein nicht möglich ist. +
Aktiviert man den Haken so gilt das angegebene Tempo als Schläge pro Minute. Ein "Schlag" ist hierbei der ausgewählte Notenwert der Liste ganz rechts, bei [H]. Dazu später mehr.

*[G] Takte pro Spur* regelt die Gesamtlänge des Stückes, wobei sich die absolute Sekundenzahl ändern kann, je nachdem wie das Tempo gewählt wird und wie lang ein Takt sein soll. Reduziert man die Taktanzahl werden keine Takte gelöscht, sondern nur ignoriert. Setzt man später die Taktzahl wieder höher bekommt man seine alte Auswahl wieder.

*[H] Schritte pro Takt, gruppiert in je ... und jede Gruppe ergibt eine ...* Note. Hier kann eingestellt werden wie lang die Muster sind und welche rhythmische Aufspaltung sie haben. Dies ist der komplizierteste Teil in Patroneo und wird daher erst später in dieser Bedienungsanleitung besprochen. Fürs erste empfiehlt es sich das "gruppiert"-Feld zu ignorieren. Schritte pro Takt ist einfach die Anzahl an Tönen, die man ein- und ausschalten kann. Die Auswahlliste stellt ein wie lang jeder dieser Schritte ist.

*[I] Wiedergabe* sind drei Knöpfe zur Wiedergabe. Von links nach rechts:

* Play / Pause. Drücken um die Musik abzuspielen oder an der momentanen Stelle anzuhalten. Man kann auch die Leertaste drücken.
* Schleife (Loop) ein- und ausschalten. Der momentan abgespielte Takt (in allen Spuren) wird stetig wiederholt. Diese Funktion eignet sich um an einer bestimmten Stelle zu arbeiten indem man seine Veränderungen schnell zu hören bekommt. Die Schleife wird aufgelöst wenn man erneut auf den Knopf drückt oder in der Zeitleiste herumspringt (s.u. Buchstabe Z)
* An den Anfang: Springt wieder an den Anfang, egal ob die Musik gerade läuft oder nicht.


=== Form-Editor

Im *[B] Form-Editor* erstellt man die Stuktur eines Stückes. Dazu schaltet man die Takte in jeder Spur beliebig ein und aus. Man kann sich z.B. ein Schlagzeug vorstellen, dass drei Takte gleich spielt und jeden vierten Takt einen "Break" macht. In Patroneo braucht man dazu zwei Spuren. Dieses "3+1" Muster kann man auf dem Bild z.B. im dritten Abschnitt (Takt 17 bis 24) in der orangen Bassspur sehen. +
Auch ganze Teile (z.B. Strophe und Refrain) werden durch verschiedene Spuren abgedeckt. Um das Erschaffen von verwandten Spuren so bequem wie möglich zu machen existiert der "Klon" Befehl (s. Buchstabe D).

Es ist möglich im Bereich der Takte zu zoomen. Hierzu hält man die *STRG* Taste gedrückt und dreht das Mausrad hoch oder runter. Bitte darauf achten, dass der Mauszeiger tatsächlich über den Takten steht, und nicht etwa bei den Spurnamen oder auf der Zeitleiste.

*[Z] Zeitleiste*: ein Klick mit der linken Maustaste setzt die Wiedergabeposition, auch im laufenden Betrieb. +
Außerdem kann man hier die Taktgruppen (nicht zu verwechseln mit Gruppierung im Muster, s. Buchstabe H) sehen und einstellen. Hält man sich mit dem Mauszeiger im Bereich der Zeitleiste auf kann man die Gruppen mit dem Mausrad verkleinern oder vergrößern. Die Taktgruppen haben nicht nur organisatorische Funktion sondern werden auch als Maßeinheit benutzt, wenn man ganze Taktbereiche löschen oder hinzufügen möchte (s. Buchstabe K).

*[J] Spurnamen*. Hier kann man Spuren verschieben, umbennen, ihnen eine andere Farbe geben und mehr:

* Ein einfacher Klick mit der linken Maustaste auf einen Namen wählt eine Spur aus, ohne etwas zu verändern. Dies ist die beste Möglichkeit um eine Spur einfach nur anzusehen. (Ein Klick auf den Taktbereich verändert sofort einen Takt!)
* Der Doppelpfeil ganz links kann benutzt werden um Spuren hoch und runter zu schieben, um sie zu organisieren. Es hat keine Auswirkung auf den Klang oder die JACK Verbindung. Zum Verschieben mit der linken Maustaste auf den Pfeil klicken, gedrückt halten und die Maus hoch und runter bewegen.
* Das farbige Quadrat zeigt die derzeitige Farbe. Ein linker Mausklick öffnet die Farbauswahl.
* Spurnamen können jederzeit geändert werden indem man einen Doppelklick mit der linken Maustaste auf sie macht. Die Enter-Taste oder ein Mausklick in einen anderen Bereich des Programmes schließen das Umbennen ab. Die JACK Verbindung bleibt beim Umbenennen erhalten. +
Es ist eine gute Angewohnheit Spuren auf einem Einzelbuchstaben oder eine Zahl enden zu lassen. Diese werden beim "Klonen" benutzt um eine Variante des Namens zu bilden. Siehe dazu unser Bild oben.
* Ein Klick mit der rechten Maustaste auf einen Namen öffnet das Kontextmenü einer Spur. Hier kann man
** Alle Takte ein- oder ausschalten (gilt nur für die sichtbaren Takte)
** Die sichtbaren Takte umkehren oder invertieren: Aus wird zu An und umgekehrt.
** Die Spur klonen (gleiche Funktion wie in der Werkzeugleiste)
** Die Spur endgültig und unwiederbringlich löschen
** Die Taktabfolge einer anderen Spur auf die ausgewählte projizieren. Bereits gesetzte Takte bleiben hierbei erhalten. Benutzt man diese Funktion von einer leeren Spur aus erhält man praktisch "Spur kopieren".

Nun endlich die *[K] Spur* selbst. Ein Linksklick auf einen Takt schaltet diesen ein oder wieder aus. Mehrere Takte in Folge kann man ein- und ausschalten indem man die linke Maustaste nach dem Klicken gedrückt hält und die Maus nach links oder rechts bewegt.
Ein Rechtsklick auf einen bestimmten Takt öffnet ein Kontextmenü: Neue Takte in allen Spuren(!) an dieser Position einfügen oder Takte aus allen Spuren löschen. Die Anzahl der Takte ergibt sich aus der derzeitigen Taktgruppeneinstellung aus der Zeitleiste (s. Buchstabe Z). +
Diese Funktionen sind besonders nachvollziehbar wenn man sie auf den jeweils ersten Takt einer Gruppe anwendet (nach dem weißen Strich). Man kann so neue "Teile" einfügen oder einen gesamten Teil löschen. +
Eine gute Methode ist es auch die Gruppengröße für diese Funktionen kurz zu verändern und anschließend direkt wieder zurückzusetzen.

*[X] Halbtontransposition* wird eingstellt indem man die SHIFT Taste gedrückt hält und dann das Mausrad über einem aktivierten Takt hoch oder runter dreht. Im Takt selbst zeigt sich ein kleiner Schriftzug, z.B. +5h. Fünf Halbtöne aufwärts; aus C wird F, aus Midinote 60 wird 65. Die Transposition gilt nur für den jeweiligen Takt und ist im Muster selbst (s.u.) nicht zu sehen. Schaltet man den Takt aus (und wieder ein) ist die Transposition gelöscht.

*[Y] Skalentransposition*. Es wird empfohlen sich erst mit dem Muster und seiner Skala bzw. Tonleiter vertraut zu machen (s. Buchstaben O bis R). Wieder da? Gut, so gehts: +
Hält man den Mauszeiger über einen aktivierten Takt kann man mit dem Mausrad hoch oder runter die Transposition, basierend auf der Skala, einstellen. Die Beschriftung zeigt an um wieviele Schritte nach oben oder unten (-6s bis +6s) dieser Takt verschoben ist. Schaltet man den Takt aus verschwindet auch die Transposition wieder. Im Muster selbst (s.u.) ist nicht zu sehen ob ein Takt transponiert ist oder nicht.

Man kann sich das so vorstellen, dass die Schritte im Muster hinter den Kulissen in den Reihen hoch oder runter geschoben werden. Welcher Ton auch immer in dieser Reihe eingestellt ist wird gespielt. Bei einer normalen Tonleiter ist das musikalisch leicht nachvollziehbar: Die Töne werden in der Tonleiter hoch- oder runtergeschoben. +
Wenn die Skala allerdings frei eingestellt wurde ergeben sich unintuitive Möglichkeiten; "Hoch und Runter" in Bezug auf Tonhöhen verlieren dann evtl. ihre Bedeutung. Denkbar ist, dass man zwei verzahnte Tonleiter im Muster benutzt und durch Skalen-Transposition +1 zwischen diesen hin und herschaltet. Oder gar völlig verschiedene Töne benutzt, so dass nur der Rhythmus gleich bleibt.

Skalen- und Halbtontransposition können kombiniert werden. Zuerst wird die Skala verändert, dann erst der Halbton. Mit diesen Kombinationen ergeben sich viele kreative Möglichkeiten!

=== Muster-Editor

Der *[C] Muster-Editor* ermöglicht das eigentliche Komponieren. Dazu setzt man die Töne, auch "Schritte" genannt, um einen Takt zu bilden. Das Muster ist genau so lang wie ein Takt und wird von links nach rechts abgespielt. Man hat dabei einige Möglichkeiten zur klanglichen Gestaltung, die nun erklärt werden.

Das Muster ist immer so lang wie man in der Werkzeugleiste (s. Buchstabe H) eingestellt hat. Es werden niemals gesetzte Schritte gelöscht! Macht man die Takte kürzer werden Töne "zu weit rechts" lediglich ignoriert. Sie sind wieder zu sehen sobald man die Takte wieder länger macht.

Ist das Muster größer als der Bildschirm anzuzeigen vermag kann man entweder die Scrollleisten benutzen oder zoomen. Hierzu hält man die *STRG* Taste gedrückt und dreht das Mausrad hoch oder runter.

Zu oberst sieht man die momentan *[M] Aktivierte Spur*, bzw. das zur Spur gehörige Muster.

Das Muster selbst ist in Reihen und Spalten angelegt. Die Reihen symbolisieren die (einstellbaren) Tonhöhen, die Spalten zeigen deren rhythmische Abfolge und Position im Takt.

==== Länge und Lautstärke

Ein *[S] Schritt* ist ein graues bzw. farbiges Kästchen. Grau bedeutet Pause, farbig bedeutet *[T] Klingender Ton*. Ein klick mit der linken Maustaste schaltet die Schritte an und aus. +
Ein Rechtsklick öffnet das Kontextmenü. Hier kann man alle (gerade sichtbaren) Schritte einschalten, ausschalten oder die gesetzen Schritte tauschen; Aus An wird Aus und umgekehrt. Hierbei gehen alle Lautstärke Informationen (s.u.) verloren.

Alle Schritte sind grundsätzlich gleich lang. *[V] Besondere Tonlängen* sind aber auch möglich: Hält man die linke Maustaste gedrückt, nachdem man einen Schritt aktiviert hat kann man mit einer Bewegung nach links oder rechts den Ton verkürzen oder verlängern. Es muss mindestens die Hälfte der Länge sein. Ein Ton ist höchstens so lang wie der Takt selbst.

Man kann soviele Schritte hintereinander oder gleichzeitig einschalten wie man möchte. Somit lassen sich auch *[W] Akkorde* bilden.

Schritte können unterschiedliche *[U] Lautstärken* haben. Dazu benutzt Patroneo die sogenannte Midi Velocity. Hält man den Mauszeiger über einen aktivierten Schritt kann man durch Drehung des Mausrades diesen Ton leiser oder lauter machen. Die Lautstärken werden als Zahlen zwischen 1 und 127 angezeigt. Möchte man alle Lautstärken auf einmal sehen kann man mit dem Mausrad (mittlere Maustaste) in den freien Bereich links oder rechts des Musters klicken. Zusätzlich sieht ein Schritt umso durchsichtiger aus je leiser er ist. Schaltet man den Schritt an und aus wird die Lautstärke wieder auf den Normalwert gesetzt. Dieser ergibt sich aus der Durchschnittslautstärke aller Töne dieses Musters. +

Um alle Töne eines Musters leiser oder lauter zu machen kann man die *[M] Velocity* Knöpfe benutzen. Klickt man diese an ändert sich die Lautstärke um je 1. Hält man allerdings den Mauszeiger über einen Knopf und dreht das Mausrad ändert sich die Velocity um je 10! Dabei ist es egal über welchem Velocity Knopf (plus oder minus) man schwebt.

==== Tonhöhen, Skala und Tonleiter

Klicke mit der mittleren Maustaste auf einen Schritt um den Ton zu hören, den dieser abspielt. Hiermit kannst du schonmal "vorhören", bevor du dich entscheidest einen Ton zu setzen. Tipp: Halte die mittlere Maustaste gedrückt und fahre mit der Maus über die Schritte auf und ab.

Welche tatsächliche Tonhöhe abgespielt wird ("Midi Key") entscheidet die *[R] Skala*, teilweise auch Tonleiter genannt. Patroneo arbeitet immer mit Achtstufigen Skalen. Im Normallfall handelt es sich hierbei tatsächlich um eine Tonleiter: Sieben verschiedene Töne und oben drauf der oktavierte Grundton.

Solche normalen *[Q] Tonleitern* kann man direkt auswählen. So z.B. etwa Dur, Moll, verschiedene sogenannte "Kirchentonleitern", aber auch die Blues Töne oder chromatische Reihen (z.B. um Schlagzeug-Software anzusteuern). +
Wählt man aus der Liste eine Tonleiter aus so wird diese auf der untersten Reihe gebildet. In der Regel ist dies auch der tiefste Ton. Auf unserem Bild ist dies Ton 60 / C4, links unten. Man muss also zuerst den Grundton direkt auswählen und anschließend eine *[Q] Tonleiter* auswählen.

Um sowohl den Grundton als auch die gesamte Skala nachträglch in ihrer Tonhöhe zu verändern gibt es vier Knöpfe:

* *[O] Halbton* Plus oder Minus verschiebt die ganze Skala nach oben oder unten um je einen Halbton. Dies ist nicht zu verwechseln mit der nur zeitweisen Transposition aus dem Spureditor (s. Buchstabe X). Man spricht hier auch von destruktiver Veränderung, da man die Werte selbst dauerhaft ändert.
* *[P] Oktave* Plus oder Minus verschiebt direkt um eine ganze Oktave. Man könnte auch 12 mal auf den Halbtonknopf drücken. Kann man aber auch lassen.

Wie in der Skalentransposition (s. Buchstabe Y) bereits beschrieben ist es aber auch möglich selbst jeden beliebigen Wert zwischen 0 und 127 in die *[R] Felder der Skala* einzutragen. Die Töne müssen weder musikalisch sinnvolle Abstände haben, noch müssen sie aufsteigend oder absteigend sortiert sein.

==== Schatten

Oft möchte man zu einer existierenden Spur noch weitere Töne in einem anderen Muster setzen. Eine zweite Stimme, Frage/Antwort-Technik etc.
Als Hilfe gibt es die Möglichkeit sich andere Spuren als *[2] Schatten* anzeigen zu lassen. Dazu einfach mit der mittleren Maustaste auf die Spur klicken, die man sehen möchte. Das geht nur im Taktbereich, nicht auf den Spurnamen oder auf der Zeitleiste.

Du kannst so viele Schatten anzeigen, bist du die Übersicht verlierst. Alle Schatten verschwinden sobald die ausgewählte Spur wechselt.

=== Gruppierung im Muster

Die Gruppierung gehört zur Taktart.

Wie bereits oben beschrieben stellt *Schritte pro Takt* die Länge des Musters ein. Patroneo startet mit 8 Schritten pro Takt bei einem neuen Projekt (s. Bild). Ganz rechts ist eine Auswahlliste, die bei einem neuen Projekt auf "Viertel" steht. Man startet also mit einem traditionellen 8/4 Takt.

Durch das Feld *gruppiert in je* kann man nun die Schritte in Gruppen zusammenfassen, wobei jede Gruppe so lang ist wie in der Auswahlliste angegeben. Damit kann man seine Taktart weiter unterteilen. Der "Beat", also das Tempo, orientiert sich dabei an den Hauptschlägen, der jeweils erste Schritt einer Gruppe.

.Beispiele
* Ein 4/4 Takt mit Achtelnoten als kleinste Rhythmuseinheit
** 8 Schritte pro Takt / Gruppiert in je 2 / Jede Gruppe eine Viertel
* Ein 4/4 mit Triolen als kleinste Rhythmuseinheit ("Swing")
** 9 Schritte / Gruppiert zu 3 / Gruppe ergibt Viertel
* Ein 12/8 Takt
** 12 Schritte / Gruppiert zu 1 / Gruppe ergibt Achtel
* Ein 8/4 Takt mit Sechzehntelnoten
** 32 Schritte / Gruppiert zu 4 / Gruppe ergibt Viertel


Normalesweise stellt man die Taktart relativ am Anfang eines neuen Kompositionsprozesses ein. Es kommt jedoch immer mal wieder vor, dass man kleinere Rhythmuswerte braucht, als man anfangs dachte. Wenn man einfach den Wert der Gruppierung erhöht erhält man zwar mehr Unterteilungen, die Anzahl der Schritte bleibt jedoch gleich. Ebenso bleiben die Noten genau in der "Spalte" stehen, in der sie vorher standen. In anderen Worten: die Musik wird anders klingen. Insgesamt wird auch der Takt kürzer, da die gleiche Anzahl von Schritten nun auf kürzere Schritte verteilt wird.

Patroneo bietet deswegen die Funktion *[3] Gruppierung Umwandeln*, um die bestehende Taktstruktur zu verändern und bereits gesetzte Schritte so zu skalieren, dass die Musik gleich klingt.

Klickt man auf den Knopf in der Werkzeugleiste öffnet sich ein kleines Dialogfenster, in dem man die gewünschte Gruppierung eingeben kann. Außerdem ist es möglich einzustellen, was passieren soll, wenn das Umwandeln aus musikalischen Gründen nicht komplett funktionieren würde (s.u.).

Oft ist ein Umwandeln problemlos möglich:

* Wird die Gruppierung von `1` auf einen höheren Wert gesetzt funktioniert es immer
* Wird die Gruppierung von `2` auf `4` gesetzt funktioniert es immer

Bei allen anderen Umgruppierungen kommt es darauf an, ob die vorhandenen Töne nach dem Umwandeln zwischen dem neuen Raster liegen oder nicht. Der erstere Fall ist nicht möglich und du musst dich entscheiden:

.Reaktion auf Fehler. Falls unmöglich:
* Nichts machen (Voreinstellung)
** Der Vorgang wird abgebrochen, alles bleibt wie vorher.
* Falsche Schritte löschen
** Alles was zwischen dem Raster herauskommen würde wird gelöscht bzw. verworfen.
* Falsche Schritte mit einbinden
** Unmögliche Positionen werden auf die nächstmögliche Position geschoben. Dies führt in jedem Fall dazu, dass die Musik nun anders klingt. Meist werden dadurch mehrere Noten übereinander geschoben und bilden Akkorde.

Mit ein wenig Erfahrung wird man abschätzen können, was man braucht.

== Entwicklung
Die weitere Entwicklung Patroneos besteht aus der Verbesserung in den Bereichen Stabilität und Programmgeschwindigkeit.
Neue Funktionen werden zwar nicht kategorisch ausgeschlossen, sind aber erst nach Langzeitbeobachtung des Nutzerverhaltens möglich.


=== Übersetzungen
Patroneo ist mit Hilfe der Qt-Toolchain sehr einfach zu übersetzen, ohne, dass man dafür Programmieren muss.
Die einfachste Variante ist es einfach die Entwickler anzusprechen und sie werden die neue Sprache einrichten.

Hier ist dennoch die komplette Anleitung, um eine Übersetzung komplett alleine anzufertigen und in das Programm einzubinden.

* Öffne ein Terminal und navigiere ins Patroneo Verzeichnis
* Im Patroneo Verzeichnis: `cd gui/translations`
* Bearbeite die Datei `config.pro` mit einem Texteditor
** Hänge in der 2. Zeile den Namen deiner Sprache an, in der Form `XY.ts`, wobei XY der Sprachcode ist.
** Achte darauf ein Leerzeichen zwischen den einzelnen Sprachen zu lassen
* Führe `pylupdate5 config.pro` aus.
** Das Programm hat nun eine neue `.ts` Datei im `translations` Verzeichnis generiert
* Starte Qt Linguist mit `linguist-qt5` (kann evtl. anders heißen) und öffne von dort deine neu generierte Datei
* Wähle deine "Target Language", also Zielsprache, aus und benutze das Programm um eine Übersetzung anzufertigen
* Sende uns die .ts Datei, z.B. per E-Mail an info@laborejo.org (s.u bei Bugs und Programmfehler für mehr Kontaktmöglichkeiten)


Die Übersetzung kannst du auch selbst, zum Testen, in Patroneo einbinden. Dafür sind rudimentäre Python Kentnisse nötig.

* Im Qt Linguist "Datei" Menü ist eine "Release" Option. Das erstellt eine `.qm` Datei im gleichen Verzeichnis wie deine `.ts` Datei.
* Öffne die `patroneo` Starterdatei im Texteditor
** Scrolle nach ganz unten, dort wird die Sprache eingestellt.
** Um deinen Sprachstring herauszufinden (German, Esperanto etc.) entferne die # Raute aus der bereits vorhandenen Zeile `#print (language)`. Starte NSM aus einem Terminal, starte Patroneo und der Sprachstring wird dort ausgegeben (man muss ein bischen suchen)
** Am Ende der Datei ist ein Dictionary `supportedLanguages`. Füge deine Sprache hinzu. z.B. `{"German":"de.qm", "Esperanto:"eo.qm"}`

=== Bugs und Programmfehler
Falls du einen Fehler im Programm entdeckst (oder es zu langsam läuft) melde dich bitte bei auf die Art und Weise, die dir am besten passt.

.Kontaktmöglichkeiten
* E-Mail: info@laborejo.org
* Bugtracker: https://github.com/diovudau/Patroneo/issues
* IRC: #laborejo auf dem Server irc.freenode.org
* Wenn du die Gelegenheit siehst und weist, dass ein Entwickler es lesen wird meinetwegen auch Foren, Facebook etc.



+ 30
- 0
documentation/index.adoc View File

@@ -0,0 +1,30 @@
:Author: Nils Hilbricht
:Version: 1.0
:iconfont-remote!:
:!webfonts:

////
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a
letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
A copy of the license has been provided in the file documentation/LICENSE.
////


////
https://powerman.name/doc/asciidoc
https://asciidoctor.org/docs/user-manual/
////

:nofooter:


== Patroneo Multi-Language Documentation

This site is part of the https://www.laborejo.org[Laborejo Software Suite]


Please choose a language

* link:english.html[English]
* link:german.html[Deutsch (German)]

+ 1078
- 0
documentation/out/english.html
File diff suppressed because it is too large
View File


BIN
documentation/out/favicon.ico View File

Before After

BIN
documentation/out/favicon.png View File

Before After
Width: 32  |  Height: 32  |  Size: 942B

+ 1080
- 0
documentation/out/german.html
File diff suppressed because it is too large
View File


+ 459
- 0
documentation/out/index.html View File

@@ -0,0 +1,459 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.8">
<title>Patroneo Multi-Language Documentation</title>
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Uncomment @import statement below to use as custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
audio,canvas,video{display:inline-block}
audio:not([controls]){display:none;height:0}
script{display:none!important}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
a{background:transparent}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:none}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite::before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
*:not(pre)>code.nobreak{word-wrap:normal}
*:not(pre)>code.nowrap{white-space:nowrap}
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}