Skip to content

Commit

Permalink
Lotsa documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
ahlstromcj committed Oct 25, 2023
1 parent b9b9a2a commit 0a49984
Show file tree
Hide file tree
Showing 29 changed files with 252 additions and 224 deletions.
80 changes: 40 additions & 40 deletions contrib/DIR_COLORS
Original file line number Diff line number Diff line change
Expand Up @@ -397,46 +397,46 @@ EXEC 01;32

# Project files and configuration files, thin and dark red

.ac 00;31
.am 00;31
.bcc 00;31
.bpr 00;31
.bpk 00;31
.bpg 00;31
.build 00;31
.cfg 00;31
.ctrl 00;31
.def 00;31
.dfm 00;31
.drums 00;31
.guess 00;31
.header 00;31
.in 00;31
.ini 00;31
.keymap 00;31
.mutes 00;31
.opts 00;31
.options 00;31
.pc 00;31
.PL 00;31
.palette 00;31
.playlist 00;31
.prj 00;31
.pro 00;31
.pws 00;31
.tjp 00;31
.tji 00;31
.qss 00;31
.rc 00;31
.rh 00;31
.resp 00;31
.session 00;31
.state 00;31
.sub 00;31
.ui 00;31
.user 00;31
.usr 00;31
.vim 00;31
.ac 01;33
.am 01;33
.bcc 01;33
.bpr 01;33
.bpk 01;33
.bpg 01;33
.build 01;33
.cfg 01;33
.ctrl 01;33
.def 01;33
.dfm 01;33
.drums 01;33
.guess 01;33
.header 01;33
.in 01;33
.ini 01;33
.keymap 01;33
.mutes 01;33
.opts 01;33
.options 01;33
.pc 01;33
.PL 01;33
.palette 01;33
.playlist 01;33
.prj 01;33
.pro 01;33
.pws 01;33
.tjp 01;33
.tji 01;33
.qss 01;33
.rc 01;33
.rh 01;33
.resp 01;33
.session 01;33
.state 01;33
.sub 01;33
.ui 01;33
.user 01;33
.usr 01;33
.vim 01;33

# Audio wave formats (white)

Expand Down
Binary file modified contrib/midi/text.midi
Binary file not shown.
14 changes: 8 additions & 6 deletions data/readme.text
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
readme.text for Seq66 0.99.10
Chris Ahlstrom
2015-09-10 to 2023-09-24
2015-09-10 to 2023-10-24

Release 0.99.9 fixes known issues, and adds additional run-time help files and
some more automation functions.
Release 0.99.10 fixes known issues and issues found by the author.
See the main README.md and RELNOTES files for details.

Seq66 is a refactoring of a reboot (sequencer64) of seq24, extending it with new
features and bug fixes, and incorporation of Modern C++ (C++11/C++14). It
is a "live performance" sequencer, with the musician creating and controlling a
number of pattern loops.
number of pattern loops. It also provides some very useful editing, import,
and export functions.

An extensive manual for this application is found in the "doc" subdirectory
of the installed project directory, and it also can be downloaded via Git:
An extensive manual for this application is found in the "data/share/doc"
subdirectory of the installed project directory, and it also can be downloaded
via Git:

https://github.com/ahlstromcj/seq66.git

Expand Down
4 changes: 2 additions & 2 deletions data/readme.windows
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
readme.windows for Seq66 0.99.10 and above
Chris Ahlstrom
2018-05-13 to 2023-09-24
2018-05-13 to 2023-10-24

This README file tells you how to run the native Windows implmentation of
seq66, an executable named qpseq66.exe. It provides some notes on Seq66 and
Expand All @@ -12,7 +12,7 @@ readme.text.

There will eventually be a portable ZIP package for qpseq66; an NSIS-based
installer is available (replace "0.99" with the latest version number)
as part of the latest GitHub release.
as part of the latest GitHub release. An example:

https://github.com/ahlstromcj/seq66/releases/download/0.99.8/seq66_setup_x64-0.99.8.exe

