diff options
author | Karl Berry <karl@freefriends.org> | 2014-04-22 22:24:54 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-04-22 22:24:54 +0000 |
commit | 6ea16a3ef7b22c1777e7f57bcb0eaba7e4d37b79 (patch) | |
tree | 5e9308af8db4ce32883b0949608d80e63c153cf9 /Master/texmf-dist/doc/latex/prerex/intro.tex | |
parent | 39e9ffa4f20094e682ed59a2b15c0fe03b7624a3 (diff) |
prerex (with .5 man page) (22apr14)
git-svn-id: svn://tug.org/texlive/trunk@33631 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/prerex/intro.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/prerex/intro.tex | 109 |
1 files changed, 53 insertions, 56 deletions
diff --git a/Master/texmf-dist/doc/latex/prerex/intro.tex b/Master/texmf-dist/doc/latex/prerex/intro.tex index e89c60dcebe..ecbea31491e 100644 --- a/Master/texmf-dist/doc/latex/prerex/intro.tex +++ b/Master/texmf-dist/doc/latex/prerex/intro.tex @@ -21,6 +21,7 @@ \newcommand{\myurl}[1]{\textcolor{blue}{\underline{\textcolor{black}{\url{#1}}}}} +\newcommand{\myhref}[2]{\href{#1}{\textcolor{blue}{\underline{\textcolor{black}{#2}}}}} \title{Prerex-Formatted Prerequisite Charts\\[1ex]\Large An Introduction} \date{\today} @@ -130,11 +131,6 @@ most browsers using freely-available software (such as the Adobe Reader), printable on any high-resolution printer, relatively compact, and scalable to accommodate paper size, display resolution, or user preference. -Charts can also be converted to Portable Network Graphics (PNG) -format for in-line use on a web page. PNG format is also relatively compact -and can be rendered directly by most web browsers. Scalable Vector Graphics (SVG) -format is a new standard which is increasingly supported by modern browsers; it is fairly easy to -convert PDF pages to SVG images. Prerex-formatted charts are produced by software that processes simple and convenient text-based descriptions. These descriptions can be edited in any @@ -142,6 +138,11 @@ text editor or in the \texttt{prerex} interactive editor discussed in Section~\r The format of chart descriptions is documented in Section~\ref{source}. +Charts can be converted to Scalable Vector Graphic (SVG) +format for posting on the web. When compressed, SVG format is relatively compact +and can be rendered directly by all modern web browsers. +It is fairly easy to +convert charts to SVG images. \subsubsection*{What software is needed to produce prerex-formatted prerequisite charts?} @@ -307,7 +308,7 @@ transfer coordinates from the chart to the editor. To ``process'' a chart description, you will need to install an application called \LaTeX, together with several auxiliary applications to convert the -output into Postscript and then PDF. +output into PDF or other formats. \LaTeX\ is a powerful document processor based on a professional-quality typesetting program called \TeX. The following web sites @@ -325,12 +326,13 @@ MiKTeX.\footnote{% If you use Mac~OS~X, go to the \emph{\TeX\ on Mac OS~X} site.\footnote{% \myurl{http://www.rna.nl/tex.html}} -Unix and Linux users should install \texttt{texlive}.\footnote{% +\textsc{Unix} and Linux users should install at least the ``basic'' scheme of TeXLive.\footnote{% \myurl{http://www.tug.org/texlive/}} The resulting installation will allow you to process simple \texttt{.tex} files. However, you won't be able -to process the description of a prerex-formatted prerequisite chart until some necessary additional software is installed. +to process the description of a prerex-formatted prerequisite chart until +some necessary additional software is installed. \section{Additional \LaTeX\ Software} \label{additional} @@ -340,17 +342,17 @@ are needed. The file \texttt{prerex.sty} from the \texttt{prerex} package is essential; it should be stored in the same folder as the \texttt{.tex} file to be processed -(or in the -local \verb|texmf| tree) so the \LaTeX\ system can find it. +(or in +a \verb|texmf| tree so the \LaTeX\ system can find it). Other add-ons that may be necessary are as follows: \texttt{pgf}, \texttt{tikz}, \texttt{multido}, -\texttt{ifpdf}, +\texttt{hyperref}, \texttt{textcomp}, and \texttt{xcolor}. -If you are using \MikTeX\ or \texttt{texlive}, these can be installed using the -package manager. +If you are using \MikTeX\ or TeXLive, these packages can be installed using their +package managers. All of the packages are also available for download from any CTAN\footnote{% \myurl{http://www.ctan.org/}} repository. @@ -366,19 +368,6 @@ This operation will overwrite any existing \verb|chart.pdf|, so you should first re-name that file if you want to preserve it. -If the \texttt{pdflatex} command isn't recognized, you -will have to -edit the -system executable-command path. -On a Unix-like system, adjust the value of \texttt{PATH}; on -Windows, click on \emph{Control~Panel} $\rightarrow$ \emph{System} $\rightarrow$ \emph{Advanced} $\rightarrow$ \emph{Environment~Variables}, -select \emph{Path} and click on \emph{Edit}; then append the appropriate -paths, -separated by semi-colons. For \MikTeX, the default path for commands is -\verb|C:\texmf\miktex\bin|. - - - \section{Installing a \LaTeX\ Development Environment} \label{IDE} Most beginning @@ -429,7 +418,7 @@ The Open Sans family\footnote{% of fonts, designed by Steve Matteson of Ascender, is supported for use in \LaTeX\ by the \texttt{opensans} package, available from CTAN\footnote{% -\myurl{http://mirror.ctan.org/fonts/opensans}} +\myurl{http://www.ctan.org/pkg/opensans}} and in most distributions. The Cabin\footnote{% \myurl{http://www.google.com/webfonts/specimen/Cabin}} @@ -452,45 +441,52 @@ Artifex\footnote{% \myurl{http://www.artifex.com/downloads/}}. The four Classico font files, renamed for use in \LaTeX, with the necessary support files and installation instructions are available from CTAN\footnote{% -\myurl{http://mirror.ctan.org/fonts/urw/classico/}}. +\myurl{http://www.ctan.org/pkg/classico}}. Note that the font files cannot be distributed commercially without a commercial license; please read the license in the archive before re-distributing them. This restriction does not prevent you from distributing documents that \emph{use} the fonts. -\section{Conversion to Portable Network Graphic (PNG) Format} - -Although PDF is currently the best available format for distributing -and printing charts, you may want to produce a raster-image version for -use on a web site. There are several conversion programs and services -available to do this. For example, the \verb|convert| tool of the -multi-platform \verb|ImageMagick|\footnote{% -\myurl{http://www.imagemagick.org/}} -package may be used as follows: -\begin{verbatim} - convert -density 125 -quality 100 chart.pdf chart.png -\end{verbatim} -The density parameter specifies the number of pixels per inch; if this is too small, the -image is of poor quality, and if it is too large, the image file is too big. -The quality parameter ensures maximal (loss-free) compression. -From version 5.0, \verb|prerex.sty| (if processed by \verb\pdflatex\) generates an auxiliary file -containing image-map data for the hyperlinked nodes in the chart; consult a -reference on the HTML language for an explanation of (client-side) image maps. - \section{Conversion to Scalable Vector Graphics (SVG) Format} -Recent versions of popular browsers support SVG graphics natively,; i.e., without +Scalable Vector Graphics (SVG) format is an emerging standard for high-quality graphics. +Recent versions of popular browsers support SVG graphics natively; i.e.,~without requiring a plug-in or -external application. The quality and size of SVG images are comparable to PDF when -the files are compressed. +external application, +making it an ideal format for posting charts on the web. +The quality and size of (compressed) SVG images are comparable to PDF\@. +The \texttt{inkview} application in the open-source \texttt{inkscape}\footnote{% +\myurl{http://www.inkscape.org/en/}} +package +is a convenient SVG image viewer. + +One approach is to use \texttt{dvisvgm}\footnote{% +\myurl{http://dvisvgm.sourceforge.net/}; also available from +\myhref{http://mirror.ctan.org/}{CTAN} and in \myhref{https://www.tug.org/texlive/}{\TeX Live}. +} +to convert the output +of \texttt{latex} processing directly into a (compressed) SVG image. +Versions +since 1.3 generate links in the image from \texttt{hyperref} links in the source file. +Use \texttt{dvisvgm} as a global class option and +\texttt{hypertex} as a package option to \texttt{hyperref} +to ensure that the appropriate drivers are used by \texttt{latex}, +and invoke \texttt{dvisvgm} as follows: +\begin{list}{}{}\item + \verb\dvisvgm -n -b dvi -L none -z ... \. +\end{list} +If +\texttt{dvisvgm} reports that it can't find Ghostscript, +see the \texttt{dvisvgm} documentation for configuration options. On Unix-like platforms such as Linux, a small program called \verb\pdf2svg\ is available\footnote{% \myurl{http://www.cityinthesky.co.uk/opensource/pdf2svg/}}; it uses standard libraries (\verb\poppler\ and \verb\cairo\) to implement -the conversion. Since version~6.5, pdf\LaTeX\ processing will generate an auxiliary -file \verb|\jobname.dat| of data on links in the PDF, as most conversion -applications do not attempt to convert PDF hyperlinks to SVG links. +the conversion. +From version 0.2.3, \texttt{pdf2svg} adds clickable +links to the image and supports a scaling option. + \section{Terminology and Coordinate System} @@ -584,7 +580,7 @@ The notation $x_0,y_0:x_1,y_1$ denotes all the nodes (course boxes, minis, texts) in the rectangle whose northwest and southeast corners are at coordinates -$x_0,y_0$ and $x_1,y_1$. +$x_0,y_0$ and $x_1,y_1$, respectively. \begin{table} \begin{center}\small \begin{tabular}{|l|l|} @@ -598,6 +594,7 @@ $x_0,y_0$ and $x_1,y_1$. \verb\file> arrow x0,y0,x1,y1\ & [create and] edit arrow from $x0,y0$ to $x1,y1$\\ \verb\file> cut x,y ... \ & (temporarily) remove box, mini, or text at $x,y$\\ \verb\file> paste x,y \ & re-insert removed box, mini, or text at $x,y$\\ +\verb\file> xchange x0,y0 x1,y1 \ & exchange elements at $x0,y0$ and $x1,y1$\\ \verb\file> delete [x,y | x0,y0,x1,y1 | x0,y0:x1,y1] ...\ & remove specified elements/arrows\\ \verb\file> shift [-]x x0,y0[:x1,y1] ...\ & move [specified] elements $x$ units right [left]\\ \verb\file> raise [-]y x0,y0[:x1,y1] ...\ & move [specified] elements $y$ units up [down]\\ @@ -612,7 +609,7 @@ $x_0,y_0$ and $x_1,y_1$. \hline \end{tabular} \end{center} -\caption{\texttt{prerex} Command Summary (version 6.3)} +\caption{\texttt{prerex} Command Summary (since version 6.4)} \label{help} \end{table} @@ -622,7 +619,7 @@ viewer. See the manual page \texttt{prerex(1)} for more information. The \texttt{prerex} package at CTAN also has the source files for \texttt{vprerex} (visual \texttt{prerex}), a graphical ``wrapper'' for \texttt{prerex} -which incorporates a prerex-enabled PDF viewer. +which incorporates a \texttt{prerex}-enabled PDF viewer. For initial creation of a prerex-formatted chart |