git.sur5r.net Git - bacula/docs/blob - docs/manuals/bacula.sty

   1 %% bacula.sty
   2 %% Provides macros and other stuff for the bacula manual
   3 %%
   4 %% Original Creation -- K. Cunningham 2005-01-09
   5 %%
   6 %%
   7 %%
   8 %% New Commands Currently implemented:
   9 %%
  10 %% \elink{target}{text}
  11 %%    Inserts the text indicated (highlighted) and provides
  12 %%    an external hyperlink to the target.
  13 %%
  14 %%
  15 %% \ilink{target}{text}
  16 %%    Inserts the text indicated (highlighted) and provides
  17 %%    an internal hyperlink to the target. Target must be a
  18 %%    \label somewhere in the same document.
  19 %%
  20 %% \lt
  21 %%    Inserts a less-than character (<).
  22 %%
  23 %% \gt
  24 %%    Inserts a greater-than character (>).
  25 %%
  26 %% \idir
  27 %%    Inserts the path to the images
  28 %%
  29 %%
  30 %%
  31 \ProvidesPackage{bacula}[2008/10/03]
  32 \usepackage{ltxtable,varioref}
  33 \usepackage{babel,xr-hyper}
  34 \usepackage{xr}
  35 \input{external-references}
  36 %%
  37 %%
  38 %% define images directory -- KES 15Aug08
  39 %\def\idir{/home/kern/bacula/docs/docs/images/}  %% images directory
  40 \def\idir{}
  41 \newcolumntype{Y}{>{\centering\arraybackslash}X}
  42 %% LaTeX GraphicPath directive is able to manage this.
  43 %% manuals/_lang_/_manual_name/
  44 \graphicspath{{../../../images/pdf/}{../../../images/png/}{../../../images/jpeg/}{../../../images/}{../../../images/eps/}{../../../images/hires/}}
  45 %% In tex files: do _not_ put the filename extension
  46 %% Below, define the precedence for filetypes
  47 \include{graphicspolicy}
  48 %% Some definition for external references.
  49 \def\mbacula{Bacula Community}
  50 \def\miscman{\mbacula{} Misc Manual}
  51 \def\consoleman{\mbacula{} Console Manual}
  52 \def\mainman{\mbacula{} Main Manual}
  53 \def\devman{\mbacula{} Developers Manual}
  54 \def\utilityman{\mbacula{} Utility programs}
  55 \def\problemsman{\mbacula{} Problem Resolution Guide}
  56 %%
  57 %% eXternal References macro: borgxrlink
  58 %%% #1: Text to display
  59 %%% #2: Label defined
  60 %%% #3: manual: main, console, misc, developers
  61 %%% #4: text as reference level. will be displayed ``as is''
  62 %%%
  63 %%% Example:
  64 %%% \borgxrlink{Console Configuration}{ConsoleConfChapter}{main}{chapter}
  65 %%% will display
  66 %%% Console Configuration chapter (chapter 30 on page 269)
  67 \newcommand*{\borgxrlink}[4]{%
  68   \href{../#3/#3}{\textbf{#1}} #4 (#4 \vref{#3-#2})
  69 }
  70 %%
  71 %% Same for pointing to document.
  72 %% \borgxrlinkdocument{Text}{label}{manual}{type-of-reference}
  73 %% Will display
  74 %% Text (chapter XX on page YY)
  75 \newcommand*{\borgxrlinkdocument}[4]{%
  76   \href{../#3/#3}{\textbf{#1}} (#4 \vref{#3-#2})
  77 }
  78
  79 \usepackage{multirow}
  80 \def\arraystretch{1.5}
  81 \pdfminorversion=4
  82
  83
  84 \def\version{5.3.2}
  85
  86
  87 %%
  88 \newcommand*{\elink}[2]{%
  89   %\htmladdnormallink{#1}{#2}%
  90   \href{#2}{#1}
  91 }
  92 %%
  93 \newcommand*{\ilink}[2]{%
  94   \htmlref{\textcolor{black}{#1}}{#2}%
  95 %  #1 (cf. \vref{#2})%\htmlref{#1}{#2}%
  96 }
  97 \newcommand*{\borgref}[1]{%
  98   %% displays 'the_reference on page p'
  99   \vref{#1}
 100 }
 101 %%
 102 \newcommand{\dq}{\verb+"+}
 103 \newcommand{\vb}{$|$}
 104 \newcommand{\lt}{$<$}
 105 \newcommand{\gt}{$>$}
 106
 107 %% copied from /usr/share/texmf/tex/latex/base/book.cls, and
 108 %%  modified to suit.  KEC 4-28-05
 109 %% KEC: Removed the two-column arrangement, and added \newpage
 110 \renewenvironment{theindex}
 111                {\if@twocolumn
 112                   \@restonecolfalse
 113                 \else
 114                   \@restonecoltrue
 115                 \fi
 116 %% KEC:  Switch to one column.
 117 %%              \columnseprule \z@
 118 %%              \columnsep 35\p@
 119 %%              \twocolumn[\@makeschapterhead{\indexname}]%
 120                 \@mkboth{\MakeUppercase\indexname}%
 121                         {\MakeUppercase\indexname}%
 122                                 \clearpage
 123                                 \subsection*{\indexname}
 124                                 \addcontentsline{toc}{subsection}{\indexname}
 125                 \thispagestyle{plain}\parindent\z@
 126                 \parskip\z@ \@plus .3\p@\relax
 127                 \let\item\@idxitem}
 128                                 {\if@restonecol\onecolumn\else\clearpage\fi}   %% Is this needed???
 129
 130 %%
 131 \endinput
 132 %%