Expand Down
Binary file modified data/share/doc/seq66-user-manual.pdf
Binary file not shown.
Binary file added doc/latex/images/misc/perstfic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions doc/latex/tex/alsa.tex
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ \subsection{ALSA / Through Ports}
They are virtualized hardware MIDI loopbacks that make it so
programs that only output to "hardware" ports can use them
to control and sequence other programs in an ALSA or JACK session.
Also see \cite{alsathru}.
Also see how to increase the number of ALSA MIDI Thru ports in
\cite{alsathru}.

\begin{verbatim}
Port Client name Port name
Expand Down Expand Up @@ -98,7 +99,7 @@ \subsection{ALSA / Virtual MIDI Devices}
\label{subsec:alsa_virtual_midi_devices}

The "manual" ports of \textsl{Seq66} are "virtual" ports.
From \cite{midihowto}:
From \textsl{The Linux MIDI-HOWTO} \cite{midihowto}:

\begin{quote}
MIDI sequencers like to output their notes to MIDI devices that normally
Expand All @@ -122,7 +123,7 @@ \subsection{ALSA / Virtual MIDI Devices}
\end{verbatim}

More to come, such as an explanation of \texttt{aconnectgui}....
Also see \cite{midilinux}.
Also see the article about ALSA and JACK MIDI \cite{midilinux}.

\subsection{ALSA / Trouble-Shooting}
\label{subsec:alsa_testing}
Expand Down Expand Up @@ -212,8 +213,7 @@ \subsubsection{ALSA / Trouble-Shooting / MIDI Clock}
number, no matter which VMPK instance was played.
Thus, it's basically useless to run more than one VMPK instance.

See the \textsl{VMPK} website (\cite{vmpk}).
The current version one can download there is 0.8.8.
See the \textsl{VMPK} website \cite{vmpk}.

%-------------------------------------------------------------------------------
% vim: ts=3 sw=3 et ft=tex
Expand Down
13 changes: 9 additions & 4 deletions doc/latex/tex/concepts.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
% \library Documents
% \author Chris Ahlstrom
% \date 2015-11-01
% \update 2023-03-03
% \update 2023-10-25
% \version $Revision$
% \license $XPC_GPL_LICENSE$
%
Expand Down Expand Up @@ -34,14 +34,19 @@ \subsection{Concepts / Reload Session}
\begin{itemize}
\item \textbf{Manual Restart}
Once a setting is changed, or a new arrangement of devices occurs,
exit \textsl{Seq66}, examine or edit the various configuration files (if
desired), and start \textsl{Seq66} again.
exit \textsl{Seq66}, examine or edit the various configuration files
(if desired), and start \textsl{Seq66} again.
\item \textbf{Edit / Preferences / Restart Seq66}.
When settings in \textbf{Edit / Preferences} are changed, the
\textbf{Reload Session} button becomes enabled.
Click it, and the result is basically like restarting \textsl{Seq66}.
\end{itemize}

Note that some changes in settings will not take effect on this restart.
For example, a style-sheet, if specified, is loaded when the application is
created, not in the restartable loop.
The solution is to exit \textsl{Seq66} manually and then start it again.

In the future (version 2?), we will make \textsl{Seq66}
able to better detect and
reconfigure for system changes and preferences changes.
Expand Down Expand Up @@ -306,7 +311,7 @@ \subsubsection{Concepts / Sound Subsystems / JACK}
running.
It supports virtual port connections via the \texttt{qjackctl} program or
the \textsl{Non Session Manager}.
See reference \cite{jack}.
See reference \textsl{JACK Audio Connection Kit} \cite{jack}.

%-------------------------------------------------------------------------------
% vim: ts=3 sw=3 et ft=tex
Expand Down
64 changes: 34 additions & 30 deletions doc/latex/tex/configuration.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1692,7 +1692,7 @@ \subsubsection{'usr' File / Additional Options}
\begin{figure}[H]
\centering
\includegraphics[scale=0.75]{main-window/main-window-stylesheet.png}
\caption{Seq66 View with Style-Sheet Applied}
\caption{Seq66 View with a Minimal Style-Sheet Applied}
\label{fig:view_with_style_sheet_applied}
\end{figure}

