petiteannonce 1.0001 (11apr12)

git-svn-id: svn://tug.org/texlive/trunk@25915 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 31 insertions, 10 deletions

diff --git a/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex b/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
index effea976752..40ded62732f 100644
--- a/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
+++ b/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
@@ -1,5 +1,6 @@
 \documentclass{article}
 \usepackage{pdfpages,fancyvrb}
+\usepackage{siunitx}
 \title{Petiteannonce package documentation}
 \author{Vincent Bela\"\i che}
 \begin{document}
@@ -13,10 +14,19 @@ is simple, cheap (no fee for intermediates like eBay\texttrademark),
 and allows you to reach people in the same neighbourhood (so no need for
 postal fee either).
 
+\section{Package options}
+
+There is one single class option \verb!margin!, this is used to set the margin value, by default this is
+\SI{1}{\milli\metre}. For instance use:
+
+\verb!\documentclass[margin=3mm]{petiteannonce}!
+
+\noindent if you want it to be \SI{3}{\milli\metre} instead of \SI{1}{\milli\metre}.
+
 \section{Commands}
 
-There are two commands the \verb!\petiteannonce! command and the \verb!\petiteannoncewidth!
-command.
+There are three commands the \verb!\petiteannonce! command, the \verb!\petiteannoncewidth!
+command, and the \verb!\petiteannonceaddtowidth! command.
 
 \subsection{The \textbackslash petiteannonce command}
 
@@ -39,16 +49,16 @@ mandatory arguments and one optional argument.
     times the advert is repeated.
   \item [cutvspace] dimension with default value 10pt. Tell the vertical space
     under to horizontal dotted line that is provided for cutting one strip.
-  \item [skip] non negative integers with default value 0. The value shall be
+  \item [skip] non negative integer with default value 0. The value shall be
     less than {\em cols\/}. Specifies that the first {\em skip\/}
     advert are not generated. This may be useful when you want to make several
     adverts in the same document.
   \item [texthspace] dimension with default value 20pt. This key allows to
     specify the space evenly placed before and after advert text. 
-  \item [texthspace] dimension with default value 10pt. This key allows to
+  \item [textvspace] dimension with default value 10pt. This key allows to
     specify the space evenly placed above and below text.
   \item [telcolsep] dimension with default value 10pt. This key allows to
-    specify the separation between to telephone strips, that is to say the
+    specify the separation between two telephone strips, that is to say the
     horizontal space between the telephone numbers.
   \item [telrulewidth] dimension with default value 0.5pt. Width of the
     vertical rule separating two telephone strips.
@@ -57,17 +67,28 @@ mandatory arguments and one optional argument.
     one the before and after the number if you look at the strip horizontally).
   \item [width] dimension with default value \verb!\textwidth!. Overloads the value
     computed with {\em cols\/}. In such a case take care to place the {\em
-      width\/} argument after the {\em cols\/} argument.
+      width\/} argument after the {\em cols\/} argument. This specifies the advert total width, including the
+    frame rule width, rule separator, and all the internal spaces.
   \end{list}
 \end{itemize}
 
-\subsection{The \textbackslash petiteannoncewidth command}
+\subsection{The \textbackslash petiteannoncewidth and \textbackslash petiteannonceaddtowidth commands}
+
+The \verb!\petiteannoncewidth! command takes one argument \#1 and expands into \#1 \(\times\) the width of the
+advert text. This is useful when you use a tabular to make the text of the advert like in the example given in
+\S~\ref{sec:sample-code}.
+
+The \verb!\petiteannonceaddtowidth! command takes one argument that is some offset to add to the advert
+textwidth. A use of that is given in example of \S~\ref{sec:sample-code}, where the advert text is within an
+array, and one wants to take into account the \verb!\tabcolsep! half column separation.
+
+\subsection{Changing the outside frame}
 
-The \verb!\petiteannoncewidth! command takes one argument \#1 and expands into
-\#1 \(\times\) the width of the advert. This is useful when you use a tabular
-to make the text of the advert.
+The frame around the advert is generated with a standard \verb!\framebox! command, so you can play with it by
+changing \verb!\fboxsep! and \verb!\fboxrule!.
 
 \section{Sample code}
+\label{sec:sample-code}
 
 The following sample code will expand into the advertisement page at the page
 this sample code.