Debian Codegraph @

texmf-dist/doc/support/pmxchords/pmxchords-install.tex

raw
1 \documentclass[11pt]{article}
2 \usepackage[textwidth=6.5in,textheight=8.5in]{geometry}
3 \usepackage[osf]{mathpazo}
4 \PassOptionsToPackage{urlcolor=black,colorlinks}{hyperref}
5 \RequirePackage{hyperref}
6 \usepackage{xcolor}
7 \newcommand{\myurl}[1]{\textcolor{blue}{\underline{\textcolor{black}{\url{#1}}}}}
8 \newcommand{\pmxVersion}{2.7.0}
9 \begin{document}
10 \title{Installation of the CTAN pmxchords Distribution}
11 \author{Bob Tennent\\
12 \small\url{[email protected]}}
13 \date{\today}
14 \maketitle
15 \thispagestyle{empty}
16
17 \section{Introduction}
18 We assume that you have already installed a MusiXTeX distribution
19 and PMX.
20 Before trying to install pmxchords from CTAN, check whether your TeX distribution
21 provides a package for pmxchords; this will be easier than doing it yourself.
22 But if your TeX distribution
23 doesn't have pmxchords (or doesn't have the most recent version), this distribution
24 of pmxchords is very easy to install, though
25 you may need to read the material on
26 installation of (La)TeX files in the
27 TeX FAQ\footnote{%
28 \myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html}},
29 particularly
30 the pages on
31 which tree to use\footnote{%
32 \myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=what-TDS}}
33 and installing files\footnote{%
34 \myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf}}.
35
36 \section{Installing \texttt{pmxchords.tds.zip}}
37
38 In this distribution of pmxchords, most of the files to be installed
39 (including macros, documentation, and a processing script) are in
40 \texttt{tex-archive/install/support/pmxchords.tds.zip} at CTAN.
41 The file \verb|pmxchords.tds.zip| is a zipped TEXMF
42 hierarchy; simply download it and unzip in the root folder/directory of whichever TEXMF tree
43 you decide is most appropriate, likely a ``local'' or ``personal'' one.
44 This should work with any TDS\footnote{%
45 \myurl{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=tds}}
46 compliant TeX distribution, including MikTeX, TeXlive and teTeX.
47
48 After unzipping the archive, update the filename database as necessary,
49 for example, by executing \verb\texhash ~/texmf\ or
50 clicking the button labelled ``Refresh FNDB" in the MikTeX settings program.
51
52 Documentation for pmxchords is installed under \verb\doc/generic/pmx\
53 in the TEXMF tree.
54
55 \section{The Processing Script}
56
57 The Lua script \verb\.../scripts/pmx/pmxchords.lua\
58 transposes chord symbols in the \verb\pmx\ file as necessary
59 and then calls \verb\pmxab\.
60
61 On a Unix-like system (with \texttt{texlua} installed), put a
62 symbolic link \texttt{pmxchords} in any directory on the executable PATH as follows:
63 \begin{list}{}{}
64 \item \verb\ln -s <path to pmxchords.lua> pmxchords \
65 \end{list}
66 On Windows, you can \emph{either}
67 copy the batch file
68 \begin{list}{}{}
69 \item \verb|Windows\pmxchords.bat|
70 \end{list}
71 to a folder
72 on the executable PATH \emph{or} add the folder
73 \verb|Windows| to the executable PATH.
74
75 \section{Testing}
76
77 Copy \verb\doc/pmxchords/example/noel/aj_co_to_hlasaju/aj_co_to_hlasaju.pmx\ to a
78 working directory and do
79 \begin{list}{}{}\item
80 \verb\pmxchords aj_co_to_hlasaju\
81 \end{list}
82 Then process the resulting \verb\aj_co_to_hlasaju.tex\ file as usual. The piece
83 is in the key of F~major.
84
85 Uncomment the line
86 \verb\K-2+2\ in the \verb\pmx\ file and repeat as above; the piece should
87 now be typeset in D major, with appropriate chords. If the line
88 \begin{list}{}{}\item
89 \verb|\input chords|
90 \end{list}
91 in the source file is replaced by
92 \begin{list}{}{}\item
93 \verb|\input chordsCZ|
94 \end{list}
95 the chord symbols will be in Czech style (e.g., Hmi instead of Bmi).
96
97 The macro calls for various chord symbols are displayed in the \verb|chordsRef|
98 and \verb|chordsRefCZ| documents.
99
100 \end{document}