summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-05-05 18:30:30 +0000
committerKarl Berry <karl@freefriends.org>2008-05-05 18:30:30 +0000
commitd3bc7c656ca1b93595bf7a5feb4f748914a47628 (patch)
treeeb62614420298b366175b242569a2f99202f1b49 /Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
parent3e59d234a04a1e8b8301aa11de49208208eb4e9f (diff)
new latex package petiteannonce (3may08)
git-svn-id: svn://tug.org/texlive/trunk@7866 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex')
-rwxr-xr-xMaster/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex88
1 files changed, 88 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex b/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
new file mode 100755
index 00000000000..effea976752
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/petiteannonce/petiteannonce.doc.tex
@@ -0,0 +1,88 @@
+\documentclass{article}
+\usepackage{pdfpages,fancyvrb}
+\title{Petiteannonce package documentation}
+\author{Vincent Bela\"\i che}
+\begin{document}
+
+\maketitle
+\section{Introduction}
+This is the documentation of the petiteannonce package. The aim of this package is to
+make adverts that you would pin down on some notice board in a mall with your
+phone number repeated on strips. This practice is quite common in France as it
+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{Commands}
+
+There are two commands the \verb!\petiteannonce! command and the \verb!\petiteannoncewidth!
+command.
+
+\subsection{The \textbackslash petiteannonce command}
+
+The \verb!\petiteannonce! command is used to create the advertisement. It takes two
+mandatory arguments and one optional argument.
+\begin{itemize}
+\item The 1\textsuperscript{st} mandatory argument is the phone number or
+ email address where to reach the seller.
+\item The 2\textsuperscript{nd} mandatory argument is the text of the advert itself
+\item The optional argument is a list of comma separated \(<\textit
+ key\/>=<\textit{value\/}>\) arguments that allows to configure a number of
+ additional things. Absence of the key is equivalent to setting it to its
+ default value. The supported keys are the following:
+ \begin{list}{}{}
+ \item [cols] positive integer with default value 1. Specifies the
+ number of columns of the document that is used to compute the width of
+ the advert. When the advert is repeated, a new paragraph is generated
+ every {\em cols\/} columns.
+ \item [count] positive integer with default value 1. Tells the number of
+ 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
+ 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
+ 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
+ horizontal space between the telephone numbers.
+ \item [telrulewidth] dimension with default value 0.5pt. Width of the
+ vertical rule separating two telephone strips.
+ \item [telvspace] dimension with default value 10pt. Vertical space shared
+ equally above and below the telephone number in the strip (this space is
+ 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.
+ \end{list}
+\end{itemize}
+
+\subsection{The \textbackslash petiteannoncewidth command}
+
+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.
+
+\section{Sample code}
+
+The following sample code will expand into the advertisement page at the page
+this sample code.
+
+
+\VerbatimInput{petiteannonceexample.tex}
+
+
+
+\includepdf{petiteannonceexample}
+
+\end{document}
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-PDF-mode: t
+%%% TeX-master: t
+%%% End: