diff options
author | Karl Berry <karl@freefriends.org> | 2018-12-16 21:53:42 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-12-16 21:53:42 +0000 |
commit | 211d2a1b3f4775c8a6d9db34655eda9e9f0542de (patch) | |
tree | 5c1a21592aca3812517b7f7c47e162f4f641f629 /Master/texmf-dist/doc | |
parent | 8660b75c72121d1ba0b1c8d5af74a0b181e02eec (diff) |
vertbars (16dec18)
git-svn-id: svn://tug.org/texlive/trunk@49429 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/vertbars/README.md (renamed from Master/texmf-dist/doc/latex/vertbars/README) | 26 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/vertbars/vertbars.pdf | bin | 33809 -> 160548 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/vertbars/vertbars.tex | 93 |
3 files changed, 102 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/vertbars/README b/Master/texmf-dist/doc/latex/vertbars/README.md index 9d037914bc4..9ff5647a458 100644 --- a/Master/texmf-dist/doc/latex/vertbars/README +++ b/Master/texmf-dist/doc/latex/vertbars/README.md @@ -6,24 +6,15 @@ Place vertical bars in the margin around material. (Also see the changebar package.) This package uses lineno to do its thing. -INSTALLATION ------------- - -Run `pdflatex` on vertbars.tex to produce the files - vertbars.ins and vertbars.sty, -as well as to compile the PDF documentation. - -Execute `tex vertbars.ins` to produce the files above -except vertbars.ins itself (and the PDF file, obviously). COPYRIGHT AND LICENSING ----------------------- -Authors: Peter Wilson (Herries Press) -Maintainer: Will Robertson (will dot robertson at latex-project dot org) -Copyright 2000 Peter Wilson -Copyright 2010 Will Robertson +Authors: Peter Wilson (Herries Press) +Maintainer: Will Robertson (will dot robertson at latex-project dot org) +Copyright 2000 Peter Wilson +Copyright 2010-2018 Will Robertson This work may be distributed and/or modified under the @@ -38,15 +29,16 @@ This work consists of the files vertbars.tex and the derived files vertbars.sty and vertbars.ins. + MAINTENANCE ----------- -Please report bugs or request features: +Please report bugs or request features: <http://github.com/wspr/herries-press/issues> -Developmental and historical versions: +Developmental and historical versions: <http://github.com/wspr/herries-press> -Current release version: - <http://ctan.tug.org/pkg/vertbars> +Current release version: + <http://ctan.tug.org/pkg/vertbars> diff --git a/Master/texmf-dist/doc/latex/vertbars/vertbars.pdf b/Master/texmf-dist/doc/latex/vertbars/vertbars.pdf Binary files differindex d162d2e76f4..0b24afda942 100644 --- a/Master/texmf-dist/doc/latex/vertbars/vertbars.pdf +++ b/Master/texmf-dist/doc/latex/vertbars/vertbars.pdf diff --git a/Master/texmf-dist/doc/latex/vertbars/vertbars.tex b/Master/texmf-dist/doc/latex/vertbars/vertbars.tex new file mode 100644 index 00000000000..8b5a3f34f70 --- /dev/null +++ b/Master/texmf-dist/doc/latex/vertbars/vertbars.tex @@ -0,0 +1,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} |