summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/varwidth/varwidth-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/varwidth/varwidth-doc.tex')
-rw-r--r--macros/latex/contrib/varwidth/varwidth-doc.tex55
1 files changed, 55 insertions, 0 deletions
diff --git a/macros/latex/contrib/varwidth/varwidth-doc.tex b/macros/latex/contrib/varwidth/varwidth-doc.tex
new file mode 100644
index 0000000000..1944e0dbf5
--- /dev/null
+++ b/macros/latex/contrib/varwidth/varwidth-doc.tex
@@ -0,0 +1,55 @@
+\documentclass[a4paper]{article}
+\usepackage[a4paper]{geometry}
+\usepackage{miscdoc,varwidth,multicol}
+\newcommand{\minitab}[2][l]{\begin{tabular}{#1}#2\end{tabular}}
+
+\newsavebox{\varbox}
+
+\begin{document}
+\title{The \Package{varwidth} package (version 0.92)}
+\author{Donald Arseneau\thanks{Documentation put together by Robin Fairbairns}}
+\maketitle
+
+\section{The \environment{varwidth} environment}
+
+The package defines a \environment{varwidth} environment (based on
+\environment{minipage}) which is an
+analogue of \environment{minipage}, but whose resulting width is the
+natural width of its contents. A trivial example:
+\begin{center}
+ \begin{varwidth}[t]{2in}
+ \cmdinvoke{begin}{varwidth}{1in}\\
+ \null\quad\texttt{Trivia}\\
+ \cmdinvoke{end}{varwidth}
+ \end{varwidth}%
+ \quad and\quad
+ \begin{varwidth}[t]{2in}
+ \cmdinvoke{begin}{minipage}{1in}\\
+ \null\quad\texttt{Trivia}\\
+ \cmdinvoke{end}{minipage}
+ \end{varwidth}
+\end{center}
+which produces
+\begin{center}
+ \begin{lrbox}\varbox
+ \begin{varwidth}{1in}
+ Trivia
+ \end{varwidth}
+ \end{lrbox}
+ \fbox{\usebox{\varbox}}%
+ \quad and\quad
+ \begin{lrbox}\varbox
+ \begin{minipage}{1in}
+ Trivia
+ \end{minipage}
+ \end{lrbox}
+ \fbox{\usebox{\varbox}}%
+\end{center}
+(the output placed in an \cs{fbox} to emphasise the effect).
+
+\section{The \cs{narrowragged} command}
+
+The command works like \cs{raggedright}, but produces generally
+narrowe lines in paragraphs, with more text in the last line (the
+lines have more-equal lengths).
+\end{document}