summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/oberdiek/hypbmsec.dtx
blob: dd26b08d2b51b64d12122dc608f83d94ff4d129a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
% \iffalse meta-comment
%
% File: hypbmsec.dtx
% Version: 2016/05/16 v2.5
% Info: Bookmarks in sectioning commands
%
% Copyright (C)
%    1998-2000, 2006, 2007 Heiko Oberdiek
%    2016-2019 Oberdiek Package Support Group
%    https://github.com/ho-tex/oberdiek/issues
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3c of this license or (at your option) any later
% version. This version of this license is in
%    https://www.latex-project.org/lppl/lppl-1-3c.txt
% and the latest version of this license is in
%    https://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".
%
% The Current Maintainers of this work are
% Heiko Oberdiek and the Oberdiek Package Support Group
% https://github.com/ho-tex/oberdiek/issues
%
% 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
  \catcode123=1 %
  \catcode125=2 %
  \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 2016/05/16 v2.5 Bookmarks in sectioning commands (HO)}
\Msg{************************************************************************}

\keepsilent
\askforoverwritefalse

\let\MetaPrefix\relax
\preamble

This is a generated file.

Project: hypbmsec
Version: 2016/05/16 v2.5

Copyright (C)
   1998-2000, 2006, 2007 Heiko Oberdiek
   2016-2019 Oberdiek Package Support Group

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3c of this license or (at your option) any later
version. This version of this license is in
   https://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
   https://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".

The Current Maintainers of this work are
Heiko Oberdiek and the Oberdiek Package Support Group
https://github.com/ho-tex/oberdiek/issues


This work consists of the main source file hypbmsec.dtx
and the derived files
   hypbmsec.sty, hypbmsec.pdf, hypbmsec.ins, hypbmsec.drv.

\endpreamble
\let\MetaPrefix\DoubleperCent

\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}}%
}

\catcode32=13\relax% active space
\let =\space%
\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}%
  [2016/05/16 v2.5 Bookmarks in sectioning commands (HO)]%
\documentclass{ltxdoc}
\usepackage{holtxdoc}[2011/11/22]
\begin{document}
  \DocInput{hypbmsec.dtx}%
