%% %% This is file `scrwfile.tex', %% generated with the docstrip utility. %% %% The original source files were: %% %% scrwfile.dtx (with options: `doc') %% %% Copyright (c) 2010-2012 by Markus Kohm %% %% This file was generated from file(s) of the KOMA-Script bundle. %% --------------------------------------------------------------- %% %% This work may be distributed and/or modified under the conditions of %% the LaTeX Project Public License, version 1.3c of the license. %% The latest version of this license is in %% http://www.latex-project.org/lppl.txt %% and version 1.3c or later is part of all distributions of LaTeX %% version 2005/12/01 or later and of this work. %% %% This work has the LPPL maintenance status "author-maintained". %% %% The Current Maintainer and author of this work is Markus Kohm. %% %% This file may only be distributed together with the file %% `scrwfile.dtx' and `scrlogo.dtx'. You may however distribute the files %% `scrwfile.dtx' and `scrlogo.dtx' without this file. %% %% If this file is a beta version, you are not allowed to distribute it. %% %% English and German manuals are part of KOMA-Script bundle. %% ---------------------------------------------------------- %% %% The english manual is at `scrwfile.dtx', too. %% %% The KOMA-Script bundle (but not this file) was based upon the LaTeX2.09 %% Script family created by Frank Neukam 1993 and the LaTeX2e standard %% classes created by The LaTeX3 Project 1994-1996. %% %% THIS IS AN ALPHA VERSION! %% USAGE OF THIS VERSION IS ON YOUR OWN RISK! %% EVERYTHING MAY HAPPEN! %% EVERYTHING MAY CHANGE IN FUTURE! %% THERE IS NO SUPPORT, IF YOU USE THIS PACKAGE! %% %%% From File: scrwfile.dtx \ProvidesFile{scrwfile.tex} [2012/03/05 v0.1d-alpha LaTeX2e KOMA-Script package (write and clone files)] \chapter[{Spare and Replace Files Using \Package{scrwfile}}] {Spare and Replace Files Using \Package{scrwfile}% } \labelbase{scrwfile} \BeginIndex{Package}{scrwfile} \TeX{} supports 18 write handles only. Handle 0 is used by \TeX{} itself (log file). \LaTeX{} needs at least handle 1 for \Macro{@mainaux}, handle 2 for \Macro{@partaux}, one handle for \Macro{tableofcontents}, one handle for \Macro{listoffigures}, one handle for \Macro{listoftables}, one handle for \Macro{makeindex}. So there are 11 left. Seams a lot and enough. But every new type of float, every new index and several other packages, e.g., \Package{hyperref} need write handles, too. The bottom line is, that this eventually will result in the error message: \begin{lstcode} ! No room for a new \write . \ch@ck ...\else \errmessage {No room for a new #3} \fi \end{lstcode} Last but not least, immediately opening one more write handle for every table of contents, list of figures, list of tables, and so on has one more disadvantage. These are not only set by the corresponding commands, they also couldn't not be set once more, because their helper files are empty after the corresponding commands until the end of the document. Package \Package{scrwfile} provides a general change of the \LaTeX{} kernel, that may solve both problems. \section{General Modifications of the \LaTeX{} Kernel} \label{sec:scrwfile.kernelpatches} \LaTeX{} classes use the \LaTeX{} kernel command \Macro{@starttoc}\IndexCmd{@starttoc} for output and opening of a new table of contents, list of float, e.\,g., \Macro{listoffigures} or \Macro{listoftables}, or similar. Thereby \LaTeX{} not only reads the helper file with the contents of the directory, but opens the helper file for writing also. Nevertheless, if afterwards new entries to these lists of floats will be made using \Macro{addcontentsline}, then this will not write immediately to the helper file. Instead of \LaTeX{} writes \Macro{@writefile}\IndexCmd{@writefile} commands into the \File{aux}-file. Only while reading the \File{aux}-file while the end of the document, those \Macro{@writefile} commands generates real write operations into the helper files. \LaTeX{} even doesn't close the helper files explicitly. Instead of \LaTeX{} counts on \TeX{} to close all open files at the end. This procedure means, that all the helper files are open for writing from the output of the contents, i.\,e. at the front matter of the document until the end of the document, though their content is written after the end of the document. \Package{scrwfile}'s basic approach is exactly this: redefinition of \Macro{@starttoc} and \Macro{@writefile}. Surely\textnote{Attention!}, changes of the \LaTeX{} kernel always may potentially result in incompatibilities with other packages. In case of \Package{scrwfile} this may be happen with all packages, that redefine \Macro{@starttoc} or \Macro{@writefile} too. Sometimes changing the order of loading the packages may help. In fact, such problems with \Package{scrwfile} haven't been reported currently, though several users have tested the package for more than a year until first release. Nevertheless, if you find such a problem, please contact the \KOMAScript{} author. \section{The Single File Feature} \label{sec:scrwfile.singlefilefeature} Just while loading the package using, e.\,g., \begin{lstcode}[belowskip=\dp\strutbox] \usepackage{scrwfile} \end{lstcode} \Package{scrwfile} will redefine \Macro{@starttoc}\IndexCmd{@starttoc} to not longer allocate a file handle or open any file for writing. Immediately before closing the \File{aux}-file in \Macro{end}\PParameter{document} it will redefine \Macro{@writefile} to not longer write into the usual helper files but into one single new file with file extension \File{wrt}. After reading the \File{aux}-file this \File{wrt}-file will be processed once per helper file. This means, that not all of the helper file have to be open at the same time, but only one at a time. And this single file will be closed afterwards and the write handle is not longer needed after it is closed. An internal write handle of \LaTeX{} is used for this. So \Package{scrwfile} doesn't need any own write handle. Because of this, even if only one table of contents should be generated, after loading \Package{scrwfile} one more write file handle will be available, e.\,g., for bibliographies, indexes, glossaries and similar, that are not using \Macro{@starttoc}. Additionally the number of tables of contents and lists of whatever, that use \Macro{@starttoc}\IndexCmd{@starttoc} won't be limited any longer. \section{The Clone File Write Feature} \label{sec:scrwfile.clonefilefeature} Sometimes it is useful to input a file not only once but several times. As \Macro{@starttoc} does not open files for writing any longer, this may be done by simply using \Macro{\@starttoc} several times with the same extension. But sometimes you may have additional entries in only some of the content directories. Because of this, \Package{scrwfile} allows to copy all entries of a file to another file, too. We call this cloning. \begin{Declaration} \Macro{TOCclone}% \OParameter{heading}\Parameter{source}\Parameter{destination} \end{Declaration} \BeginIndex{Cmd}{TOCclone}% activates the clone feature for files with extensions \PName{source} and \PName{destination}. All entries to the file \Macro{jobname}\File{.}\PName{source} will be added to \Macro{jobname}\File{.}\PName{destination}, too. If extension \PName{destination} is a new one, \PName{destination} will be added to the list of known extensions using the \KOMAScript{} package \Package{tocbasic}. If the optional argument \PName{heading} is given, a new list-of macro \Macro{listof}\PName{destination} is defined. \PName{heading} will be used as section (or chapter) heading of this list. In this case several \Package{tocbasic} features of the \PName{source} will be copied to \PName{destination}, if and only if they have been set up when \Macro{TOCclone} was used. Feature \PName{nobabel} will always be set, because the language selection commands are part of the helper file and would be cloned, too. \begin{Example} Assumed, you want a short table of contents with only the chapter level but an additional entry with the table of contents: \begin{lstcode} \usepackage{scrwfile} \TOCclone[Short \contentsname]{toc}{stoc} \AtBeginDocument{% % aux first opened at \begin{document}. So wait until this: \addtocontents{toc}{% first toc entry: \proctect\addcontentsline{stoc}{% write to Short Contents \protect\tableofcontents% Contents }% }% } \begin{document} \setcounter{tocdepth}{1}% show chapters only \listofstoc% Write short table of contents \setcounter{tocdepth}{6}% show all levels \tableofcontents% Write table of contents \end{lstcode} You need at least three \LaTeX{} runs to get a short table of contents and a detailed table of contents. The detailed one produces an entry at the short one but this entry will not be part of the detailed table of contents. \end{Example} \EndIndex{Cmd}{TOCclone} \section{State of Development Note} \label{sec:scrwfile.draft} Though this package has been tested by several users and even is in productivity usage several times, development is not finished yet. Because of this especially internal functionality may be changed in future. Most likely the package will be extended. Some code for extensions is already in the package. Nevertheless, currently user haven't make requests for such extension. So there's currently no user documentation for this. \EndIndex{Package}{scrwfile} \endinput %% %% End of file `scrwfile.tex'.