summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/standalone
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-03-28 00:38:32 +0000
committerKarl Berry <karl@freefriends.org>2010-03-28 00:38:32 +0000
commit49b4790fd92979a66a8024fe83a0338c0c0b3949 (patch)
tree64b94b3a1c8b4c954e1798ca111ed69b958487a7 /Master/texmf-dist/source/latex/standalone
parentc71375a46696c8f462ab9901b685971bce3810a5 (diff)
standalone 0.3 (27mar10)
git-svn-id: svn://tug.org/texlive/trunk@17579 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/standalone')
-rw-r--r--Master/texmf-dist/source/latex/standalone/Makefile60
-rw-r--r--Master/texmf-dist/source/latex/standalone/README7
-rw-r--r--Master/texmf-dist/source/latex/standalone/standalone.dtx1208
3 files changed, 1094 insertions, 181 deletions
diff --git a/Master/texmf-dist/source/latex/standalone/Makefile b/Master/texmf-dist/source/latex/standalone/Makefile
index edd3f4ecdb8..f399ae376d5 100644
--- a/Master/texmf-dist/source/latex/standalone/Makefile
+++ b/Master/texmf-dist/source/latex/standalone/Makefile
@@ -4,6 +4,7 @@ DOCINSTALLDIR=${TEXMF}/doc/latex/standalone
CP=cp
RMDIR=rm -rf
PDFLATEX=pdflatex -interaction=batchmode
+LATEXMK=latexmk -pdf -silent
PACKEDFILES=standalone.cls standalone.sty standalone.cfg standalone.tex
DOCFILES=standalone.pdf
@@ -11,21 +12,32 @@ SRCFILES=standalone.dtx standalone.ins README Makefile
all: unpack doc
-unpack: standalone.dtx standalone.ins
- yes | pdflatex standalone.ins
-
package: unpack
class: unpack
-doc: ${DOCFILES}
+${PACKEDFILES}: standalone.dtx standalone.ins
+ yes | pdflatex standalone.ins
+
+unpack: ${PACKEDFILES}
+
+# 'doc' and 'standalone.pdf' call itself until everything is stable
+doc: standalone.pdf
+ @${MAKE} --no-print-directory standalone.pdf
+
+pdfopt: doc
+ @-pdfopt standalone.pdf .temp.pdf && mv .temp.pdf standalone.pdf
+
+standalone.pdf: standalone.dtx standalone.gls standalone.ind
+ ${LATEXMK} standalone.dtx
+
+standalone.idx standalone.glo: standalone.dtx
+ ${LATEXMK} standalone.dtx
+
+standalone.ind: standalone.idx
+ -makeindex -s gind.ist -o "$@" "$<"
-standalone.pdf: %.pdf: standalone.dtx
- ${PDFLATEX} $<
- ${PDFLATEX} $<
- -makeindex -s gind.ist -o $*.ind $*.idx
- -makeindex -s gglo.ist -o $*.gls $*.glo
- ${PDFLATEX} $<
- ${PDFLATEX} $<
+standalone.gls: standalone.glo
+ -makeindex -s gglo.ist -o "$@" "$<"
.PHONY: test
@@ -33,8 +45,9 @@ test: unpack
for T in test*.tex; do echo "$$T"; pdflatex -interaction=batchmode $$T && echo "OK" || echo "Failure"; done
clean:
- ${RM} ${PACKEDFILES} *.zip *.log *.aux *.toc *.vrb *.nav *.pdf *.snm *.out *.fdb_latexmk *.glo
- ${RMDIR} .tds
+ -latexmk -C standalone.dtx
+ ${RM} ${PACKEDFILES} *.zip *.log *.aux *.toc *.vrb *.nav *.pdf *.snm *.out *.fdb_latexmk *.glo *.gls *.hd *.sta *.stp
+ ${RMDIR} tds
install: unpack doc ${INSTALLDIR} ${DOCINSTALLDIR}
${CP} ${PACKEDFILES} ${INSTALLDIR}
@@ -57,18 +70,17 @@ zip: standalone.zip
tdszip: standalone.tds.zip
-standalone.zip: ${SRCFILES} ${DOCFILES}
+standalone.zip: ${SRCFILES} ${DOCFILES} | pdfopt
${RM} $@
zip $@ $^
-standalone.tds.zip: ${SRCFILES} ${DOCFILES} ${PACKEDFILES}
- ${RMDIR} .tds
- mkdir -p .tds/tex/latex/standalone
- mkdir -p .tds/doc/latex/standalone
- mkdir -p .tds/source/latex/standalone
- ${CP} ${DOCFILES} .tds/doc/latex/standalone
- ${CP} ${PACKEDFILES} .tds/tex/latex/standalone
- ${CP} ${SRCFILES} .tds/source/latex/standalone
- cd .tds; zip -r ../$@ .
- ${RMDIR} .tds
+standalone.tds.zip: ${SRCFILES} ${PACKEDFILES} ${DOCFILES} | pdfopt
+ ${RMDIR} tds
+ mkdir -p tds/tex/latex/standalone
+ mkdir -p tds/doc/latex/standalone
+ mkdir -p tds/source/latex/standalone
+ ${CP} ${DOCFILES} tds/doc/latex/standalone
+ ${CP} ${PACKEDFILES} tds/tex/latex/standalone
+ ${CP} ${SRCFILES} tds/source/latex/standalone
+ cd tds; zip -r ../$@ .
diff --git a/Master/texmf-dist/source/latex/standalone/README b/Master/texmf-dist/source/latex/standalone/README
index 95b232e94e9..4d4f01593ac 100644
--- a/Master/texmf-dist/source/latex/standalone/README
+++ b/Master/texmf-dist/source/latex/standalone/README
@@ -1,7 +1,12 @@
LaTeX class and package 'standalone'
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copyright (c) 2010 by Martin Scharrer <martin@scharrer-online.de>
+WWW: http://latex.scharrer-online.de/standalone/
-Allows TeX pictures or other TeX code to be compiled standalone or as part of a main document.
+Allows TeX pictures or other TeX code in sub-files to be compiled standalone
+or as part of a main document.
Provides support for pictures with beamer overlays.
+Since v0.3 the package provides options to automatically or manually include
+all sub-files preambles in the main document preamble.
+
diff --git a/Master/texmf-dist/source/latex/standalone/standalone.dtx b/Master/texmf-dist/source/latex/standalone/standalone.dtx
index 70401808f37..17098bdb05d 100644
--- a/Master/texmf-dist/source/latex/standalone/standalone.dtx
+++ b/Master/texmf-dist/source/latex/standalone/standalone.dtx
@@ -20,19 +20,19 @@
% This work consists of the files standalone.dtx, standalone.ins
% and the derived file standalone.sty.
%
-% $Id: standalone.dtx 1714 2010-03-22 14:44:37Z martin $
+% $Id: standalone.dtx 1772 2010-03-27 13:50:59Z martin $
% \fi
%
% \iffalse
-%<cls|sty|cfg|tex>% $Id: standalone.dtx 1714 2010-03-22 14:44:37Z martin $
+%<cls|sty|cfg|tex>% $Id: standalone.dtx 1772 2010-03-27 13:50:59Z martin $
%<cls|sty>\NeedsTeXFormat{LaTeX2e}
-%<cls>\ProvidesClass{standalone} [2010/03/22 v0.2 Class to compile TeX sub-files standalone]
-%<sty>\ProvidesPackage{standalone} [2010/03/22 v0.2 Package to include TeX sub-files which use the 'standalone' class]
-%<tex>\ProvidesFile{standalone.tex}[2010/03/22 v0.2 Provides if-switch to show if file is compiled standalone]%
-%<cfg>\ProvidesFile{standalone.cfg}[2010/03/22 v0.2 Default configuration file for 'standalone' class and package]%
+%<cls>\ProvidesClass{standalone} [2010/03/27 v0.3a Class to compile TeX sub-files standalone]
+%<sty>\ProvidesPackage{standalone} [2010/03/27 v0.3a Package to include TeX sub-files with preambles]
+%<tex>\ProvidesFile{standalone.tex}[2010/03/27 v0.3a Provides if-switch to show if file is compiled standalone]%
+%<cfg>\ProvidesFile{standalone.cfg}[2010/03/27 v0.3a Default configuration file for 'standalone' class]%
%<*driver>
\NeedsTeXFormat{LaTeX2e}
-\ProvidesFile{standalone.dtx}[2010/03/22 v0.2 DTX File for 'standalone' cls/sty/tex/cfg files]
+\ProvidesFile{standalone.dtx}[2010/03/27 v0.3a DTX File for 'standalone' cls/sty/tex/cfg files]
\documentclass{ltxdoc}
\usepackage{ifpdf}
\usepackage{listings}
@@ -42,6 +42,9 @@
\usepackage{hyperref}
}
+\def\optpar#1{\marginpar{\hfill\opt{#1}}}
+\def\opt#1{{\sffamily#1}}
+
\EnableCrossrefs
\CodelineIndex
\RecordChanges
@@ -55,7 +58,7 @@
%</driver>
% \fi
%
-% \CheckSum{242}
+% \CheckSum{1111}
%
% \CharacterTable
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -76,10 +79,12 @@
%
% \changes{v0.1}{2010/03/21}{First released version}
% \changes{v0.2}{2010/03/22}{Added support for beamer style settings in the config file using \cs{ifstandalonebeamer}. Updated documentation.}
+% \changes{v0.3}{2010/03/26}{Added package options to automatically copy sub-preamble code to the main preamble.}
+% \changes{v0.3a}{2010/03/27}{Fixed bug related to line endings in \texttt{.sta} file. Listed sub-files now have \texttt{.tex} as default extension.}
%
% \GetFileInfo{\jobname.dtx}
%
-% \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\xdef,\DeclareRobustCommand}
+% \DoNotIndex{\newcommand,\newenvironment,\def,\edef,\xdef,\gdef,\DeclareRobustCommand}
% \DoNotIndex{\expandafter,\if,\else,\fi,\ifnum,\ifx,\let,\global,\long}
% \DoNotIndex{\newcounter,\newcount,\message,\meaning,\noexpand,\relax,\value}
% \DoNotIndex{\setcounter,\addtocounter,\advance,\afterassignment,\AtEndOfPackage}
@@ -91,6 +96,7 @@
% \DoNotIndex{\aftergroup,\CurrentOption,\DeclareBoolOption,\DeclareDefaultOption,\DeclareStringOption,\DeclareVoidOption}
% \DoNotIndex{\endinput,\endpreview,\input,\LoadClass,\newif,\PassOptionsToPackage,\preview,\ProcessKeyvalOptions}
% \DoNotIndex{\renewcommand,\renewenvironment,\setbeamertemplate,\SetupKeyvalOptions,\space,\unskip,\usepackage}
+% \DoNotIndex{\unexpanded,\write,\next,\jobname,\hbox}
%
% \ifpdf
% \hypersetup{%
@@ -123,7 +129,8 @@
% the directories with a lot of extra files. A second method is to place the `main' components, i.e. a preamble, directly into the
% picture files and make the main document ignore this code sections.
%
-% The package |standalone| can be used in the main document to skip all extra preambles in included files.
+% The package |standalone| can be used in the main document to skip all extra preambles in included files. The main file must load all packages
+% and settings required by the sub-files. Several package options are provided to collect the preambles of the sub-files automatically and execute them from the main file.
%
% A |standalone| class is also provided to minimise the extra preamble code needed in this files.
% It's usage is optional, but simplifies and standardises how picture files are compiled standalone.
@@ -132,19 +139,23 @@
% on a per directory base.
%
% \subsection*{Similar Packages}
-% The |docmute| package by T.M.\ Trzeciak is written with the same function as the |standalone| package. However, no special class file or
-% configuration file is provided.
+% The |docmute| package by T.M.\ Trzeciak is written for the same basic task as the |standalone| package. However, no sub-preamble processing other than the removal is support. It also
+% doesn't provide a special class or configuration file.
%
% \section{Usage}
% \subsection{Quick instructions}
-% Load the |standalone| \emph{package} and all packages needed by all the sub-files in the main document and include your picture or other sub-files using |\input| as normal.
-% In the sub-files use the |standalone| \emph{class} using the normal \cs{documentclass} and load all packages needed for the particular
-% file. Finally wrap the actual file content in a |document| environment.
+% Load the |standalone| \emph{package} very early in the main document. Also all packages needed by all the sub-files must be loaded by the main document.
+% Include your picture or other sub-files using |\input| or a similar macro as normal.
+% In the sub-files use the |standalone| \emph{class} with a normal \cs{documentclass} and load all packages needed for the particular
+% file. Finally wrap the actual content of the sub-file in a |document| environment.
%
% When the sub-file is compiled on its own the |\documentclass| and |document| environment will be active as normal. The main file, however,
% will skip everything from the |\documentclass| till the |\begin{document}|. The (now fake) |document| environment is redefined to be a simple
% TeX-group. Any code after the |\end{document}| will be ignored. The real |document| environment of the main file will be unaffected and will work as normal.
%
+% Instead of transferring the packages required by each sub-file manually to the main document preamble, this task can be automatised using
+% the options listed in section~\ref{sec:pkgoptions}
+%
% \subsection{Class Options}
% The |standalone| class will load a real document class. By default this is |article|. The document class normally has not much
% influence on sub-files like pictures, especially when the |preview| package is active. However, the used class can be adjusted by the user
@@ -154,8 +165,57 @@
%
% All other used options are passed to the loaded class.
%
-% \subsection{Package Options}
-% At the moment the |standalone| package does not provide any options.
+% \subsection{Package Options}\label{sec:pkgoptions}
+% The |standalone| package removes all sub-file preambles (``sub-preambles'') by default when loaded.
+% However, if the package is loaded with the \opt{subpreambles}\optpar{subpreambles} options, all sub-preambles are stored in an auxiliary file with the name `\meta{main tex file name}|.sta|' (for \emph{sta}ndalone).
+% This file is then loaded or processed at the beginning of the next \LaTeX\ run (i.e.\ at the place in the preamble where the |standalone| package is loaded).
+% The way how the \opt{subpreambles} option works can be controlled by the options \opt{sort}, \opt{print} and \opt{comments}/\opt{nocomments}.
+% Please note that the \opt{sort} and \opt{print} options require of course the \opt{subpreambles} option and will enable it if not already done so.
+%
+% With only the \opt{subpreambles} option set, the sub-preambles are simple read and executed unchanged. This includes the risk of option clashes if one package is loaded with different
+% options inside the sub-preambles and/or the main preamble. This is avoided by the \opt{sort}\optpar{sort} option, which accumulates all packages loaded by all sub-files together with their options.
+% The options are then marked to be loaded by the package using \LaTeX{}s \cs{PassOptionsToPackage} macro. The packages are loaded at the end of the preamble using the \cs{AtBeginDocument} hook.
+% This allows the user to load the same packages with own options in the main file, after the |subversion| package is loaded, without any option clashes.
+%
+% While the \opt{sort} option is giving already good results, problems with the order of packages can still occur. Some packages provide, redefine or patch the same macros, so that they must be loaded in
+% the correct order to give the desired result. Potential additional code in the sub-preambles, required for some sub-figures but maybe incompatible with others, complicates the situation further.
+% If such issues occur they can hardly be handled in an automatic way. Instead the sub-preambles must be carefully merged into the main preamble.
+% The option \opt{print}\optpar{print} was created to simplify this otherwise cumbersome task.
+% It concatenated all sub-preambles into a single file named `\meta{main tex file name}|.stp|' (for \emph{st}andalone, \emph{p}rint). Each preamble is commented with its original file name.
+% Please note that |.sta| file mentioned above, while quite similar, holds additional macros and might not be easily user readable or editable.
+% After the file was generated it can be easily pasted into the main file preamble using a text editor.
+%
+% When the \opt{print} option is enabled the normal |.sta| file is not generated or loaded. Because this will cause most likely some errors related to packages not loaded, all sub-file bodies will be skipped.
+% A warning is printed for each sub-file to remind the user about this fact. The \opt{print} option is only indented to by used when required to get a list of sub-preambles. After including this list in the main file the option
+% must be removed to compile the main file normally.
+%
+% Finally if both the \opt{print} and \opt{sort}\optpar{print, sort} options are enabled, a `sorted' list of sub-preambles is printed into the |.stp| file. In this `sorted print' mode all |\usepackage| macros (and similar macros like
+% |\usepgflibrary|, |\usetikzlibrary| and |\usetikztiminglibrary| from the |pgf|, |tikz| and |tikz-timing| packages, respectively) are removed from the rest of the sub-preamble code.
+% A list of packages (and libraries) without duplicates is printed at the begin of the |.stp| file (using |\usepackage|, of course). Every option provided by any sub-file for a package is added, again without duplicates.
+% If specific package date was requested in a sub-file it is also added. If multiple dates are requested for one package, the most recent (i.e.\ the ``highest one'', not the last processed) is used.
+% After this list(s) the rest of the sub-preamble code is printed with the above macros removed. This mode frees the user from the need to remove duplicates and collect package options manually.
+%
+% Please note that all |\usepackage| and similar macros inside braces |{ }| will not be seen by |standalone|s sort macro and therefore are not extracted or handled in any special form mentioned above.
+% This can be exploited to load certain packages only in |standalone| mode but not in the main document.
+% Unfortunately, macros inside |\ifstandalone|\ldots|\fi| are seen and extracted while not wanted inside the main file.
+% The macro \cs{onlyifstandalone}\marg{code} (see below) was created because of this two reasons. Its argument braces hide the content from the scanner.
+% It is then also completely removed from the printed sub-preamble code.
+%
+% The complementary options \opt{comments}/\opt{nocomments}\optpar{comments/nocomments} select if the |.stp| file should also include the comments of the sub-preambles.
+% Comments are included by default in the non-sorting print mode (\opt{print} without \opt{sort} option), but can cause `wrong' results during the `sorting' process and are therefore removed by default in this mode.
+% The reason for this can be explained as follows.
+% In order to transfer the comments from the sub-files to the |.stp| file \TeX\ must be instructed to handle them as normal input and not discard them.
+% However, in this case the scanning algorithm which removes |\usepackage| and friends can not distinguish
+% between `active' macros and macros which are commented out. All above mentioned macro inside comments will then be processed as when there where `active'.
+% The user might favour the information provided by the comments over this small risk and enable them using the \opt{comments} option.
+%
+% \subsection{Dependencies}
+% The |standalone| class requires the |kvoptions| package (Oberdiek bundle) and the |preview| package. Both should be available in a standard \LaTeX\ installation.
+% The |beamer| option of course requires the |beamer| bundle to be installed.
+% The |standalone| package does not require other packages, but can take advantage from the |fink| package (\emph{Fi}le \emph{N}ame \emph{K}eeper),
+% to access the filenames of the sub-files. For this the |fink| package must be loaded before |standalone|. Without it a file name macro defined by \LaTeX\ itself
+% is used instead which should do also fine, but is reset at every |\input| macro. Placing this macro before |\documentclass| without marking
+% it with |\csname standaloneignore\endcsname| will then lead to wrong file names inside the |.sta| and |.stp| files.
%
% \subsection{Environments and Macros}
%
@@ -178,7 +238,59 @@
% The additional file |standalone.tex| also defines this switch by checking if \cs{documentclass} was already used. It can be included
% with |\input{standalone}| and is intended for specialised files which do not use the |standalone| class.
%
+% \DescribeMacro{\ifstandalonebeamer}
+% Both the class and the package provide the if-switch \cs{ifstandalonebeamer}, which can be used to only include code if the file is
+% compiled standalone with the |beamer| class option set.
+% The switch is set to \cs{iftrue} by the class when loaded with the |beamer| option and always to \cs{iffalse} by the package.
+%
+% \DescribeMacro{\onlyifstandalone}\hspace*{-\parindent}\hspace*{-\marginparsep}\marg{code}\hspace*{\parindent}
+% This is the macro version of the |\ifstandalone| if-switch. It executes \meta{code} only in |standalone| mode. As mentioned in section~\ref{sec:pkgoptions}
+% it can also be used to hide |\usepackage| and similar macros from the extraction scanner of the |sort| option. The macro and its argument is not printed into the |.stp| file.
+%
+% \DescribeMacro{\standaloneignore}
+% In rare cases some code must be placed before the |\documentclass| of a sub-file (e.g.\ |\PassOptionsToPackage|).
+% Because the main document will only skip code between |\documentclass| and |\begin{document}| this code will be executed by it.
+% In order to avoid this the macro \cs{standaloneignore} can be used at the very beginning of a sub-file to skip over this code.
+% However it must be written as |\csname standaloneignore\endcsname| to avoid a `Undefined control sequence' error when compiled standalone.
+% After all the class is not loaded at this point, therefore no |standalone| macros are yet defined.
+% The |\csname|\ldots|\endcsname| construct will simple make it equal to |\relax| in this case.
+%
+% Please note that all code before |\documentclass| is not processed by any of the \opt{subpreamble} options but always simply removed.
+% This macro was inspired by the similar macro |\docmute| of the |docmute| package.
+%
+% ^^A\newpage
+% \subsection{Usage Examples}
+%
% \def\lstlistingname{Example}
+%
+% \par\noindent
+% \begin{minipage}{\textwidth}
+% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Use of \emph{standalone} package.}]
+% % Main file
+% % Real document class:
+% \documentclass{article}
+%
+% % Use the 'standalone' package:
+% \usepackage{standalone}
+%
+% % Load all packages needed for all sub-files:
+% \usepackage{tikz}
+%
+% % Inside the real 'document' environment
+% % read the sub-file with '\input'
+% \begin{document}
+% % ...
+% \begin{figure}
+% \input{subfile}
+% \caption{A subfile}
+% \end{figure}
+% % ...
+% \end{document}
+% \end{lstlisting}
+% \end{minipage}
+%
+% \par\noindent
+% \begin{minipage}{\textwidth}
% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Use of \emph{standalone} class.}]
% % A sub-file (e.g. picture) using the 'standalone' class:
% % Use 'standalone' as document class:
@@ -195,13 +307,17 @@
% \end{tikzpicture}
% \end{document}
% \end{lstlisting}
+% \end{minipage}
%
+% \par\noindent
+% \begin{minipage}{\textwidth}
% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Effective code if compiled standalone.}]
% \documentclass{article}
%
% \newenvironment{standalone}{\begin{preview}}{\end{preview}}
% \input{standalone.cfg}
-% % which by defaults loads: \PassOptionsToPackage{active,tightpage}{preview}
+% % which by defaults loads:
+% % \PassOptionsToPackage{active,tightpage}{preview}
% \usepackage{preview}
%
% \usepackage{tikz}
@@ -214,7 +330,10 @@
% \end{standalone}
% \end{document}
% \end{lstlisting}
+% \end{minipage}
%
+% \par\noindent
+% \begin{minipage}{\textwidth}
% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Effective code if included in a main document.}]
% \begingroup
% \begin{tikzpicture}
@@ -223,31 +342,9 @@
% \endgroup
% \endinput
% \end{lstlisting}
+% \end{minipage}
%
%
-% \subsection{Usage of the package}
-% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Use of \emph{standalone} package.}]
-% % Main file
-% % Real document class:
-% \documentclass{article}
-%
-% % Use the 'standalone' package:
-% \usepackage{standalone}
-%
-% % Load all packages needed for all sub-files:
-% \usepackage{tikz}
-%
-% % Inside the real 'document' environment read the sub-file with '\input'
-% \begin{document}
-% % ...
-% \begin{figure}
-% \input{subfile}
-% \caption{A subfile}
-% \end{figure}
-% % ...
-% \end{document}
-% \end{lstlisting}
-%
%
% \subsection{Support for Beamer Presentations}\label{sec:beamer}
% Presentation can be written in \LaTeX\ using the |beamer| class. Each presentation frame is wrapped in a |frame| environment. Overlay effects
@@ -263,26 +360,29 @@
% This if switch is only true if the class is compiled with the |beamer| option. The package sets it to false.
% It can be used to place beamer specific options in the configuration files, which should be skipped for non-beamer standalone files.
%
-% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Use of \emph{standalone} class.}]
+% \par\bigskip\noindent
+% \begin{minipage}{\textwidth}\noindent
+% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Use of \texttt{standalone} class with \texttt{beamer} option.}]
% % Use of 'standalone' class with a beamer overlay:
% \documentclass[beamer]{standalone}
-%
% % Load packages needed for this TeX file:
% \usepackage{tikz}
%
% % Surround TeX code with 'document' environment as usually:
% \begin{document}
-% \begin{standaloneframe}[options, e.g. 'fragile' for verbatim content]
+% \begin{standaloneframe}[options] % e.g. 'fragile'
% % Add your TeX code:
% \only<1>{ One }%
% \only<2>{ Two }%
% \end{standaloneframe}
% \end{document}
% \end{lstlisting}
+% \end{minipage}
%
+% \par\bigskip\noindent
+% \begin{minipage}{\textwidth}\noindent
% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Effective beamer code if compiled standalone.}]
% \documentclass{beamer}
-%
% \input{standalone.cfg}
%
% \usepackage{tikz}
@@ -294,7 +394,10 @@
% \end{frame}
% \end{document}
% \end{lstlisting}
+% \end{minipage}
%
+% \par\bigskip\noindent
+% \begin{minipage}{\textwidth}\noindent
% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Effective code if included in a beamer presentation.}]
% \begingroup
% \only<1>{ One }%
@@ -302,14 +405,18 @@
% \endgroup
% \endinput
% \end{lstlisting}
+% \end{minipage}
%
% \subsection{\texttt{standalone.tex}}
+% \noindent
+% \begin{minipage}{\textwidth}\noindent
% \begin{lstlisting}[language={[latex]tex},gobble=4,frame=lines,caption={Usage of 'standalone.tex'.}]
% \input{standalone} % use before any '\documentclass'
% \ifstandalone
% % Used only if compiled standalone
% \fi
% \end{lstlisting}
+% \end{minipage}
%
% \subsection{Usage with \texttt{svn-multi} keywords}\label{sec:svnmulti}
% If the version control package \texttt{svn-multi} is used, the keyword macros (|\svnid| or |\svnidlong|)
@@ -326,41 +433,762 @@
% \iffalse
%<*sty>
% \fi
+% The package file is to be loaded by a main document which includes |standalone| sub-files.
+% It is also loaded by the |standalone| class to share code. The class then redefines certain macros.
+%
+% \subsubsection{If-Switches}
+%
+% \begin{macro}{\ifstandalone}
+% Declare |standalone| if-switch and set it to false. The class will set it to true.
+% The |\csname| trickery is used to avoid issues if the switch was already defined.
% \begin{macrocode}
\expandafter\newif\csname ifstandalone\endcsname
\standalonefalse
% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\ifstandalonebeamer}
+% \changes{v0.2}{2010/03/23}{New macro}
+% Make sure that |standalonebeamer| if-switch is defined and set it to false.
+% If the class was loaded beforehand with the |beamer| option it is already defined as true.
+% The |\csname| trickery is used to avoid issues if the switch was already defined.
% \begin{macrocode}
\@ifundefined{ifstandalonebeamer}{%
\expandafter\newif\csname ifstandalonebeamer\endcsname
\standalonebeamerfalse
}{}%
% \end{macrocode}
+% \end{macro}
%
-% \begin{macro}{\sa@documentclass}
+% \begin{macro}{\onlyifstandalone}
+% \changes{v0.3}{2010/03/26}{New macro}
+% Macro version of |\ifstandalone|. The |{ }| around the argument protects the content from the package etc. scanners.
+% Only defined if not already defined by the class, in the case of a |standalone| file included other |standalone| files.
% \begin{macrocode}
-\newcommand{\sa@documentclass}[2][]{%
- \let\document\sa@document
- \expandafter\sa@@documentclass
+\@ifundefined{onlyifstandalone}
+ {\let\onlyifstandalone\@gobble}
+ {}
+% \end{macrocode}
+% \end{macro}
+%
+%
+% \begin{macro}{\ifsa@subpreambles}
+% \begin{macro}{\ifsa@sortsubpreambles}
+% \begin{macro}{\ifsa@printsubpreambles}
+% The if-switches for the options.
+% \begin{macrocode}
+\newif\ifsa@subpreambles
+\newif\ifsa@sortsubpreambles
+\newif\ifsa@printsubpreambles
+% \end{macrocode}
+% \end{macro}
+% \end{macro}
+% \end{macro}
+%
+% \subsubsection{Options}
+% \begin{macrocode}
+\DeclareOption{subpreambles}{%
+ \sa@subpreamblestrue
+}
+\DeclareOption{sort}{%
+ \sa@subpreamblestrue
+ \sa@sortsubpreamblestrue
+}
+\DeclareOption{print}{%
+ \sa@subpreamblestrue
+ \sa@printsubpreamblestrue
+}
+\DeclareOption{comments}{%
+ \def\sa@percent{\@makeother\%}%
+}
+\DeclareOption{nocomments}{%
+ \def\sa@percent{}%
+}
+\ProcessOptions*\relax
+% \end{macrocode}
+%
+% In non-sorted print mode comments are preserved by default.
+% \begin{macrocode}
+\ifsa@printsubpreambles
+ \ifsa@sortsubpreambles\else
+ \@ifundefined{sa@percent}{%
+ \def\sa@percent{\@makeother\%}%
+ }{}%
+ \fi
+\fi
+% \end{macrocode}
+%
+% \begin{macro}{\sa@filepath}
+% File name macro. If the |fink| package is loaded the macros \cs{finkdir} (with leading `|./|' removed) and \cs{finkpath} is used, otherwise the \LaTeX\ macro
+% \cs{@filef@und} (with trailing space removed and with '.tex' added if it has no file extension).
+% The latter causes issues if |\input| etc. was used before |\documentclass| in sub-files.
+% \begin{macrocode}
+\@ifundefined{finkpath}{%
+ \def\sa@rmspace#1 \empty{#1}%
+ \def\sa@chkext#1.#2 \empty#3{%
+ \ifx\empty#3\empty
+ \sa@rmspace#1\empty.#2%
+ \else
+ #1.#2%
+ \expandafter\sa@rmrest
+ \fi
+ }%
+ \def\sa@rmrest tex \empty{}%
+ \def\sa@filepath{\expandafter\sa@chkext\@filef@und\empty.tex \empty\empty}%
+}{%
+ \def\sa@filepath{\expandafter\expandafter\expandafter\sa@rmdotslash\expandafter\finkdir\finkfile\empty./\empty}%
+ \def\sa@rmdotslash#1./#2\empty{%
+ \ifx\empty#1\empty
+ \sa@@rmdotslash#2%
+ \else
+ \ifx\empty#2\empty
+ #1%
+ \else
+ \sa@@rmdotslash#1./#2%
+ \fi
+ \fi
+ }
+ \def\sa@@rmdotslash#1./\empty{#1}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \subsubsection{Processing of Sub-Preambles}
+%
+% \begin{macrocode}
+\ifsa@subpreambles
+% \end{macrocode}
+%
+% \begin{macro}{\sa@out}
+% Write handle.
+% \begin{macrocode}
+\newwrite\sa@out
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@write}
+% Helper macro for file output.
+% \begin{macrocode}
+\def\sa@write{\immediate\write\sa@out}%
+% \end{macrocode}
+% \end{macro}
+%
+%
+% \begin{macrocode}
+\ifsa@printsubpreambles
+% \end{macrocode}
+%
+% \begin{macro}{\sa@removeonlyifstandalone}
+% Scans for |\onlyifstandalone| and removes it argument.
+% \begin{macrocode}
+\long\def\sa@removeonlyifstandalone#1\onlyifstandalone{%
+ \g@addto@macro\sa@preamble{#1}%
+ \@ifnextchar\sa@endmarker
+ {\@gobble}%
+ {\expandafter\sa@gobbleeol\expandafter\sa@removeonlyifstandalone\expandafter^^J\@gobble}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macrocode}
+\fi
+% \end{macrocode}
+%
+%
+% \subsubsection{Sorting of package options}
+%
+% Macros only needed for this mode are defined inside the |\if...|
+% to save memory otherwise.
+%
+% \begin{macrocode}
+\ifsa@sortsubpreambles
+% \end{macrocode}
+%
+% \begin{macro}{\sa@usepackagewithoutoptions}
+% Simply calls the original |\usepackage| while skipping the optional
+% argument with potential package options.
+% \begin{macrocode}
+\newcommand{\sa@usepackagewithoutoptions}[2][]{%
+ \sa@orig@usepackage{#2}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@endmarker}
+% Unique end marker. Will not be expanded.
+% \begin{macrocode}
+\def\sa@endmarker{%
+ \@gobble{sa@endmarker}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macrocode}
+\ifsa@printsubpreambles
+% \end{macrocode}
+%
+%
+% In sorted print mode all collected package etc. information is printed into the output file, followed
+% by the reduced sub-preambles.
+% \begin{macrocode}
+\AtEndDocument{%
+ \sa@write{\@percentchar\space Packages required by sub-files:}%
+ \expandafter\@for\expandafter\pkg\expandafter:\expandafter=\sa@collpkgs\do{%
+ \ifx\pkg\empty\else
+ \sa@write{%
+ \string\usepackage%
+ \expandafter\ifx\csname sa@pkgopts@\pkg\endcsname\empty\else%
+ [\csname sa@pkgopts@\pkg\endcsname]%
+ \fi
+ {\pkg}%
+ \expandafter\ifx\csname sa@pkgdate@\pkg\endcsname\relax\else%
+ [\csname sa@pkgdate@\pkg\endcsname]%
+ \fi
+ }%
+ \fi
+ }%
+ \ifx\sa@collpgflibs\empty\else
+ \sa@write{^^J\@percentchar\space PGF libraries required by sub-files:}%
+ \expandafter\@for\expandafter\lib\expandafter:\expandafter=\sa@collpgflibs\do{%
+ \ifx\lib\empty\else
+ \sa@write{\string\usepgflibrary{\lib}}%
+ \fi
+ }%
+ \fi
+ \ifx\sa@colltikzlibs\empty\else
+ \sa@write{^^J\@percentchar\space TikZ libraries required by sub-files:}%
+ \expandafter\@for\expandafter\lib\expandafter:\expandafter=\sa@colltikzlibs\do{%
+ \ifx\lib\empty\else
+ \sa@write{\string\usetikzlibrary{\lib}}%
+ \fi
+ }%
+ \fi
+ \ifx\sa@colltikztiminglibs\empty\else
+ \sa@write{^^J\@percentchar\space TikZ-Timing libraries required by sub-files:}%
+ \expandafter\@for\expandafter\lib\expandafter:\expandafter=\sa@colltikztiminglibs\do{%
+ \ifx\lib\empty\else
+ \sa@write{%
+ \string\usetikztiminglibrary%
+ \expandafter\ifx\csname sa@tikztimingopts@\lib\endcsname\empty\else%
+ [\csname sa@tikztimingopts@\lib\endcsname]%
+ \fi
+ {\lib}%
+ \expandafter\ifx\csname sa@tikztimingdate@\lib\endcsname\relax\else%
+ [\csname sa@tikztimingdate@\lib\endcsname]%
+ \fi
+ }%
+ \fi
+ }%
+ \fi
+ \sa@write{\expandafter\unexpanded\expandafter{\sa@preamble}}%
+ \message{^^JPackage 'standalone' INFO: See file '\jobname.stp' for list of sub-preambles.^^J}%
+ \immediate\closeout\sa@out
+}
+% \end{macrocode}
+%
+% \begin{macro}{\sa@removepackages}
+% Scans for |\usepackage|.
+% \begin{macrocode}
+\long\def\sa@removepackages#1\usepackage{%
+ \sa@removepgflibs#1\usepgflibrary\sa@endmarker
+ \@ifnextchar\sa@endmarker
+ {\@gobble}%
+ {\sa@sortpackages}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@removepgflibs}
+% Scans for |\usepgflibrary|.
+% \begin{macrocode}
+\long\def\sa@removepgflibs#1\usepgflibrary{%
+ \sa@removetikzlibs#1\usetikzlibrary\sa@endmarker
+ \@ifnextchar\sa@endmarker
+ {\@gobble}%
+ {\sa@sortpgflibs}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@removetikzlibs}
+% Scans for |\usetikzlibrary|.
+% \begin{macrocode}
+\long\def\sa@removetikzlibs#1\usetikzlibrary{%
+ \sa@removetikztiminglibs#1\usetikztiminglibrary\sa@endmarker
+ \@ifnextchar\sa@endmarker
+ {\@gobble}%
+ {\sa@sorttikzlibs}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@removetikztiminglibs}
+% Scans for |\usetikztiminglibrary|.
+% \begin{macrocode}
+\long\def\sa@removetikztiminglibs#1\usetikztiminglibrary{%
+ \sa@removeonlyifstandalone#1\onlyifstandalone\sa@endmarker
+ \@ifnextchar\sa@endmarker
+ {\@gobble}%
+ {\sa@sorttikztiminglibs}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@sortpackage}
+% Reads \cs{usepackage} arguments and stores them away. A list of all packages is compiled. Every package is only
+% added once and has also a list of options used, also only saved once.
+% If package dates are requested then the highest one is stored. Trailing newlines are removed.
+% \begin{macrocode}
+\def\sa@collpkgs{}%
+\newcommand\sa@sortpackages[2][]{%
+ \@ifnextchar[%]
+ {\sa@@sortpackages{#1}{#2}}%
+ {\sa@@sortpackages{#1}{#2}[]}%
+}
+\def\sa@@sortpackages#1#2[#3]{%
+ \@for\pkg:=#2\do {%
+ \@ifundefined{sa@pkgopts@\pkg}%
+ {%
+ \expandafter\g@addto@macro\expandafter\sa@collpkgs\expandafter{\expandafter,\pkg}%
+ \global\@namedef{sa@pkgopts@\pkg}{#1}%
+ \global\@namedef{sa@pkgopt@\pkg @}{}%
+ \ifx\relax#1\relax\else
+ \@for\opt:=#1\do{\global\@namedef{sa@pkgopt@\pkg @\opt}{}}%
+ \fi
+ }%
+ {%
+ \ifx\relax#1\relax\else
+ \@for\opt:=#1\do{%
+ \@ifundefined{sa@pkgopt@\pkg @\opt}%
+ {%
+ \expandafter\g@addto@macro\csname sa@pkgopts@\pkg\expandafter\endcsname\expandafter{\expandafter,\opt}%
+ \global\@namedef{sa@pkgopt@\pkg @\opt}{}%
+ }{}%
+ }%
+ \fi
+ }%
+ \ifx\relax#3\relax\else
+ \@ifundefined{sa@pkgdate@\pkg}%
+ {\global\@namedef{sa@pkgdate@\pkg}{#3}}%
+ {%
+ \begingroup
+ \edef\@tempa{{\csname sa@pkgdate@\pkg\endcsname}{#3}}%
+ \expandafter\sa@getlargerdate\@tempa
+ \expandafter\xdef\csname sa@pkgdate@\pkg\endcsname{\sa@thedate}%
+ \endgroup
+ }%
+ \fi
+ }%
+ \sa@gobbleeol\sa@removepackages^^J%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@getlargerdate}
+% Takes two package dates and returns the larger one as \cs{sa@thedate}.
+% \begin{macrocode}
+\def\sa@getlargerdate#1#2{%
+ \sa@@getdate#1\relax\relax0/0/0\relax\empty\relax
+ \let\sa@datea\sa@date
+ \sa@@getdate#2\relax\relax0/0/0\relax\empty\relax
+ \ifdim\sa@datea pt>\sa@date pt
+ \def\sa@thedate{#1}%
+ \else
+ \def\sa@thedate{#2}%
+ \fi
+}
+\def\sa@@getdate#1/#2/#3\relax{%
+ \@ifnextchar\relax
+ {%
+ \def\sa@date{#1.#2#3}%
+ \sa@@rmdate
+ }%
+ {%
+ \def\sa@date{0}%
+ \sa@@rmdate
+ }%
+}
+\def\sa@@rmdate#1\empty\relax{}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@sortpgflibs}
+% Reads the \cs{usepgflibrary} argument and stores it away.
+% Trailing newlines are removed.
+% \begin{macrocode}
+\def\sa@collpgflibs{}%
+\def\sa@sortpgflibs#1{%
+ \@for\lib:=#1\do {%
+ \@ifundefined{sa@pgflib@\lib}%
+ {%
+ \expandafter\g@addto@macro\expandafter\sa@collpgflibs\expandafter{\expandafter,\lib}%
+ \global\@namedef{sa@pgflib@\lib}{}%
+ }%
+ {}%
+ }%
+ \sa@gobbleeol\sa@removepgflibs^^J%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@sorttikzlibs}
+% Reads the \cs{usetikzlibrary} argument and stores it away.
+% Trailing newlines are removed.
+% \begin{macrocode}
+\def\sa@colltikzlibs{}%
+\def\sa@sorttikzlibs#1{%
+ \@for\lib:=#1\do {%
+ \@ifundefined{sa@tikzlib@\lib}%
+ {%
+ \expandafter\g@addto@macro\expandafter\sa@colltikzlibs\expandafter{\expandafter,\lib}%
+ \global\@namedef{sa@tikzlib@\lib}{}%
+ }%
+ {}%
+ }%
+ \sa@gobbleeol\sa@removetikzlibs^^J%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@sorttikztiminglibs}
+% Reads \cs{usetikztiminglibrary} arguments and stores them away.
+% Trailing newlines are removed.
+% \begin{macrocode}
+\def\sa@colltikztiminglibs{}%
+\newcommand\sa@sorttikztiminglibs[2][]{%
+ \@ifnextchar[%]
+ {\sa@@sorttikztiminglibs{#1}{#2}}%
+ {\sa@@sorttikztiminglibs{#1}{#2}[]}%
+}
+\def\sa@@sorttikztiminglibs#1#2[#3]{%
+ \@for\lib:=#2\do {%
+ \@ifundefined{sa@tikztimingopts@\lib}%
+ {%
+ \expandafter\g@addto@macro\expandafter\sa@colltikztiminglibs\expandafter{\expandafter,\lib}%
+ \global\@namedef{sa@tikztimingopts@\lib}{#1}%
+ \global\@namedef{sa@tikztimingopt@\lib @}{}%
+ \ifx\relax#1\relax\else
+ \@for\opt:=#1\do{\global\@namedef{sa@tikztimingopt@\lib @\opt}{}}%
+ \fi
+ }%
+ {%
+ \ifx\relax#1\relax\else
+ \@for\opt:=#1\do{%
+ \@ifundefined{sa@tikztimingopt@\lib @\opt}%
+ {%
+ \expandafter\g@addto@macro\csname sa@tikztimingopts@\lib\expandafter\endcsname\expandafter{\expandafter,\opt}%
+ \global\@namedef{sa@tikztimingopt@\lib @\opt}{}%
+ }{}%
+ }%
+ \fi
+ }%
+ \ifx\relax#3\relax\else
+ \@ifundefined{sa@tikztimingdate@\lib}%
+ {\global\@namedef{sa@tikztimingdate@\lib}{#3}}%
+ {%
+ \begingroup
+ \edef\@tempa{{\csname sa@tikztimingdate@\lib\endcsname}{#3}}%
+ \expandafter\sa@getlargerdate\@tempa
+ \expandafter\xdef\csname sa@tikztimingdate@\lib\endcsname{\sa@thedate}%
+ \endgroup
+ }%
+ \fi
+ }%
+ \sa@gobbleeol\sa@removetikztiminglibs^^J%
+}
+% \end{macrocode}
+% \end{macro}
+%
+%
+% \begin{macro}{\sa@gobbleopt}
+% Gobbles an optional argument and a potential line endings and then executes the command given by |#1|.
+% \begin{macrocode}
+\def\sa@gobbleopt#1[#2]{%
+ \@ifnextchar^^J%
+ {\sa@gobbleeol{#1}}{#1}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macrocode}
+\else
+% \end{macrocode}
+%
+% \begin{macro}{\sa@scanpackages}
+% Scans for |\usepackage|.
+% \begin{macrocode}
+\def\sa@scanpackages#1\usepackage{%
+ \@ifnextchar\sa@endmarker
+ {\@gobble}%
+ {\sa@collectpackage}
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@collectpackage}
+% Reads \cs{usepackage} arguments (ignores optional date) and stores it away.
+% The options are later passed to the package to avoid option clashes.
+% \begin{macrocode}
+\newcommand\sa@collectpackage[2][]{%
+ \ifx\relax#1\relax\else
+ \g@addto@macro\sa@collopts{\PassOptionsToPackage{#1}{#2}}%
+ \fi
+ \sa@scanpackages
+}
+\fi
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\sa@collopts}
+% Accumulator for collected options. Is executed and cleared at the end of this package.
+% \begin{macrocode}
+\def\sa@collopts{}
+\AtEndOfPackage{\sa@collopts\let\sa@collopts\relax}
+% \end{macrocode}
+% \end{macro}
+%
+% End of |\ifsa@sortsubpreambles|.
+% \begin{macrocode}
+\fi
+% \end{macrocode}
+%
+% \begin{environment}{standalonepreambles}
+% This environment simply adds a group and sets the endline character to a printed newline and the argument character
+% |#| as a normal character. The first suppresses |\par|'s in the stored sub-preambles while preserving newlines. The latter
+% is required to permit macro arguments in the preambles. Otherwise a |#| is doubled to |##| causing compile errors when the
+% sub-preambles are used.
+% The |.sta| file is closed after this environment.
+% \begin{macrocode}
+\def\standalonepreambles{%
+ \begingroup
+ \endlinechar=\m@ne
+ \@makeother\#%
+}
+\def\endstandalonepreambles{%
+ \endgroup
+ \endinput
+}
+% \end{macrocode}
+% \end{environment}
+%
+% \begin{environment}{subpreambles}
+% This environment rereads the sub-preambles from the |.sta| files and stores it globally under the name
+% ``\cs{prevsubpreamble@}\meta{file name}''. If sorting is enabled the sub-preambles are also scanned for
+% loaded packages.
+% \begin{macrocode}
+\long\gdef\subpreamble#1#2\endsubpreamble{%
+ \expandafter\gdef\csname prevsubpreamble@#1\endcsname{#2}%
+ \ifsa@sortsubpreambles
+ \sa@scanpackages#2\usepackage\sa@endmarker
+ \fi
+}
+\def\endsubpreamble{}%
+% \end{macrocode}
+% \end{environment}
+%
+% If in |print| mode open the |.stp| file.
+% \begin{macrocode}
+\ifsa@printsubpreambles
+ \immediate\openout\sa@out=\jobname.stp\relax
+\else
+% \end{macrocode}
+% otherwise:
+%
+% Process |.sta| file from last run. All changes must be made by own macros which define the value globally.
+% Therefore the input is wrapped in a group. Some spaces or special line endings could process typeset content,
+% which causes errors inside the preamble. To be on the save side the input `content' is stored in a temp box.
+% \begin{macrocode}
+\begingroup
+ \setbox\@tempboxa\hbox{%
+ \InputIfFileExists{\jobname.sta}{}{\PackageInfo{standalone}{STA file not found!}{}{}}%
+ }%
+\endgroup
+% \end{macrocode}
+
+% \begin{macro}{\AtBeginDocument}
+% At begin of the document the |.sta| file is read again. This time the sub-preamble macros are executed as normal.
+% The |standalone| macros are defined to be without effect. If `sorting' is enabled \cs{usepackage} is temporarily
+% redefined to ignore any given options, which where already passed (\cs{PassOptionsToPackage}) beforehand.
+% \begin{macrocode}
+\AtBeginDocument{%
+ \let\subpreamble\@gobble
+ \let\endsubpreamble\relax
+ \let\standalonepreambles\relax
+ \let\endstandalonepreambles\relax
+ \ifsa@sortsubpreambles
+ \let\sa@orig@usepackage\usepackage
+ \let\usepackage\sa@usepackagewithoutoptions
+ \fi
+ \InputIfFileExists{\jobname.sta}{}{}%
+ \ifsa@sortsubpreambles
+ \let\usepackage\sa@orig@usepackage
+ \fi
+ \immediate\openout\sa@out=\jobname.sta\relax
+ \immediate\write\sa@out{\string\standalonepreambles}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\AtEndDocument}
+% At end of the document write end macro to and close |.sta| file.
+% \begin{macrocode}
+\AtEndDocument{%
+ \sa@write{\string\endstandalonepreambles}%
+ \immediate\closeout\sa@out
+}
+% \end{macrocode}
+% \end{macro}
+%
+% End of |\ifsa@printsubpreambles|.
+% \begin{macrocode}
+\fi
+% \end{macrocode}
+%
+% End of |\ifsa@subpreambles|.
+% \begin{macrocode}
+\fi
+% \end{macrocode}
+%
+%
+% \subsubsection{Skipping of Sub-Preambles in Main Mode}
+%
+% This macros make the main document skip all preambles in sub-files.
+%
+% \begin{macro}{\sa@gobbleeol}
+% Gobbles all following line endings (i.e.\ empty lines) and then executes the command given by |#1|.
+% Because |\@ifnextchar| ignores spaces this also removes lines with only spaces.
+% \begin{macrocode}
+\def\sa@gobbleeol#1^^J{%
+ \@ifnextchar^^J%
+ {\sa@gobbleeol{#1}}{#1}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\standaloneignore}
+% \changes{v0.3}{2010/03/26}{New macro}
+% This macro must only be used in a sub-file before a |\documentclass|. It gobbles everything up to this macro
+% and then executes the |standalone| definition of it shown further below.
+% It should be written as |\csname standaloneignore\endcsname| to ignore errors in standalone mode.
+% The second definition allows the user to also write |\csname standaloneignore \endcsname| (note the extra space)
+% without errors.
+% \begin{macrocode}
+\long\def\standaloneignore#1\documentclass{%
+ \sa@documentclass
}
+\@namedef{standaloneignore\space}{\standaloneignore}
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{\sa@@documentclass}
+% \begin{macro}{\sa@documentclass}
+% The |standalone| definition of \cs{documentclass}. If the sub-preambles are to be processed then the
+% starting content is written into the output file etc., but only for the first time this sub-file is included.
+% Some input related settings are set-up (line endings, macro argument and comments).
+% Finally \cs{sa@gobble} is called to process the preamble.
% \begin{macrocode}
-\def\sa@@documentclass{%
- \begingroup\def\sa@gobbleto{document}\sa@gobble
+\newcommand{\sa@documentclass}[2][]{%
+ \let\document\sa@document
+ \begingroup
+ \ifsa@subpreambles
+ \@ifundefined{sa@written@\sa@filepath}%
+ {%
+ \ifsa@printsubpreambles
+ \ifsa@sortsubpreambles
+ \begingroup
+ \edef\@tempa{^^J\@percentchar\space Preamble from file '\sa@filepath'^^J}%
+ \expandafter\g@addto@macro\expandafter\sa@preamble\expandafter{\@tempa}%
+ \endgroup
+ \else
+ \sa@write{^^J\@percentchar\space Preamble from file '\sa@filepath'}%
+ \fi
+ \else
+ \sa@write{\string\subpreamble{\sa@filepath}}%
+ \fi
+ }{}%
+ \global\@namedef{subpreamble@\sa@filepath}{}%
+ \ifsa@printsubpreambles
+ \endlinechar=`\^^J%
+ \else
+ \endlinechar=\m@ne
+ \fi
+ \@makeother\#%
+ \@nameuse{sa@percent}%
+ \fi
+ \def\sa@gobbleto{document}%
+ \sa@gobbleeol\sa@gobble^^J%
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\sa@gobble}
+% Gobbles everything to the next |\begin|, then checks if it was a |\begin{document}|.
+% If sub-preamble extraction is activated it accumulates the skipped content in macros
+% named ``\cs{subpreamble@}\meta{file name}''. Every sub-file is remembered and its preamble is only saved once.
+% In |print| mode the file body is ignored and a appropriate warning is printed,
+% otherwise the current and previous sub-preamble of the current processed file are compared. If different the file body is also
+% ignored to avoid errors due to possible newly required but not loaded packages. The user is warned again about this
+% and is asked to rerun \LaTeX{}.
% \begin{macrocode}
+\def\sa@preamble{}%
\long\def\sa@gobble#1\begin#2{%
\def\@tempa{#2}%
\ifx\@tempa\sa@gobbleto
- \def\next{\expandafter\endgroup\expandafter\begin\expandafter{\sa@gobbleto}}%
+ \ifsa@subpreambles
+ \expandafter\g@addto@macro\csname subpreamble@\sa@filepath\endcsname{#1}%
+ \@ifundefined{sa@written@\sa@filepath}%
+ {%
+ \ifsa@printsubpreambles
+ \ifsa@sortsubpreambles
+ \sa@removepackages#1\usepackage\sa@endmarker
+ \else
+ \begingroup
+ \let\sa@preamble\empty
+ \sa@removeonlyifstandalone#1\onlyifstandalone\sa@endmarker
+ \expandafter\sa@write\expandafter{\expandafter\unexpanded\expandafter{\sa@preamble}}%
+ \endgroup
+ \fi
+ \else
+ \sa@write{\unexpanded{#1}}%
+ \sa@write{\string\endsubpreamble}%
+ \fi
+ }{}%
+ \global\@namedef{sa@written@\sa@filepath}{}%
+ \ifsa@printsubpreambles
+ \def\next{%
+ \endgroup
+ \PackageWarning{standalone}{Running 'standalone' package in sub-preamble print mode. All body content of file `\sa@filepath' is ignored!}{}{}%
+ \null
+ \endinput
+ }
+ \else
+ \expandafter
+ \ifx
+ \csname prevsubpreamble@\sa@filepath \expandafter\endcsname
+ \csname subpreamble@\sa@filepath \endcsname
+ \def\next{\expandafter\endgroup\expandafter\begin\expandafter{\sa@gobbleto}}%
+ \else
+ %\expandafter\show\csname prevsubpreamble@\sa@filepath \endcsname
+ %\expandafter\show\csname subpreamble@\sa@filepath \endcsname
+ \def\next{%
+ \endgroup
+ \PackageWarning{standalone}{Sub-preamble of file '\sa@filepath' has changed. Content will be ignored. Please rerun LaTeX!}{}{}%
+ \immediate\write\@mainaux{%
+ \@percentchar\space standalone package info: Rerun LaTeX!
+ }
+ \null
+ \endinput
+ }
+ \fi
+ \fi
+ \else
+ \def\next{\expandafter\endgroup\expandafter\begin\expandafter{\sa@gobbleto}}%
+ \fi
\else
+ \ifsa@subpreambles
+ \expandafter\g@addto@macro\csname subpreamble@\sa@filepath\endcsname{#1\begin{#2}}%
+ \@ifundefined{sa@written@\sa@filepath}%
+ {\sa@write{\unexpanded{#1\begin{#2}}}}{}%
+ \fi
\def\next{\sa@gobble}%
\fi
\next
@@ -368,13 +1196,19 @@
% \end{macrocode}
% \end{macro}
%
+% \begin{environment}{standalone}
+% Provide an empty definition of the |standalone| environment. The class is defining it with the code required in |standalone| mode.
% \begin{macrocode}
\@ifundefined{standalone}
{\newenvironment{standalone}[1][]{}{}}
{}
% \end{macrocode}
+% \end{environment}
%
-% Gobbles all arguments: |<...>[<...>][...]{...}{...}|. Please note that the last two |{ }| arguments are also optional.
+% \begin{environment}{standalone}
+% Provide an `empty' definition of the |standaloneframe| environment.
+% It only gobbles all arguments: |<...>[<...>][...]{...}{...}|. Please note that the last two |{ }| arguments are also optional.
+% The class is defining it with the code required in |standalone| mode.
% \begin{macrocode}
\@ifundefined{standaloneframe}
{\@ifundefined{beamer@newenv}
@@ -400,19 +1234,22 @@
}
{}
% \end{macrocode}
+% \end{environment}
%
% \begin{macro}{\sa@orig@document}
-% \begin{macrocode}
-\let\sa@orig@document\document
-% \end{macro}
-%
% \begin{macro}{\sa@orig@enddocument}
+% Store original |document| environment.
% \begin{macrocode}
+\let\sa@orig@document\document
\let\sa@orig@enddocument\enddocument
% \end{macrocode}
% \end{macro}
+% \end{macro}
%
% \begin{macro}{\document}
+% Redefine the |\begin{document}| of the main file to redefine \cs{documentclass}.
+% This can not be done using \cs{AtBeginDocument} because the original redefines
+% \cs{documentclass} itself after executing the hook.
% \begin{macrocode}
\def\document{%
\sa@orig@document
@@ -423,6 +1260,8 @@
% \end{macro}
%
% \begin{macro}{\sa@document}
+% This is the |\begin{document}| of the sub files. It does nothing except of
+% redefining |\end{document}| and calling our own |atbegindocument| hook.
% \begin{macrocode}
\def\sa@document{%
\let\enddocument\sa@enddocument
@@ -432,6 +1271,8 @@
% \end{macro}
%
% \begin{macro}{\sa@enddocument}
+% This is the |\end{document}| of the sub files. It does nothing except of
+% calling our own |atenddocument| hook and then the `after end document' handler.
% \begin{macrocode}
\def\sa@enddocument{%
\sa@atenddocument
@@ -440,7 +1281,20 @@
% \end{macrocode}
% \end{macro}
%
+% \begin{macro}{\sa@@enddocument}
+% This is a `after end document' handler for the sub-files. It restores macros and
+% ends the input of the file.
+% \begin{macrocode}
+\def\sa@@enddocument{%
+ %\let\document\sa@orig@document
+ \let\enddocument\sa@orig@enddocument
+ \endinput
+}
+% \end{macrocode}
+% \end{macro}
+%
% \begin{macro}{\sa@atbegindocument}
+% This hook simply ignores all spaces after |\begin{document}| in the sub files.
% \begin{macrocode}
\def\sa@atbegindocument{%
\ignorespaces
@@ -449,6 +1303,7 @@
% \end{macro}
%
% \begin{macro}{\sa@atenddocument}
+% This hook simply ignores the last skip (normally the spaces) before |\end{document}| in the sub files.
% \begin{macrocode}
\def\sa@atenddocument{%
\unskip
@@ -456,127 +1311,109 @@
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{\sa@@enddocument}
+%
+% \iffalse
+%</sty>
+% \fi
+%
+% \subsection{The Class File}
+% \iffalse
+%<*cls>
+% \fi
+%
+% \subsubsection{If-Switches}
+%
+% \begin{macro}{\ifstandalone}
+% This if-switch is defined by both the class and package. This class sets
+% it to true while the package (loaded by the main document) sets it to false.
% \begin{macrocode}
-\def\sa@@enddocument{%
- %\let\document\sa@orig@document
- \let\enddocument\sa@orig@enddocument
- \endinput
-}
+\newif\ifstandalone
+\standalonetrue
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{\sa@processpreamble}
+% \begin{macro}{\ifstandalonebeamer}
+% This if-switch is defined by both the class and package. This class sets
+% it to true only if the |beamer| option was given. The package (loaded by the main document) sets it always to false.
% \begin{macrocode}
-\def\sa@processpreamble{%
- \renewcommand\usepackage[2][]{%
- \message{^^J%
- INFO: Sub-file requires the following package(s):^^J
- \space\space[##1]{##2}^^J%
- }%
- }%
- \let\RequirePackage\usepackage
-}
+\newif\ifstandalonebeamer
+\standalonebeamerfalse
% \end{macrocode}
% \end{macro}
%
+% \begin{macro}{\onlyifstandalone}
+% Macro version of |\ifstandalone|. The |{ }| around the argument protects the content from the package etc. scanners.
% \begin{macrocode}
-%%\def\sa@@documentclass{\sa@processpreamble}
+\let\onlyifstandalone\@firstofone
% \end{macrocode}
+% \end{macro}
%
-% \iffalse
-%</sty>
-% \fi
%
-% \subsection{The Class File}
-% \iffalse
-%<*cls>
-% \fi
+% \subsubsection{Options}
+%
% \begin{macrocode}
-\def\sa@classoptionslist{}
\RequirePackage{kvoptions}
\SetupKeyvalOptions{prefix=sa@}
-\DeclareBoolOption[true]{preview}
-% \end{macrocode}
-%
-% \begin{environment}{standalone}
-% The \env{standalone} environment is defined by default to be without effect.
-% The \cs{endstandalone} macro is set to |\relax|, so a redefinition with
-% \cs{renewenvironment} can be detected later.
-% \begin{macrocode}
-\let\standalone\empty
-\let\endstandalone\relax
% \end{macrocode}
-% \end{environment}
%
-% \begin{macro}{\sa@cls@document}
-% \begin{macro}{\sa@cls@enddocument}
+% Use of |preview| package is optional but enabled by default.
+% This defines the |\ifsa@preview| switch.
% \begin{macrocode}
-\def\sa@cls@document{\standalone}
-\def\sa@cls@enddocument{\endstandalone}
+\DeclareBoolOption[true]{preview}
% \end{macrocode}
-% \end{macro}
-% \end{macro}
%
-% The |beamer| option defines the \env{standalone} environment as a replacement
-% of \env{frame}.
+% Enable beamer support.
% \begin{macrocode}
-\newif\ifstandalonebeamer
\DeclareVoidOption{beamer}{%
\def\sa@class{beamer}%
\sa@previewfalse
\standalonebeamertrue
- \newenvironment{standaloneframe}{%
- \@ifnextchar<%
- {\@standaloneframe}%
- {\@@standaloneframe{}}%
- }{\end{frame}}%
- \def\@standaloneframe<##1>{%
- \@@standaloneframe{<##1>}%
- }
- \def\@@standaloneframe##1{%
- \@ifnextchar[%]
- {\@@@standaloneframe{##1}}%
- {\@@@standaloneframe{##1}[]}%
- }%
- \def\@@@standaloneframe##1[{%
- \@ifnextchar<%
- {\@@@@standaloneframe{##1}[}%
- {\@@@@@@standaloneframe{##1}[}%
- }%
- \def\@@@@standaloneframe##1[##2]{%
- \@ifnextchar[%]
- {\@@@@@standaloneframe{##1}{##2}}%
- {\begin{frame}##1[##2][environment=standaloneframe]}%
- }%
- \def\@@@@@standaloneframe##1##2[##3]{%
- \begin{frame}##1[##2][environment=standaloneframe,##3]%
- }%
- \def\@@@@@@standaloneframe##1[##2]{%
- \begin{frame}##1[environment=standaloneframe,##2]%
- }%
}
% \end{macrocode}
%
+% Option to set underlying class. Default is |article|.
% \begin{macrocode}
\DeclareStringOption[article]{class}
+% \end{macrocode}
+%
+% The rest of the options are accumulated and set as the official class options
+% for the real class loaded afterwards. This avoids the passing of any |standalone| class options
+% to the underlying class in any way. The |beamer| class for example has an option called
+% `|class|' in a similar way the |standalone| class does, which would cause problems if not filtered out.
+% \begin{macrocode}
+\def\sa@classoptionslist{}
\DeclareDefaultOption{%
\xdef\sa@classoptionslist{\sa@classoptionslist,\CurrentOption}%
}
\ProcessKeyvalOptions*\relax
+\let\@classoptionslist\sa@classoptionslist
% \end{macrocode}
%
+% Loads the class given by the |class| option with the rest of the options.
% \begin{macrocode}
-\let\@classoptionslist\sa@classoptionslist
+\begingroup
\xdef\@tempa{[\sa@classoptionslist]{\sa@class}}
+\expandafter
+\endgroup
\expandafter\LoadClass\@tempa
% \end{macrocode}
%
+% \begin{environment}{standalone}
+% The \env{standalone} environment is defined by default to be without effect.
+% The \cs{endstandalone} macro is set to |\relax|, so a redefinition with
+% \cs{renewenvironment} in the configuration file can be detected later.
+% \begin{macrocode}
+\let\standalone\empty
+\let\endstandalone\relax
+% \end{macrocode}
+% \end{environment}
+%
+% Loads configuration file.
% \begin{macrocode}
\input{standalone.cfg}
% \end{macrocode}
%
-% \subsubsection*{Preview Code}
+% \subsubsection{Preview Code}
% The \env{standalone} environment is redefined to use the |preview| environment as
% long it was not redefined in the configuration file.
% \begin{macrocode}
@@ -590,28 +1427,87 @@
\fi
% \end{macrocode}
%
+% \subsubsection{Beamer Frame Environment}
+%
% \begin{macrocode}
-\RequirePackage{standalone}[2010/03/21]
-\standalonetrue
+\ifstandalonebeamer
% \end{macrocode}
-%
-% \begin{macro}{\document}
+% \begin{environment}{standaloneframe}
+% Front-end for the beamer |frame| environment. Parses all arguments
+% the same way and calls it with an added option.
% \begin{macrocode}
-\def\document{%
- \sa@orig@document
- \let\documentclass\sa@documentclass
- \sa@cls@document
+\newenvironment{standaloneframe}{%
+ \@ifnextchar<%
+ {\@standaloneframe}%
+ {\@@standaloneframe{}}%
+}{\end{frame}}%
+\def\@standaloneframe<#1>{%
+ \@@standaloneframe{<#1>}%
}
+\def\@@standaloneframe#1{%
+ \@ifnextchar[%]
+ {\@@@standaloneframe{#1}}%
+ {\@@@standaloneframe{#1}[]}%
+}%
+\def\@@@standaloneframe#1[{%
+ \@ifnextchar<%
+ {\@@@@standaloneframe{#1}[}%
+ {\@@@@@@standaloneframe{#1}[}%
+}%
+\def\@@@@standaloneframe#1[#2]{%
+ \@ifnextchar[%]
+ {\@@@@@standaloneframe{#1}{#2}}%
+ {\begin{frame}#1[#2][environment=standaloneframe]}%
+}%
+\def\@@@@@standaloneframe#1#2[#3]{%
+ \begin{frame}#1[#2][environment=standaloneframe,#3]%
+}%
+\def\@@@@@@standaloneframe#1[#2]{%
+ \begin{frame}#1[environment=standaloneframe,#2]%
+}%
+% \end{macrocode}
+% \end{environment}
+% \begin{macrocode}
+\fi
% \end{macrocode}
+%
+% \subsubsection{Document Environment in Sub-Files}
+%
+% \begin{macro}{\sa@cls@orig@document}
+% \begin{macro}{\sa@cls@orig@enddocument}
+% Store original |document| environment.
+% \begin{macrocode}
+\let\sa@cls@orig@document\document
+\let\sa@cls@orig@enddocument\enddocument
+% \end{macrocode}
+% \end{macro}
% \end{macro}
%
-% \begin{macro}{\enddocument}
+% \begin{environment}{document}
+% Adds own `after begin document' and `before end document` hooks.
% \begin{macrocode}
+\def\document{%
+ \sa@cls@orig@document
+ \let\documentclass\sa@documentclass % TODO: really required?
+ \sa@cls@afterbegindocument
+}
\def\enddocument{%
- \sa@cls@enddocument
- \sa@orig@enddocument
+ \sa@cls@beforeenddocument
+ \sa@cls@orig@enddocument
}
% \end{macrocode}
+% \end{environment}
+%
+% \begin{macro}{\sa@cls@afterbegindocument}
+% \begin{macro}{\sa@cls@beforeenddocument}
+% Hooks which add the \env{standalone} environment. Surrounding spaces
+% are removed. This hooks are used (instead of calling the content directly in the above macros)
+% to add the possibility to fine tune this later, e.g.\ in the configuration file.
+% \begin{macrocode}
+\def\sa@cls@afterbegindocument{\expandafter\standalone\ignorespaces}
+\def\sa@cls@beforeenddocument{\unskip\endstandalone}
+% \end{macrocode}
+% \end{macro}
% \end{macro}
%
% \iffalse
@@ -622,30 +1518,30 @@
% \iffalse
%<*tex>
% \fi
+% \begin{macro}{\ifstandalone}
+% Provides \cs{ifstandalone} switch which is |\iftrue| if the normal |\documentclass|
+% was not yet executed (and subsequently redefined to be |\@twoclasseserror|).
% \begin{macrocode}
\expandafter\ifx\csname ifstandalone\endcsname\relax
-% \end{macrocode}
-% \begin{macrocode}
\expandafter\newif\csname ifstandalone\endcsname
-% \end{macrocode}
-% \begin{macrocode}
\expandafter\ifx\csname @twoclasseserror\endcsname\documentclass
\else
\standalonetrue
\fi
-% \end{macrocode}
-% \begin{macrocode}
\fi
% \end{macrocode}
+% \end{macro}
% \iffalse
%</tex>
% \fi
%
% \subsection{Config File}
-% Default content of the configuration file. Users can place there own
-% |standalone.cfg| in their |texmf| directory or in the local document directory
-% to define their own settings as described above. To load the default config file
-% from a user config file use |\input{standalone/standalone.cfg}|.
+% Default content of the configuration file. Users can override this by placing an own
+% |standalone.cfg| file somewhere where \TeX\ can find it (user |texmf| directory or local directory).
+% This user file can load the default config file using
+% using |\InputIfFileExists{standalone/standalone.cfg}{}{}|.
+% Be default only the |preview| package option are set and
+% the navigation symbols of beamer standalones are disabled.
% \iffalse
%<*cfg>
% \fi
@@ -653,7 +1549,7 @@
\PassOptionsToPackage{active,tightpage}{preview}%
\ifstandalonebeamer
- \setbeamertemplate{navigation symbols}{}
+ \setbeamertemplate{navigation symbols}{}%
\fi
% \end{macrocode}
% \iffalse