\end{document}
%</driver>
% \fi
%
%
%
% \GetFileInfo{hypbmsec.drv}
%
% \title{The \xpackage{hypbmsec} package}
% \date{2016/05/16 v2.5}
% \author{Heiko Oberdiek\thanks
% {Please report any issues at \url{https://github.com/ho-tex/oberdiek/issues}}}
%
% \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.
% \end{abstract}
%
% \tableofcontents
%
% \newcommand{\type}[1]{\textsf{#1}}
%
% ^^A No thread support.
% \newenvironment{article}[1]{}{}
%
% \section{Usage}
%
% \subsection{Bookmarks restrictions}\label{sec:restrictions}
%    Outline entries (bookmarks) are written to a file and have
%    to obey the pdf specification.
%    Therefore they have several restrictions:
%    \begin{itemize}
%    \item Bookmarks have to be encoded in PDFDocEncoding^^A
%          \footnote{\Package{hyperref} doesn't support
%            Unicode.}.
%    \item They should only expand to letters and spaces.
%    \item The result of expansion have to be a valid pdf string.
%    \item Stomach commands like \cmd{\relax}, box commands, math,
%          assignments, or definitions aren't allowed.
%    \item Short entries are recommended, which allow a clear view.
%    \end{itemize}
%
% \subsection{\texorpdfstring{\cmd{\texorpdfstring}}{^^A
%    \textbackslash texorpdfstring}}
%    The generic way in package \Package{hyperref} is the use
%    of \cmd{\texorpdfstring}^^A
%    \footnote{In versions of \Package{hyperref} below 6.54 see
%      \cmd{\ifbookmark}.}:
%    \begin{quote}
%\begin{verbatim}
%\section{Pythagoras:
%  \texorpdfstring{$a^2+b^2=c^2}{%
%    a\texttwosuperior\ + b\texttwosuperior\ =
%    c\texttwosuperior}%
%}
%\end{verbatim}
%    \end{quote}
%
% \subsection{Sectioning commands}
%    The package \Package{hyperref} automatically generates
%    bookmarks from the sectioning commands,
%    unless it is suppressed by an option.
%    Commands that structure the text are here called
%    ``sectioning commands'':
%    \begin{quote}
%    \cmd{\part}, \cmd{\chapter},\\
%    \cmd{\section}, \cmd{\subsection}, \cmd{\subsubsection},\\
%    \cmd{\paragraph}, \cmd{\subparagraph}
%    \end{quote}
%
% \subsection{Places\texorpdfstring{ for sectioning strings}{}}
%    \label{sec:places}
%    The argument(s) of these commands are used on several places:
%    \begin{description}
%    \item[\type{text}]
%      The current text without restrictions.
%    \item[\type{toc}]
%      The headlines and the table of contents with the
%      restrictions of ``moving arguments''.
%    \item[\type{out}]
%      The outlines with many restrictions: The outline
%      have to expand to a valid pdf string with PDFDocEncoding
%      (see \ref{sec:restrictions}).
%    \end{description}
%
% \subsection{\texorpdfstring{Solution with o}{O}ptional arguments}
%    If the user wants to use a footnote within a sectioning command,
%    the \LaTeX{} solution is an optional argument:
%    \begin{quote}
%      |\section[Title]{Title\footnote{Footnote text}}|
%    \end{quote}
%    Now |Title| without the footnote is used in the headlines and
%    the table of contents. Also \Package{hyperref} uses it for the
%    bookmarks.
%
%    This package \Package{\filename} offers two possibilities to
%    specify a separate outline entry:
%    \begin{itemize}
%    \item An additional second optional argument in square brackets.
%    \item An additional optional argument in parentheses (in
%          assoziation with a pdf string that is internally surrounded
%          by parentheses, too).
%    \end{itemize}
%    Because \Package{\filename} stores the original meaning of the
%    sectioning commands and uses them again, there should be no
%    problems with packages that redefine the sectioning commands, if
%    these packages doesn't change the syntax.
%
% \subsection{Syntax}
%    The following examples show the syntax of the sectioning
%    commands. For the places the strings appear the abbreviations
%    are used, that are introduced in \ref{sec:places}.
%
% \subsubsection{\texorpdfstring{Star form}{^^A
%    \textbackslash section*\{\}}}
%    The behaviour of the star form isn't changed. The string
%    appears only in the current text:
%    \begin{article}{Syntax}
%    \begin{quote}
%      |\section*{text}|
%    \end{quote}
%    \end{article}
%
% \subsubsection{\texorpdfstring{Without optional arguments}{^^A
%    \textbackslash section\{\}}}
%    The normal case, the string in the mandatory argument is
%    used for all places:
%    \begin{article}{Syntax}
%    \begin{quote}
%      |\section{text, toc, out}|
%    \end{quote}
%    \end{article}
%
% \subsubsection{\texorpdfstring{One optional argument}{^^A
%    \textbackslash section[]\{\}}}
%    Also the form with one optional parameter in square brackets isn't
%    new; for the bookmarks the optional parameter is used:
%    \begin{article}{Syntax}
%    \begin{quote}
%      |\section[toc, out]{text}|
%    \end{quote}
%    \end{article}
%
% \subsubsection{\texorpdfstring{Two optional arguments}{^^A
%    \textbackslash section[][out]\{\}}}\label{sec:two}
%    The second optional parameter in square brackets is introduced
%    by this package to specify an outline entry:
%    \begin{article}{Syntax}
%    \begin{quote}
%      |\section[toc][out]{text}|
%    \end{quote}
%    \end{article}
%
% \subsubsection{\texorpdfstring{Optional argument in parentheses}{^^A
%    \textbackslash section(out)\{\}}}
%    Often the \type{toc} and the \type{text} string would be the same.
%    With the method of the two optional arguments in square brackets
%    (see \ref{sec:two}) this string must be given twice,
%    if the user only wants to specify a different outline entry.
%    Therefore this package offers another possibility:
%    In association with the internal representation in the pdf file
%    an outline entry can be given in parentheses.
%    So the package can easily distinguish between
%    the two forms of optional arguments and the order does not matter:
%    \begin{article}{Syntax}
%    \begin{quote}
%      |\section(out){toc, text}|\\
%      |\section[toc](out){text}|\\
%      |\section(out)[toc]{text}|
%    \end{quote}
%    \end{article}
%
% \subsection{Without \Package{hyperref}}
%    Package \Package{\filename} uses \Package{hyperref} for support of
%    the bookmarks, but this package is not required.
%    If \Package{hyperref} isn't loaded, or
%    is called with a driver that doesn't support bookmarks,
%    package \Package{\filename} shouldn't be removed,
%    because this would lead to
%    a wrong syntax of the sectioning commands.
%    In any cases package \Package{\filename}
%    supports its syntax and ignores the outline entries,
%    if there are no code for bookmarks.
%    So it is possible to write texts,
%    that are processed with several drivers to get different output
%    formats.
%
% \subsection{Protecting parentheses}
%    If the string itself contains parentheses, they have to be hidden
%    from \TeX's argument parsing mechanism.
%    The argument should be surrounded
%    by curly braces:
%    \begin{quote}
%      |\section({outlines(bookmarks)}){text, toc}|
%    \end{quote}
%    With version 6.54 of \Package{hyperref} the other standard method
%    works, too: The closing parenthesis is protected:
%    \begin{quote}
%      |\section(outlines(bookmarks{)}){text, toc}|
%    \end{quote}
%
% \StopEventually{
% }
%
% \section{Implementation}
%    \begin{macrocode}
%<*package>
%    \end{macrocode}
%    Package identification.
%    \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{hypbmsec}%
  [2016/05/16 v2.5 Bookmarks in sectioning commands (HO)]
%    \end{macrocode}
%
%    Because of redifining the sectioning commands, it is dangerous
%    to reload the package several times.
%    \begin{macrocode}
\@ifundefined{hbs@do}{}{%
  \PackageInfo{hypbmsec}{Package 'hypbmsec' is already loaded}%
  \endinput
}
%    \end{macrocode}
%
%    \begin{macro}{\hbs@do}
%    The redefined sectioning commands calls \cmd{\hbs@do}. It does
%    \begin{itemize}
%    \item handle the star case.
%    \item resets the macros that store the entries for the outlines
%          (\cmd{\hbs@bmstring}) and table of contents (\cmd{\hbs@tocstring}).
%    \item store the sectioning command |#1| in \cmd{\hbs@seccmd}
%          for later reuse.
%    \item at last call \cmd{\hbs@checkarg} that scans and interprets the
%          parameters of the redefined sectioning command.
%    \end{itemize}
%    \begin{macrocode}
\def\hbs@do#1{%
  \@ifstar{#1*}{%
    \let\hbs@tocstring\relax
    \let\hbs@bmstring\relax
    \let\hbs@seccmd#1%
    \hbs@checkarg
  }%
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\hbs@checkarg}
%    \cmd{\hbs@checkarg} determines the type of the next argument:
%    \begin{itemize}
%    \item An optional argument in square brackets can be an entry
%          for the table of contents or the bookmarks. It will be
%          read by \cmd{\hbs@getsquare}
%    \item An optional argument in parentheses is an outline entry.
%          This is worked off by \cmd{\hbs@getbookmark}.
%    \item If there are no more optional arguments, \cmd{\hbs@process}
%          reads the mandatory argument and calls the original
%          sectioning commands.
%    \end{itemize}
%    \begin{macrocode}
\def\hbs@checkarg{%
  \@ifnextchar[\hbs@getsquare{%
    \@ifnextchar(\hbs@getbookmark\hbs@process
  }%
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\hbs@getsquare}
%    \cmd{\hbs@getsquare} reads an optional argument in square
%    brackets and determines, if this is an entry for the table
%    of contents or the bookmarks.
%    \begin{macrocode}
\long\def\hbs@getsquare[#1]{%
  \ifx\hbs@tocstring\relax
    \def\hbs@tocstring{#1}%
  \else
    \hbs@bmdef{#1}%
  \fi
  \hbs@checkarg
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\hbs@getbookmark}
%    \cmd{\hbs@getbookmark} reads an outline entry in parentheses.
%    \begin{macrocode}
\def\hbs@getbookmark(#1){%
  \hbs@bmdef{#1}%
  \hbs@checkarg
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\hbs@bmdef}
%    The command \cmd{\hbs@bmdef} save the bookmark entry in
%    parameter |#1| in the macro \cmd{\hbs@bmstring} and catches
%    the case, if the user has given several outline strings.
%    \begin{macrocode}
\def\hbs@bmdef#1{%
  \ifx\hbs@bmstring\relax
    \def\hbs@bmstring{#1}%
  \else
    \PackageError{hypbmsec}{%
      Sectioning command with too many parameters%
    }{%
      You can only give one outline entry.%
    }%
  \fi
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\hbs@process}
%    The parameter |#1| is the mandatory argument of the sectioning
%    commands. \cmd{\hbs@process} calls the original sectioning command
%    stored in \cmd{\hbs@seccmd} with arguments that depend of which
%    optional argument are used previously.
%    \begin{macrocode}
\long\def\hbs@process#1{%
  \ifx\hbs@tocstring\relax
    \ifx\hbs@bmstring\relax
      \hbs@seccmd{#1}%
    \else
      \begingroup
        \def\x##1{\endgroup
          \hbs@seccmd{\texorpdfstring{#1}{##1}}%
        }%
      \expandafter\x\expandafter{\hbs@bmstring}%
    \fi
  \else
    \ifx\hbs@bmstring\relax
      \expandafter\hbs@seccmd\expandafter[%
        \expandafter{\hbs@tocstring}%
      ]{#1}%
    \else
      \expandafter\expandafter\expandafter
      \hbs@seccmd\expandafter\expandafter\expandafter[%
        \expandafter\expandafter\expandafter
        \texorpdfstring
        \expandafter\expandafter\expandafter{%
          \expandafter\hbs@tocstring\expandafter
        }\expandafter{%
          \hbs@bmstring
        }%
      ]{#1}%
    \fi
  \fi
}
%    \end{macrocode}
%    \end{macro}
%
%    We have to check, whether package \Package{hyperref} is loaded
%    and have to provide a definition for \cmd{\texorpdfstring}.
%    Because \Package{hyperref} can be loaded after this package,
%    we do the work later (\cmd{\AtBeginDocument}).
%
%    This code only checks versions of \Package{hyperref} that
%    define \cmd{\ifbookmark} (v6.4x until v6.53) or
%    \cmd{\texorpdfstring} (v6.54 and above). Older versions aren't
%    supported.
%    \begin{macrocode}
\AtBeginDocument{%
  \@ifundefined{texorpdfstring}{%
    \@ifundefined{ifbookmark}{%
      \let\texorpdfstring\@firstoftwo
      \@ifpackageloaded{hyperref}{%
        \PackageInfo{hypbmsec}{%
          \ifx\hy@driver\@empty
            Default driver %
          \else
            '\hy@driver' %
          \fi
          of hyperref not supported,\MessageBreak
          bookmark parameters will be ignored%
        }%
      }{%
        \PackageInfo{hypbmsec}{%
          Package hyperref not loaded,\MessageBreak
          bookmark parameters will be ignored%
        }%
      }%
    }%
    {%
      \newcommand\texorpdfstring[2]{\ifbookmark{#2}{#1}}%
      \PackageWarningNoLine{hypbmsec}{%
        Old hyperref version found,\MessageBreak
        update of hyperref recommended%
      }%
    }%
  }{}%
%    \end{macrocode}
%
%    Other packages are allowed to redefine the sectioning commands,
%    if they does not change the syntax. Therefore the redefinitons
%    of this package should be done after the other packages.
%    \begin{macrocode}
  \let\hbs@part         \part
  \let\hbs@section      \section
  \let\hbs@subsection   \subsection
  \let\hbs@subsubsection\subsubsection
  \let\hbs@paragraph    \paragraph
  \let\hbs@subparagraph \subparagraph
  \renewcommand\part         {\hbs@do\hbs@part}%
  \renewcommand\section      {\hbs@do\hbs@section}%
  \renewcommand\subsection   {\hbs@do\hbs@subsection}%
  \renewcommand\subsubsection{\hbs@do\hbs@subsubsection}%
  \renewcommand\paragraph    {\hbs@do\hbs@paragraph}%
  \renewcommand\subparagraph {\hbs@do\hbs@subparagraph}%
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname chapter\endcsname\relax\else
    \let\hbs@chapter    \chapter
    \renewcommand\chapter    {\hbs@do\hbs@chapter}%
  \fi
}
%    \end{macrocode}
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}
%
% \section{Installation}
%
% \subsection{Download}
%
% \paragraph{Package.} This package is available on
% CTAN\footnote{\CTANpkg{hypbmsec}}:
% \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{Bundle.} All the packages of the bundle `oberdiek'
% are also available in a TDS compliant ZIP archive. There
% the packages are already unpacked and the documentation files
% are generated. The files and directories obey the TDS standard.
% \begin{description}
% \item[\CTANinstall{install/macros/latex/contrib/oberdiek.tds.zip}]
% \end{description}
% \emph{TDS} refers to the standard ``A Directory Structure
% for \TeX\ Files'' (\CTANpkg{tds}). Directories
% with \xfile{texmf} in their name are usually organized this way.
%
% \subsection{Bundle installation}
%
% \paragraph{Unpacking.} Unpack the \xfile{oberdiek.tds.zip} in the
% TDS tree (also known as \xfile{texmf} tree) of your choice.
% Example (linux):
% \begin{quote}
%   |unzip oberdiek.tds.zip -d ~/texmf|
% \end{quote}
%
% \subsection{Package installation}
%
% \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}
% \def\t{^^A
% \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\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
% }^^A
% \sbox0{\t}^^A
% \ifdim\wd0>\linewidth
%   \begingroup
%     \advance\linewidth by\leftmargin
%     \advance\linewidth by\rightmargin
%   \edef\x{\endgroup
%     \def\noexpand\lw{\the\linewidth}^^A
%   }\x
%   \def\lwbox{^^A
%     \leavevmode
%     \hbox to \linewidth{^^A
%       \kern-\leftmargin\relax
%       \hss
%       \usebox0
%       \hss
%       \kern-\rightmargin\relax
%     }^^A
%   }^^A
%   \ifdim\wd0>\lw
%     \sbox0{\small\t}^^A
%     \ifdim\wd0>\linewidth
%       \ifdim\wd0>\lw
%         \sbox0{\footnotesize\t}^^A
%         \ifdim\wd0>\linewidth
%           \ifdim\wd0>\lw
%             \sbox0{\scriptsize\t}^^A
%             \ifdim\wd0>\linewidth
%               \ifdim\wd0>\lw
%                 \sbox0{\tiny\t}^^A
%                 \ifdim\wd0>\linewidth
%                   \lwbox
%                 \else
%                   \usebox0
%                 \fi
%               \else
%                 \lwbox
%               \fi
%             \else
%               \usebox0
%             \fi
%           \else
%             \lwbox
%           \fi
%         \else
%           \usebox0
%         \fi
%       \else
%         \lwbox
%       \fi
%     \else
%       \usebox0
%     \fi
%   \else
%     \lwbox
%   \fi
% \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.
%
% \subsection{Refresh file name databases}
%
% If your \TeX~distribution
% (\TeX\,Live, \mikTeX, \dots) relies on file name databases, you must refresh
% these. For example, \TeX\,Live\ users run \verb|texhash| or
% \verb|mktexlsr|.
%
% \subsection{Some details for the interested}
%
% \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 intention:
% \begin{quote}
%   \verb|latex \let\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 meeting^^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}
%   \begin{Version}{2007/03/05 v2.3}
%   \item
%     Bug fix: Expand \cs{hbs@tocstring} and \cs{hbs@bmstring} before
%     calling \cs{hbs@seccmd}.
%   \end{Version}
%   \begin{Version}{2007/04/11 v2.4}
%   \item
%     Line ends sanitized.
%   \end{Version}
%   \begin{Version}{2016/05/16 v2.5}
%   \item
%     Documentation updates.
%   \end{Version}
% \end{History}
%
% \PrintIndex
%
% \Finale
\endinput