summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/hang
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-05-13 21:33:22 +0000
committerKarl Berry <karl@freefriends.org>2015-05-13 21:33:22 +0000
commit7d00fa0a4bf524d8ce252a3948a7a49baaa15f17 (patch)
tree7ffa4782ac3c262a05013522b98e6c06776c999c /Master/texmf-dist/doc/latex/hang
parent9f28862d6cb8fd41c321dae74aba8d5603b2ccc2 (diff)
hang (13may15)
git-svn-id: svn://tug.org/texlive/trunk@37383 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/hang')
-rw-r--r--Master/texmf-dist/doc/latex/hang/ChangeLog6
-rw-r--r--Master/texmf-dist/doc/latex/hang/README2
-rw-r--r--Master/texmf-dist/doc/latex/hang/hang.pdfbin27758 -> 31286 bytes
-rw-r--r--Master/texmf-dist/doc/latex/hang/hang.tex61
-rw-r--r--Master/texmf-dist/doc/latex/hang/sample.pdfbin0 -> 20058 bytes
-rw-r--r--Master/texmf-dist/doc/latex/hang/sample.tex71
6 files changed, 116 insertions, 24 deletions
diff --git a/Master/texmf-dist/doc/latex/hang/ChangeLog b/Master/texmf-dist/doc/latex/hang/ChangeLog
index 69eeeac0c88..41dcae51f7f 100644
--- a/Master/texmf-dist/doc/latex/hang/ChangeLog
+++ b/Master/texmf-dist/doc/latex/hang/ChangeLog
@@ -1,2 +1,8 @@
+2015-05-13:
+ * control hanging indentation by \hangingindent length
+ * control left margin by \hangingleftmargin and \labeledleftmargin lengths
+ * sample file
+ * bump version to 2.0
+
2014-07-31:
* initial release
diff --git a/Master/texmf-dist/doc/latex/hang/README b/Master/texmf-dist/doc/latex/hang/README
index d3892ff3568..0d2c1d9a231 100644
--- a/Master/texmf-dist/doc/latex/hang/README
+++ b/Master/texmf-dist/doc/latex/hang/README
@@ -1,4 +1,4 @@
-The "hang" LaTeX package (version 1.0)
+The "hang" LaTeX package (version 2.0)
--------------------------------------
The "hang" package provides environments for hanging paragraphs and list items.
diff --git a/Master/texmf-dist/doc/latex/hang/hang.pdf b/Master/texmf-dist/doc/latex/hang/hang.pdf
index 4e88fd21f71..d01432bb568 100644
--- a/Master/texmf-dist/doc/latex/hang/hang.pdf
+++ b/Master/texmf-dist/doc/latex/hang/hang.pdf
Binary files differ
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} \\
diff --git a/Master/texmf-dist/doc/latex/hang/sample.pdf b/Master/texmf-dist/doc/latex/hang/sample.pdf
new file mode 100644
index 00000000000..5dccc66e6dd
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hang/sample.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/hang/sample.tex b/Master/texmf-dist/doc/latex/hang/sample.tex
new file mode 100644
index 00000000000..56b1b3500bb
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hang/sample.tex
@@ -0,0 +1,71 @@
+\documentclass[a4paper]{ltxdoc}
+\usepackage{hang}
+\usepackage{polyglossia}
+\setdefaultlanguage{english}
+\setotherlanguage{latin}
+\newcommand{\lipsumone}{\textlatin{Lorem ipsum dolor sit amet, consectetuer
+adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae,
+felis.}}
+\newcommand{\lipsumtwo}{\textlatin{Curabitur dictum gravida mauris. Nam arcu
+libero, nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue
+eu neque.}}
+\setlength{\parindent}{1em}
+
+\frenchspacing
+\sloppy
+
+\begin{document}
+\title{Sample use of the \textsf{hang} package}
+\author{Andreas Nolda}
+\date{2015/05/13}
+\maketitle
+
+\section{Hanging paragraphs and list items}
+
+\subsection{Hanging paragraphs}
+
+\begin{hangingpar}
+\DescribeMacro{hangingpar}\lipsumone
+\end{hangingpar}
+\begin{hangingpar}
+\DescribeMacro{hangingpar}\lipsumtwo
+\end{hangingpar}
+
+\subsection{Hanging list items}
+
+\begin{hanginglist}
+\item\DescribeMacro{hanginglist}\lipsumone
+\item\lipsumtwo
+\end{hanginglist}
+
+\begin{compacthang}
+\item\DescribeMacro{compacthang}\lipsumone
+\item\lipsumtwo
+\end{compacthang}
+
+\section{Labeled paragraphs and list items}
+
+\subsection{Labeled paragraphs}
+
+\begin{labeledpar}{Label 10}{Label 9}
+\DescribeMacro{labeledpar}\lipsumone
+\end{labeledpar}
+\begin{labeledpar}{Label 10}{Label 10}
+\DescribeMacro{labeledpar}\lipsumtwo
+\end{labeledpar}
+
+\subsection{Labeled list items}
+
+\begin{labeledlist}{Label 10}
+\item[Label 9]\DescribeMacro{labeledlist}\lipsumone
+\item[Label 10]\lipsumtwo
+\end{labeledlist}
+
+\pagebreak
+\begin{compactlabel}{Label 10}
+\item[Label 9]\DescribeMacro{compactlabel}\lipsumone
+\item[Label 10]\lipsumtwo
+\end{compactlabel}
+
+
+\end{document}