Expand Down Expand Up @@ -1729,10 +1729,10 @@ \subsubsection{'usr' File / Additional Options}
The thing to note here is that we must limit the width of combo-boxes so
that all elements in a horizontal bar can be seen.
This has the unfortunate side-effect of showing only part of long
port names (e.g. "Midi Thoug" in the figure above).
port names (e.g. "Midi Throug" in the figure above).

Another interesting style-sheet in \texttt{data/samples} is
\texttt{perstfix-66.qss}, which is a nice blue theme.
\texttt{perstfix-66.qss} and its palette file, which is a nice blue theme.
No need to show it here; try it.

\index{fingerprint}
Expand Down Expand Up @@ -1837,8 +1837,8 @@ \subsection{'ctrl' File}
\textsl{Seq66} provides a way to control the
application to some extent via a MIDI controller, such as a MIDI keyboard or
a MIDI pad. The current section describes this feature;
additional resources and ideas can be found at \url{linuxaudio.org}
\cite{midicontrol}.
additional resources and ideas can be found at \url{linuxaudio.org} and
its discussion of MIDI control with \textsl{Seq24} \cite{midicontrol}.
Also see the tutorial section \sectionref{sec:launchpad_mini}.
An \textsl{Open Document Format} spreadsheet in the
\texttt{doc} directory shows layouts for the default
Expand Down Expand Up @@ -1885,7 +1885,7 @@ \subsubsection{'ctrl' File / MIDI Control Settings}
the hardware on the system. If set, then only that buss will be allowed
to send MIDI control. A value of 255 or 0xff means any buss can send
MIDI control. If port-mapping is enabled, the short name (nick-name) of
the port can be used.
the port can be used as will.
\item \texttt{midi-enabled}.
If set to "true", then the MIDI controls will be used.
It can be set to "false", while keeping the configuration in place
Expand Down Expand Up @@ -1986,11 +1986,9 @@ \subsubsection{'ctrl' File / Loop Control}
Remember that it can include a channel. This channel is not overridden by
the pattern's selected channel when a MIDI control matching event is
received.
% The channel nybble of this byte is ignored.
One can look up the possible status values up in the MIDI messages tables;
the relevant data can be found at \cite{midicontroltable}.
% As the channel on which the events are sent is ignored,
% it is sufficient to use the values for channel 1; that is, 0.
the relevant data can be found at
\textsl{Summary of MIDI Messages} \cite{midicontroltable}.

The last three fields describe the range of data that will match. The
\textbf{D1 (data1)} field provides the actual MIDI event message number to
Expand Down Expand Up @@ -2181,7 +2179,8 @@ \subsubsection{'ctrl' File / Automation Control}
that pattern is queued, and will play at the next cycle of the
pattern.

