diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/hang/hang.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/hang/hang.tex | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/hang/hang.tex b/Master/texmf-dist/doc/latex/hang/hang.tex new file mode 100644 index 00000000000..a536fa72906 --- /dev/null +++ b/Master/texmf-dist/doc/latex/hang/hang.tex @@ -0,0 +1,113 @@ +\documentclass[a4paper]{ltxdoc} +\usepackage{hang} +\newenvironment{example}{\medskip\small}{\medskip} +\newcommand{\lipsum}{Lorem ipsum dolor sit amet, consectetuer adipiscing elit. +Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis.} +\setlength{\parindent}{1em} +\setlength{\leftmargini}{\parindent} +\frenchspacing +\sloppy + +\begin{document} +\title{\textsf{hang} -- environments for hanging \\ +paragraphs and list items} +\author{Andreas Nolda} +\date{2014/07/31 (v.\,1.0)} +\maketitle + +\noindent The \textsf{hang} package provides environments for hanging paragraphs +and list items. In addition, it defines environments for labeled paragraphs and +list items. + +\section{Hanging paragraphs and list items} + +A \emph{hanging} paragraph or list item is a text block where all lines but the +first one are indented by some \meta{length}: + +\begin{example} +\begin{hangingpar} +\lipsum +\end{hangingpar} +\end{example} + +\noindent In the following environments, the indentation \meta{length} is equal +to |\leftmargini|, which can be changed as follows: +\begin{quote} +|\setlength{\leftmargini}}{|\meta{length}|}| +\end{quote} + +\subsection{Hanging paragraphs} + +\DescribeMacro{hangingpar} The |hangingpar| environment sets \emph{single} +hanging paragraphs: +\begin{quote} +|\begin{hangingpar}| \\ +\meta{text} \\ +|\end{hangingpar}| +\end{quote} + +\subsection{Hanging list items} + +\DescribeMacro{hangingpar} The |hanginglist| environment sets one or more +hanging list items, with effectively zero left margin: +\begin{quote} +|\begin{hanginglist}| \\ +|\item|\meta{text} \\ +\vdots \\ +|\end{hanginglist}| +\end{quote} + +\DescribeMacro{compacthang} The |compacthang| environment sets one or more +hanging list items, with zero left margin and without vertical space: +\begin{quote} +|\begin{compacthang}| \\ +|\item|\meta{text} \\ +\vdots \\ +|\end{compacthang}| +\end{quote} + +\section{Labeled paragraphs and list items} + +A \emph{labeled} paragraph or list item consist of a \meta{label} and an +indented text block: + +\begin{example} +\begin{labeledpar}{\meta{label}}{\meta{label}} +\lipsum +\end{labeledpar} +\end{example} + +\noindent The following environments set the indentation to the width of their +\meta{widest\textunderscore label} argument. + +\subsection{Labeled paragraphs} + +\DescribeMacro{labeledpar} The |labeledpar| environment sets \emph{single} +labeled paragraphs: +\begin{quote} +|\begin{labeledpar}{|\meta{widest\textunderscore label}|}{|\meta{label}|}| \\ +\meta{text} \\ +|\end{labeledpar}| +\end{quote} + +\subsection{Labeled list items} + +\DescribeMacro{labeledlist} The |labeledlist| environment sets one or more +labeled list items, with effectively zero left margin: +\begin{quote} +|\begin{labeledlist}{|\meta{widest\textunderscore label}|}| \\ +|\item[|\meta{label}|]|\meta{text} \\ +\vdots \\ +|\end{labeledlist}| +\end{quote} + +\DescribeMacro{compactlabel} The |compactlabel| environment sets one or more +labeled list items, with zero left margin and without vertical space: +\begin{quote} +|\begin{compactlabel}{|\meta{widest\textunderscore label}|}| \\ +|\item[|\meta{label}|]|\meta{text} \\ +\vdots \\ +|\end{compactlabel}| +\end{quote} + +\end{document} |