summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/vertbars/vertbars.tex
blob: 8b5a3f34f7025619cae324f1392cb52284ae0580 (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

\makeatletter
\documentclass{ltxdoc}

\usepackage[it,medium]{titlesec}

\usepackage{array,bigfoot,vertbars}
\usepackage[svgnames]{xcolor}
\usepackage[colorlinks,linktocpage]{hyperref}

\usepackage{geometry}
\geometry{b5paper}

\DeclareRobustCommand\pkg{\textsf}
\def\pkgopt#1{\texttt{[#1]}}


\usepackage[T1]{fontenc}
\usepackage{microtype}
\usepackage{lmodern}
\usepackage[sc,osf]{mathpazo}
\linespread{1.1}
\frenchspacing

\GetFileInfo{vertbars.sty}
\begin{document}

\title{The \pkg{vertbars} package}
\author{%
 Author: Peter Wilson, Herries Press\\
 Maintainer: Will Robertson\\
 \url{http://github.com/wspr/herries-press}%
}
\date{\fileversion \qquad \filedate}

\maketitle

\section{Documentation}

Because this package uses \textsf{lineno} as a driver,
please read the documentation of that package first to
understand the mechanisms used here.

The \textsf{vertbars} package takes the same options as the \textsf{lineno} package.
In particular, the switch and switch* options control which side of the page any bars will be printed.
The package automatically calls the lineno package, so you just need to write:
\begin{verbatim}
    \usepackage[...]{vertbars}
\end{verbatim}

The package provides the \texttt{vertbar} environment, which is equivalent to the linenumbers environment except that a vertical bar replaces the line number.
Text paragraphs within a vertbar environment will be marked with a vertical bar in the margin.
Nested environments generate multiple marginal bars.

The width of the bars is controlled by the value of \cmd\barwidth, which is initialised to \verb|0.4pt|, and can be changed via \cmd\setlength.

The horizontal separation between adjacent bars is controlled by the value of \cmd\barspace, which is initialised to \verb|0.5\linenumbersep|, and can be changed via \cmd\setlength.
(\cmd\linenumbersep is a command from the lineno package that controls the spacing between line numbers and the text body).

Note: Bars can only be applied to complete paragraphs.
For bars between arbitrary points, use the \textsf{changebar} package.
Any limitations of the \textsf{lineno} package apply equally to the \textsf{vertbars} package.

\section*{Change History}

\begin{itemize}
\item[v1.0c] 2018-12-12 Add \cs{par} before and after the \texttt{vertbar} environment to avoid confusing/unwanted behaviour with paragraphs
\item[v1.0b] 2010/11/27 Fix behaviour with \texttt{switch} option
\item[v1.0a] 2009/09/04 New maintainer (Will Robertson)
\end{itemize}



\section*{Licence and copyright}

This work may be modified and/or distributed under the terms and
conditions of the \LaTeX\ Project Public License\footnote{\url{http://www.latex-project.org/lppl.txt}}, version~1.3c or later (your choice).
The current maintainer of this work is Will Robertson.

\bigskip
  \noindent
  Copyright Peter Wilson, 2000 \\
  Copyright Will Robertson, 2010-2018 \\

{\addtocontents{toc}{\protect\end{varwidth}\protect\hfill}}
{\addtocontents{toc}{\protect\begin{varwidth}[t]{\protect\tocwidthB\protect\linewidth}}}
\clearpage
\parindent=0pt


{\addtocontents{toc}{\protect\end{varwidth}}}

\end{document}