diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/texpower/manual.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/texpower/manual.tex | 118 |
1 files changed, 52 insertions, 66 deletions
diff --git a/Master/texmf-dist/doc/latex/texpower/manual.tex b/Master/texmf-dist/doc/latex/texpower/manual.tex index 472db32a79a..4b9112957ab 100644 --- a/Master/texmf-dist/doc/latex/texpower/manual.tex +++ b/Master/texmf-dist/doc/latex/texpower/manual.tex @@ -4,11 +4,12 @@ %% %% The original source files were: %% -%% texpower-doc.dtx (with options: `manual,docu,enddoc') +%% texpower-doc.dtx (with options: `version,manual,docu,enddoc') %% %% -------------------------------------------------------------- %% TeXPower bundle - dynamic online presentations with LaTeX %% Copyright (C) 1999-2004 Stephan Lehmke +%% Copyright (C) 2003-2005 Hans Fredrik Nordhaug %% %% This program is free software; you can redistribute it and/or %% modify it under the terms of the GNU General Public License @@ -25,19 +26,10 @@ %% given in the file `00readme.txt'. %% \ProvidesFile{manual.tex}% - [2004/07/27 TeXPower manual] -%----------------------------------------------------------------------------------------------------------------- -% File: manual.tex -% -% (Preliminary) documentation of the TeXPower bundle. -% -%----------------------------------------------------------------------------------------------------------------- -% Autor: Stephan Lehmke <Stephan.Lehmke@cs.uni-dortmund.de> -% -% v0.0.1 Mar 20, 2000: First version for the pre-alpha release of TeXPower. -% -% v0.0.2 Apr 11, 2000: Now producing a document which is meant for printing on paper. -% + [2005/04/07 TeXPower manual] + +% Version info used in titles +\def\tpversion{v0.2 of April 8, 2005} \documentclass[12pt]{scrartcl} @@ -129,44 +121,11 @@ % \begin{document} -% -%----------------------------------------------------------------------------------------------------------------- -% -% Documentation of the TeXPower bundle. -% -% Autor: Stephan Lehmke <Stephan.Lehmke@cs.uni-dortmund.de> -% -% v0.0.1 Mar 20, 2000: First version for the pre-alpha release of TeXPower. -% -% v0.0.2 Mar 29, 2000: Added `usage and basic options' section. -% -% v0.0.3 Apr 04, 2000: Added `Color Emphasis and Highlighting' section. -% -% v0.0.4 Apr 12, 2000: A lot of small additions in preparation of the update to TeXpower v0.0.7. -% -% v0.0.5 May 31, 2000: Updated for TeXpower v0.0.8. -% -% v0.0.6 Jun 09, 2000: Some updates for TeXpower v0.0.8b. -% -% v0.0.6a Jun 13, 2000: Some updates for TeXpower v0.0.8c. -% -% v0.0.6b Jun 23, 2000: Some updates for TeXpower v0.0.8e. -% -% v0.0.6c Jul 25, 2000: Some updates for TeXpower v0.0.8g. Colors section rewritten for new color management kernel. -% -% v0.0.7 May 15, 2003: Added index and updates for TeXpower v0.0.9d. -% -% v0.0.8 July 27, 2004: Added the "Miscellaneous commands" section. Moved the tpslifonts doc into tpslifonts.dtx. -% -%----------------------------------------------------------------------------------------------------------------- -% -\def\docversion{v0.0.8 of July 27, 2004} -\def\tpversion{v0.1b of July 27, 2004} \makeslidetitle {% Documentation% - \thanks{Documentation \docversion\ for \TeX Power \tpversion\ (alpha).}% + \thanks{Documentation for \TeX Power \tpversion .}% }% The \TeX Power bundle contains style and class files for creating dynamic online presentations with \LaTeX. @@ -198,9 +157,6 @@ The other, more sophisticated examples demonstrate the expressive power of the \code{texpower} package. Look at the commented code of these examples to find out how to achieve special effects and create your own presentation effects with \TeX Power. -For the first \emph{alpha} release, this documentation will be completed. For the first \emph{beta} release, when the -code is a little more stable, the \code{texpower} package will be made into a properly documented \code{.dtx} file. - \newslide %----------------------------------------------------------------------------------------------------------------- @@ -261,11 +217,22 @@ This way, not only `visible' page contents will be duplicated, but also some `in side effects. For instance, a \macroname{section} command creates a whatsit for writing the table of contents entry. Duplicating this -whatsit will also duplicate the toc entry. +whatsit will also duplicate the toc entry. So, whatsit items effecting file access are inhibited when duplicating page +material. \newslide -So, whatsit items effecting file access are inhibited when duplicating page material. +The current version of \code{texpower} is a little smarter when handling whatsits. Some commands (related to writing to +files and hyperlinks) are made stepwise-aware. This means that links can point to the actual subpage where the +anchor is and not to the last (sub)page of an incremental page. However, if you want the old behaviour just use +\begin{description} +\item[\present{option: \code{oldfiltering}}]\indexpckopt{texpower}{oldfiltering} switches on the old + (pre 0.2) very aggressive/robust filtering of whatsits. +\end{description} +The \code{oldfiltering} can be turned on and off inside the document using \macroname{oldfilteringon/off}. This command is +useful if \code{texpower} isn't smart enough... + +\newslide A second type of whatsits is created by \TeX's \macroname{special} command which is used for instance for color management. Some drivers, like \code{dvips} and \code{textures}, use a color stack which is controlled by @@ -348,6 +315,10 @@ There are some boolean registers provided and set automatically by \code{texpowe \subsection{Miscellaneous commands}\label{Sec:MiscCmd} Some important commands that don't fit in the latter sections: \begin{description} +\item[\present{\macroname{oldfilteringon}}]\indexmacro{oldfilteringon} + reverts to the old (pre v0.2) aggressive/robust filtering of whatsits. +\item[\present{\macroname{oldfilteringoff}}]\indexmacro{oldfilteringoff} + turns on the new better treatment of whatsits. \item[\present{\commandapp{currentpagevalue}{\carg{value}}}]\indexmacro{currentpagevalue} sets how to find the number of the current page, \commandapp{value}{page} is default. Used to name the hyper target on the first subpage of every page. Also used in the @@ -360,6 +331,17 @@ Some important commands that don't fit in the latter sections: \newslide +\subsection{Page Anchors}\label{Sec:PageAnch} + +For each physical page \TeX Power (when in display mode) makes a number of subpages - this is +the dynamics. For convenience \TeX Power defines an anchor to the first subpage of physical page n, +\code{firstpage.n}\indexcode{firstpage.n}. The standard page anchor for physical page n, +\code{page.n}\indexcode{page.n}, points to the last subpage of physical page n. If you want to +link to any other subpage just insert a \macroname{hyperlink} in the standard way assuming you haven't +turned on the old filtering (\ref{Sec:Dupl}). + +\newslide + \subsection{Dependencies on other packages} \code{textpower} always loads the packages \code{ifthen} and \code{calc}, as the extended command syntax provided by these is indispensable for the macros to work. They are in the \code{base} and \code{tools} area of the \LaTeX{} @@ -400,8 +382,8 @@ The following packages are neccessary for certain features of \code{texpower}: \subsection{What else is part of the \TeX Power bundle?} Besides the package \code{texpower} (which is described here), there are four more packages, \code{tpslifonts}, \code{fixseminar}, \code{automata} and -\code{tplists}, and one document class, -\code{powersem}, in the \TeX Power bundle which so far have no documentation +\code{tplists}, and one document class, \code{powersem}, in the \TeX Power bundle. +Except for \code{tpslifonts} and \code{tplists} these files have no documentation of their own. They will be described in this section until they are turned into \code{dtx} files producing their own documentation. @@ -518,7 +500,7 @@ automata are supported so far. \minisec{The package \code{tplists}}\indexfile{tplists}{package} Experimental package providing easy dynamic lists. Currently there are stepped, flipped and dimmed versions of itemize and enumerate (and corresponding lists from the \code{eqlist} and \code{paralist} package). For more information -and an example read the start of the file \code{tplists.sty}. +and an example, compile (and then read) the file \code{tplists.dtx}. \newslide @@ -617,8 +599,8 @@ and an example read the start of the file \code{tplists.sty}. \emph{completely} into \carg{contents}, where \macroname{step} can be used freely (see \nameref{Sec:Ex}). \item As \carg{contents} is read as a macro argument, constructs involving \concept{catcode} changes (like - \macroname{verb} or language switches) won't work in \carg{contents}. Using a suggestion by \name{Ross - Moore}, I hope to remedy this until the \emph{alpha} release. + \macroname{verb} or language switches) won't work in \carg{contents} \textbf{unless} you use the + \code{fragilesteps} environment (\ref{Sec:fragilesteps}). \newslide @@ -642,13 +624,19 @@ and an example read the start of the file \code{tplists.sty}. Commands accessing toc files and such (like \macroname{section}) are taken care of by the whatsit suppression mechanism (compare section \ref{Sec:Dupl}). + \end{enumerate} + + \newslide - Labels and hyperlinks work sort of (giving a lot of warnings though). + \subsection{\code{fragilesteps} environment}\label{Sec:fragilesteps}% - I will try to remedy remaining problems until the first \emph{alpha} release. - \end{enumerate} + The \code{fragilesteps}\indexcode{fragilesteps} environment is a wrapper around \macroname{stepwise} + that makes it possible to use verbatim. The code for this environment is based on similar code from beamer - an + excellent presentation class written by Till Tantau - thanks! Using the \code{fragilesteps} environment + enables the use of the \code{listings} package to display code line by line. There are some examples in + \code{verbexample.tex}. - \newslide + \newslide \subsection{\macroname{boxedsteps} and \macroname{nonboxedsteps}}\label{Sec:boxedsteps}% By default, \carg{stepcontents} belonging to a \macroname{step} which is not yet `active' are ignored altogether. This @@ -695,10 +683,8 @@ and an example read the start of the file \code{tplists.sty}. \subsection{Custom versions of \macroname{stepwise}}% Sometimes, it might happen that vertical spacing is different on every page of a sequence generated by - \macroname{stepwise}, making lines `wobble'. - - This is caused by interactions between different ways vertical spacing is added to the page. Hopefully, problems - caused this way can be reduced until the first \emph{alpha} release. + \macroname{stepwise}, making lines `wobble'. This is usually fixed if you use \macroname{liststepwise} or + \macroname{parstepwise} (described below) in stead of \macroname{stepwise}. \newslide |