diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/oberdiek/hypbmsec.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/oberdiek/hypbmsec.dtx | 382 |
1 files changed, 296 insertions, 86 deletions
diff --git a/Master/texmf-dist/source/latex/oberdiek/hypbmsec.dtx b/Master/texmf-dist/source/latex/oberdiek/hypbmsec.dtx index 8c65281e06c..a0d60c5bb66 100644 --- a/Master/texmf-dist/source/latex/oberdiek/hypbmsec.dtx +++ b/Master/texmf-dist/source/latex/oberdiek/hypbmsec.dtx @@ -1,81 +1,181 @@ % \iffalse meta-comment % -% hypbmsec.dtx -% -% This file is part of the package `hypbmsec' for use with LaTeX2e. -% -% Function: Bookmarks in sectioning commands. -% -% Copyright (C) 1998,1999,2000 Heiko Oberdiek. -% -% This program may be distributed and/or modified under the -% conditions of the LaTeX Project Public License, either version 1.2 -% of this license or (at your option) any later version. -% The latest version of this license is in -% http://www.latex-project.org/lppl.txt -% and version 1.2 or later is part of all distributions of LaTeX -% version 1999/12/01 or later. -% -% Please send error reports and suggestions for improvements to -% Heiko Oberdiek <oberdiek@ruf.uni-freiburg.de>. -% -%<*dtx> - \ProvidesFile{hypbmsec.dtx} -%</dtx> -%<package>\NeedsTeXFormat{LaTeX2e} -%<package>\ProvidesPackage{hypbmsec} -%<driver>\ProvidesFile{hypbmsec.drv} -% \fi -% \ProvidesFile{hypbmsec.dtx} - [2000/03/22 v2.1 Bookmarks in sectioning commands (HO).] -% -% \GetFileInfo{hypbmsec.dtx} -% -% \CheckSum{159} -% -%% \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 -%% Lower-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 -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} -%% -% \iffalse +% Copyright (C) 1998-2000, 2006 by +% Heiko Oberdiek <oberdiek@uni-freiburg.de> +% +% This work may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either +% version 1.3 of this license or (at your option) any later +% version. The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3 or later is part of all distributions of +% LaTeX version 2005/12/01 or later. +% +% This work has the LPPL maintenance status "maintained". +% +% This Current Maintainer of this work is Heiko Oberdiek. +% +% This work consists of the main source file hypbmsec.dtx +% and the derived files +% hypbmsec.sty, hypbmsec.pdf, hypbmsec.ins, hypbmsec.drv. +% +% Distribution: +% CTAN:macros/latex/contrib/oberdiek/hypbmsec.dtx +% CTAN:macros/latex/contrib/oberdiek/hypbmsec.pdf +% +% Unpacking: +% (a) If hypbmsec.ins is present: +% tex hypbmsec.ins +% (b) Without hypbmsec.ins: +% tex hypbmsec.dtx +% (c) If you insist on using LaTeX +% latex \let\install=y\input{hypbmsec.dtx} +% (quote the arguments according to the demands of your shell) +% +% Documentation: +% (a) If hypbmsec.drv is present: +% latex hypbmsec.drv +% (b) Without hypbmsec.drv: +% latex hypbmsec.dtx; ... +% The class ltxdoc loads the configuration file ltxdoc.cfg +% if available. Here you can specify further options, e.g. +% use A4 as paper format: +% \PassOptionsToClass{a4paper}{article} +% +% Programm calls to get the documentation (example): +% pdflatex hypbmsec.dtx +% makeindex -s gind.ist hypbmsec.idx +% pdflatex hypbmsec.dtx +% makeindex -s gind.ist hypbmsec.idx +% pdflatex hypbmsec.dtx +% +% Installation: +% TDS:tex/latex/oberdiek/hypbmsec.sty +% TDS:doc/latex/oberdiek/hypbmsec.pdf +% TDS:source/latex/oberdiek/hypbmsec.dtx +% +%<*ignore> +\begingroup + \def\x{LaTeX2e} +\expandafter\endgroup +\ifcase 0\ifx\install y1\fi\expandafter + \ifx\csname processbatchFile\endcsname\relax\else1\fi + \ifx\fmtname\x\else 1\fi\relax +\else\csname fi\endcsname +%</ignore> +%<*install> +\input docstrip.tex +\Msg{************************************************************************} +\Msg{* Installation} +\Msg{* Package: hypbmsec 2006/02/20 v2.2 Bookmarks in sectioning commands (HO)} +\Msg{************************************************************************} + +\keepsilent +\askforoverwritefalse + +\preamble + +This is a generated file. + +Copyright (C) 1998-2000, 2006 by + Heiko Oberdiek <oberdiek@uni-freiburg.de> + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either +version 1.3 of this license or (at your option) any later +version. The latest version of this license is in + http://www.latex-project.org/lppl.txt +and version 1.3 or later is part of all distributions of +LaTeX version 2005/12/01 or later. + +This work has the LPPL maintenance status "maintained". + +This Current Maintainer of this work is Heiko Oberdiek. + +This work consists of the main source file hypbmsec.dtx +and the derived files + hypbmsec.sty, hypbmsec.pdf, hypbmsec.ins, hypbmsec.drv. + +\endpreamble + +\generate{% + \file{hypbmsec.ins}{\from{hypbmsec.dtx}{install}}% + \file{hypbmsec.drv}{\from{hypbmsec.dtx}{driver}}% + \usedir{tex/latex/oberdiek}% + \file{hypbmsec.sty}{\from{hypbmsec.dtx}{package}}% +} + +\obeyspaces +\Msg{************************************************************************} +\Msg{*} +\Msg{* To finish the installation you have to move the following} +\Msg{* file into a directory searched by TeX:} +\Msg{*} +\Msg{* hypbmsec.sty} +\Msg{*} +\Msg{* To produce the documentation run the file `hypbmsec.drv'} +\Msg{* through LaTeX.} +\Msg{*} +\Msg{* Happy TeXing!} +\Msg{*} +\Msg{************************************************************************} + +\endbatchfile +%</install> +%<*ignore> +\fi +%</ignore> %<*driver> +\NeedsTeXFormat{LaTeX2e} +\ProvidesFile{hypbmsec.drv}% + [2006/02/20 v2.2 Bookmarks in sectioning commands (HO)] \documentclass{ltxdoc} \usepackage{holtxdoc} \begin{document} - \DocInput{hypbmsec.dtx} + \DocInput{hypbmsec.dtx} \end{document} %</driver> % \fi % -% \DoNotIndex{\csname,\endcsname,\expandafter,\noexpand,\string} -% \DoNotIndex{\begingroup,\endgroup,\def,\xdef,\long,\let} -% \DoNotIndex{\ifx,\newcommand,\renewcommand} -% -% \newcommand{\type}[1]{\textsf{#1}} +% \CheckSum{161} +% +% \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 +% Lower-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 +% Digits \0\1\2\3\4\5\6\7\8\9 +% Exclamation \! Double quote \" Hash (number) \# +% Dollar \$ Percent \% Ampersand \& +% Acute accent \' Left paren \( Right paren \) +% Asterisk \* Plus \+ Comma \, +% Minus \- Point \. Solidus \/ +% Colon \: Semicolon \; Less than \< +% Equals \= Greater than \> Question mark \? +% Commercial at \@ Left bracket \[ Backslash \\ +% Right bracket \] Circumflex \^ Underscore \_ +% Grave accent \` Left brace \{ Vertical bar \| +% Right brace \} Tilde \~} +% +% \GetFileInfo{hypbmsec.drv} +% +% \title{The \xpackage{hypbmsec} package} +% \date{2006/02/20 v2.2} +% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}} % -% \SetupTitle{hyperref,section,bookmark,pdf,LaTeX} % \maketitle % % \begin{abstract} -% This package expands the syntax of the sectioning commands. If the -% argument of the sectioning commands isn't usable as outline entry, -% a replacement for the bookmarks can be given. +% This package expands the syntax of the sectioning commands. If the +% argument of the sectioning commands isn't usable as outline entry, +% a replacement for the bookmarks can be given. % \end{abstract} % % \tableofcontents % +% \newcommand{\type}[1]{\textsf{#1}} +% +% ^^A No thread support. +% \newenvironment{article}[1]{}{} +% % \section{Usage} % % \subsection{Bookmarks restrictions}\label{sec:restrictions} @@ -252,14 +352,19 @@ % |\section(outlines(bookmarks{)}){text, toc}| % \end{quote} % -% \Installation -% -% \StopEventually{} +% \StopEventually{ +% } % % \section{Implementation} % \begin{macrocode} %<*package> % \end{macrocode} +% Package identification. +% \begin{macrocode} +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{hypbmsec}% + [2006/02/20 v2.2 Bookmarks in sectioning commands (HO)] +% \end{macrocode} % % Because of redifining the sectioning commands, it is dangerous % to reload the package several times. @@ -451,30 +556,135 @@ % \begin{macrocode} %</package> % \end{macrocode} +% \section{Installation} +% +% \paragraph{CTAN.} This package is available on +% CTAN\footnote{\url{ftp://ftp.ctan.org/tex-archive/}}: +% \begin{description} +% \item[\CTAN{macros/latex/contrib/oberdiek/hypbmsec.dtx}] The source file. +% \item[\CTAN{macros/latex/contrib/oberdiek/hypbmsec.pdf}] Documentation. +% \end{description} +% +% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting +% \docstrip\ archive. The files are extracted by running the +% \xfile{.dtx} through \plainTeX: +% \begin{quote} +% \verb|tex hypbmsec.dtx| +% \end{quote} +% +% \paragraph{TDS.} Now the different files must be moved into +% the different directories in your installation TDS tree +% (also known as \xfile{texmf} tree): +% \begin{quote} +% \sbox0{^^A +% \begin{tabular}{@{}>{\ttfamily}l@{$\quad\rightarrow\quad$}>{\ttfamily}l@{}} +% hypbmsec.sty & tex/latex/oberdiek/hypbmsec.sty\\ +% hypbmsec.pdf & doc/latex/oberdiek/hypbmsec.pdf\\ +% hypbmsec.dtx & source/latex/oberdiek/hypbmsec.dtx\\ +% \end{tabular}^^A +% }% +% \ifdim\wd0>\linewidth +% \mbox{}\nobreak\hskip0pt minus\leftmargin +% \usebox0 +% \nobreak\hskip0pt minus\rightmargin +% \else +% \usebox0 +% \fi +% \end{quote} +% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip's +% TDS installing feature, then some files can already be in the right +% place, see the documentation of \docstrip. +% +% \paragraph{Refresh file databases.} If your \TeX~distribution +% (\teTeX, \mikTeX, \dots) rely on file databases, you must refresh +% these. For example, \teTeX\ users run \verb|texhash| or +% \verb|mktexlsr|. +% +% \subsection{Some details for the interested} +% +% \paragraph{Attached source.} +% +% The PDF documentation on CTAN also includes the +% \xfile{.dtx} source file. It can be extracted by +% AcrobatReader 6 or higher. Another option is \textsf{pdftk}, +% e.g. unpack the file into the current directory: +% \begin{quote} +% \verb|pdftk hypbmsec.pdf unpack_files output .| +% \end{quote} +% +% \paragraph{Unpacking with \LaTeX.} +% The \xfile{.dtx} chooses its action depending on the format: +% \begin{description} +% \item[\plainTeX:] Run \docstrip\ and extract the files. +% \item[\LaTeX:] Generate the documentation. +% \end{description} +% If you insist on using \LaTeX\ for \docstrip\ (really, +% \docstrip\ does not need \LaTeX), then inform the autodetect routine +% about your intension: +% \begin{quote} +% \verb|latex \install=y\input{hypbmsec.dtx}| +% \end{quote} +% Do not forget to quote the argument according to the demands +% of your shell. +% +% \paragraph{Generating the documentation.} +% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate +% the documentation. The process can be configured by the +% configuration file \xfile{ltxdoc.cfg}. For instance, put this +% line into this file, if you want to have A4 as paper format: +% \begin{quote} +% \verb|\PassOptionsToClass{a4paper}{article}| +% \end{quote} +% An example follows how to generate the +% documentation with pdf\LaTeX: +% \begin{quote} +%\begin{verbatim} +%pdflatex hypbmsec.dtx +%makeindex -s gind.ist hypbmsec.idx +%pdflatex hypbmsec.dtx +%makeindex -s gind.ist hypbmsec.idx +%pdflatex hypbmsec.dtx +%\end{verbatim} +% \end{quote} +% +% \begin{History} +% \begin{Version}{1998/11/20 v1.0} +% \item +% First version. +% \item +% It merges package \xpackage{hysecopt} and +% \item +% package \xpackage{hypbmpar}. +% \item +% Published for the DANTE'99 meating^^A +% \URL{}{http://dante99.cs.uni-dortmund.de/handouts/oberdiek/hypbmsec.sty}. +% \end{Version} +% \begin{Version}{1999/04/12 v2.0} +% \item +% Adaptation to \Package{hyperref} version 6.54. +% \item +% Documentation in dtx format. +% \item +% Copyright: LPPL (\CTAN{macros/latex/base/lppl.txt}) +% \item +% First CTAN release. +% \end{Version} +% \begin{Version}{2000/03/22 v2.1} +% \item +% Bug fix in redefinition of \cmd{\chapter}. +% \item +% Copyright: LPPL 1.2 +% \end{Version} +% \begin{Version}{2006/02/20 v2.2} +% \item +% Code is not changed. +% \item +% New DTX framework. +% \item +% LPPL 1.3 +% \end{Version} +% \end{History} % -% \StartHistory -% \HistVersion{1998/11/20 v1.0} -% \begin{itemize} -% \item First version. -% \item It merges package \Package{hysecopt} and -% package \Package{hypbmpar}. -% \item Published for the DANTE'99 meating^^A -%\URL{}{http://dante99.cs.uni-dortmund.de/handouts/oberdiek/hypbmsec.sty}. -% \end{itemize} -% \HistVersion{1999/04/12 v2.0} -% \begin{itemize} -% \item Adaptation to \Package{hyperref} version 6.54. -% \item Documentation in dtx format. -% \item Copyright: LPPL (\CTAN{macros/latex/base/lppl.txt}) -% \item First CTAN release. -% \end{itemize} -% \HistVersion{2000/03/22 v2.1} -% \begin{itemize} -% \item Bug fix in redefinition of \cmd{\chapter}. -% \item Copyright: LPPL 1.2 -% \end{itemize} -% -% \hfuzz10pt % \PrintIndex % % \Finale |