diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/hang/hang.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/hang/hang.tex | 61 |
1 files changed, 38 insertions, 23 deletions
diff --git a/Master/texmf-dist/doc/latex/hang/hang.tex b/Master/texmf-dist/doc/latex/hang/hang.tex index a536fa72906..3088ea626d4 100644 --- a/Master/texmf-dist/doc/latex/hang/hang.tex +++ b/Master/texmf-dist/doc/latex/hang/hang.tex @@ -1,8 +1,12 @@ \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.} +\usepackage{polyglossia} +\setdefaultlanguage{english} +\setotherlanguage{latin} +\newenvironment{hangingexample}{\medskip\setlength{\hangingleftmargin}{1em}}{\medskip} +\newenvironment{labeledexample}{\medskip\setlength{\labeledleftmargin}{1em}}{\medskip} +\newcommand{\lipsum}{\textlatin{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 @@ -12,7 +16,7 @@ Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis.} \title{\textsf{hang} -- environments for hanging \\ paragraphs and list items} \author{Andreas Nolda} -\date{2014/07/31 (v.\,1.0)} +\date{2015/05/13 (v.\,2.0)} \maketitle \noindent The \textsf{hang} package provides environments for hanging paragraphs @@ -24,17 +28,22 @@ 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{hangingexample} \begin{hangingpar} \lipsum \end{hangingpar} -\end{example} +\end{hangingexample} -\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}|}| +\DescribeMacro{\hangingindent} In the following environments, the +indentation \meta{length} is controlled by the |\hangingindent| length, which +can be changed as follows: \begin{quote} +|\setlength{\hangingindent}{|\meta{length}|}| \end{quote} +By default, it is set to |1em|. + +\DescribeMacro{\hangingleftmargin} The left margin of the whole hanging +paragraph or list item equals the |\hangingleftmargin| length, which defaults to +zero. In the above example, it is set to |1em| with |\setlength|. \subsection{Hanging paragraphs} @@ -48,37 +57,43 @@ hanging paragraphs: \subsection{Hanging list items} -\DescribeMacro{hangingpar} The |hanginglist| environment sets one or more -hanging list items, with effectively zero left margin: +\DescribeMacro{hanginglist} The |hanginglist| environment sets one or more +hanging list items: \begin{quote} |\begin{hanginglist}| \\ -|\item|\meta{text} \\ +|\item |\meta{text} \\ \vdots \\ |\end{hanginglist}| \end{quote} +\pagebreak \DescribeMacro{compacthang} The |compacthang| environment sets one or more -hanging list items, with zero left margin and without vertical space: +hanging list items without vertical space: \begin{quote} |\begin{compacthang}| \\ -|\item|\meta{text} \\ +|\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: +A \emph{labeled} paragraph or list item consist of a \meta{label} and a text +block, which is indented by some \meta{length}: -\begin{example} +\begin{labeledexample} \begin{labeledpar}{\meta{label}}{\meta{label}} \lipsum \end{labeledpar} -\end{example} +\end{labeledexample} + +The following environments set the indentation \meta{length} to the width of +their \meta{widest\textunderscore label} argument. -\noindent The following environments set the indentation to the width of their -\meta{widest\textunderscore label} argument. +\DescribeMacro{\labeledleftmargin} The left margin of the whole labeled +paragraph or list item (including the \meta{label}) equals the +|\labeledleftmargin| length, which defaults to zero, too. In the above example, +it is again set to |1em|. \subsection{Labeled paragraphs} @@ -93,7 +108,7 @@ labeled paragraphs: \subsection{Labeled list items} \DescribeMacro{labeledlist} The |labeledlist| environment sets one or more -labeled list items, with effectively zero left margin: +labeled list items: \begin{quote} |\begin{labeledlist}{|\meta{widest\textunderscore label}|}| \\ |\item[|\meta{label}|]|\meta{text} \\ @@ -102,7 +117,7 @@ labeled list items, with effectively zero left margin: \end{quote} \DescribeMacro{compactlabel} The |compactlabel| environment sets one or more -labeled list items, with zero left margin and without vertical space: +labeled list items without vertical space: \begin{quote} |\begin{compactlabel}{|\meta{widest\textunderscore label}|}| \\ |\item[|\meta{label}|]|\meta{text} \\ |