Here is an example from \cite{midicontrol}, which shows how to set up
Here is an example from \textsl{Seq24} \cite{midicontrol},
which shows how to set up
the "Sustain" control-change event to queue or un-queue a sequence:
The \textsl{Akai MPK Mini} has a Sustain button and we can set the
Sustain MIDI event (with MIDI status byte 176 [0xB0] to represent a
Expand All @@ -2200,7 +2199,10 @@ \subsubsection{'ctrl' File / Automation Control}

So when the Sustain button is held down, and one presses one of the pads
on the \textsl{MPK Mini}, the corresponding sequence gets queued.
Also included in the data directory are sample 'ctrl' files for other devices.
Also included in the data directory are sample 'ctrl' files for other
devices.
For a more comprehensive discussion, see
\sectionref{sec:launchpad_mini}.

\paragraph{Automation / Mute Group ("Group Mute")}
\label{paragraph:configuration_midi_ctrl_modgmute}
Expand Down Expand Up @@ -2383,7 +2385,7 @@ \subsubsection{'ctrl' File / Automation Control}
Additional automation commands provide direct access to each mode.

Grid mode changes the function of the main window's patterns panel so that
it can be used to initiate record instead of toggling mute status,
it can be used to initiate recording instead of toggling mute status,
regardless of whether the toggling is done via the buttons, hot-keys, or
MIDI controls. The following modes are supported:

Expand All @@ -2395,7 +2397,7 @@ \subsubsection{'ctrl' File / Automation Control}
Applies the given mute-group statuses when
the slot is clicked. Since the "shifted" hot-keys can also be used,
this mode is most useful with mouse-click control.
\item \textbf{Record}.
\item \textbf{RECORD}.
In this mode, a click on a slot or the use of its hot-key toggles
recording for that pattern.
\item \textbf{Copy}.
Expand All @@ -2406,23 +2408,25 @@ \subsubsection{'ctrl' File / Automation Control}
\item \textbf{Clear}.
Clears the pattern in the clicked slot.
The pattern remains in that slot, but it has no events.
Careful!
\item \textbf{Delete}.
Deletes the pattern in the clicked slot.
Careful!
\item \textbf{Thru}.
Enables the MIDI Thru function for that pattern.
\item \textbf{Solo}.
Solos the clicked pattern.
\item \textbf{Cut}.
Deletes the pattern in the clicked slot, while saving it.
Deletes the pattern in the clicked slot, while saving it in
the clipboard.
\item \textbf{Double}.
Doubles the length (in measures) of the pattern in the slot
that is clicked.
\end{itemize}

A click or a hot-key will cause the selected function above to be applied to
the pattern denoted by the click/key.
% For details, see \sectionref{paragraph:patterns_recording_modes}.
In \textbf{Record} mode, the following settings are enabled:
In \textbf{RECORD} mode, the following settings are enabled:

\begin{itemize}
\item \textbf{Overdub}.
Expand All @@ -2438,12 +2442,12 @@ \subsubsection{'ctrl' File / Automation Control}
Notes are added to the pattern as they come in, but recording
stops when the end of the pattern's specified measures is
reached.
\item \textbf{One-shot Reset}.
Similar to one-shot, but clears the pattern.
(To do: find the exact process used here.)
% TODO: fix this!
% \item \textbf{One-shot Reset}.
% Similar to one-shot, but clears the pattern.
% (To do: find the exact process used here.)
\end{itemize}

% For details, see \sectionref{paragraph:patterns_recording_modes}.
Also supported is changing the mode of recording, that is, what happens
to notes while incoming during recording:

Expand All @@ -2456,12 +2460,13 @@ \subsubsection{'ctrl' File / Automation Control}
\item \textbf{Tighten}.
Incoming notes are tightened (partially quantized)
to the nearst snap value for the pattern.
\item \textbf{Randomize}.
The amplitude (velocity) of notes is randomized.
This is not done during recording, but can be applied later.
\item \textbf{Jitter}.
The timing of notes is randomized.
This is not done during recording, but can be applied later.
% These are not supported during recording:
% \item \textbf{Randomize}.
% The amplitude (velocity) of notes is randomized.
% This is not done during recording, but can be applied later.
% \item \textbf{Jitter}.
% The timing of notes is randomized.
% This is not done during recording, but can be applied later.
\item \textbf{Note-map}.
If active, the specified 'drums' file values are used to remap the
notes to new notes. This is useful, along with setting MIDI Thru, to
Expand All @@ -2470,9 +2475,8 @@ \subsubsection{'ctrl' File / Automation Control}
the fact, if the pattern is marked as transposable.
\end{itemize}

% For details, see \sectionref{paragraph:patterns_recording_modes}.
Also see \sectionref{subsec:pattern_editor_bottom} for more information on these
recording modes.
Also see \sectionref{subsec:pattern_editor_bottom} for more information on
these recording modes.

\paragraph{Automation / BBT/HMS and LR Loop}
\label{paragraph:configuration_bbthms_lr_loop}
Expand Down
Loading

0 comments on commit 0a49984

Please sign in to comment.