summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/handout
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-04-16 21:14:55 +0000
committerKarl Berry <karl@freefriends.org>2015-04-16 21:14:55 +0000
commitf5b7a7653ac55458cc184c61141e54a73cea8216 (patch)
tree90986c0f13fb92f395281f3deb3ded38b82158c9 /Master/texmf-dist/doc/latex/handout
parent5e9b1a67a4ffe95fd5858a39da9b8f6b3eca5bd8 (diff)
handout (15apr15)
git-svn-id: svn://tug.org/texlive/trunk@36877 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/handout')
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example1-minimal.pdfbin11482 -> 11479 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example2-cancel-quotation.pdfbin11474 -> 11475 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example3-defined-path.pdfbin12761 -> 12761 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example4-sectioning.pdfbin16962 -> 16964 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example5-numbering.pdfbin19761 -> 19765 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example6-not-and-only.pdfbin25208 -> 25208 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/examples/example7-biblatex.pdfbin39160 -> 39160 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/handout.pdfbin69129 -> 68701 bytes
-rw-r--r--Master/texmf-dist/doc/latex/handout/handout.tex62
9 files changed, 32 insertions, 30 deletions
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example1-minimal.pdf b/Master/texmf-dist/doc/latex/handout/examples/example1-minimal.pdf
index c1ca8b427dc..5b38f31d417 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example1-minimal.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example1-minimal.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example2-cancel-quotation.pdf b/Master/texmf-dist/doc/latex/handout/examples/example2-cancel-quotation.pdf
index b7cb02ccdbb..13756a595fc 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example2-cancel-quotation.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example2-cancel-quotation.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example3-defined-path.pdf b/Master/texmf-dist/doc/latex/handout/examples/example3-defined-path.pdf
index 4cefbaa016f..c027b52ad20 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example3-defined-path.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example3-defined-path.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example4-sectioning.pdf b/Master/texmf-dist/doc/latex/handout/examples/example4-sectioning.pdf
index f18276963db..f54c75a9a08 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example4-sectioning.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example4-sectioning.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example5-numbering.pdf b/Master/texmf-dist/doc/latex/handout/examples/example5-numbering.pdf
index 66c477bcec3..f89e3a79bff 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example5-numbering.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example5-numbering.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example6-not-and-only.pdf b/Master/texmf-dist/doc/latex/handout/examples/example6-not-and-only.pdf
index d39ce89c2d2..e8b77148710 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example6-not-and-only.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example6-not-and-only.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/examples/example7-biblatex.pdf b/Master/texmf-dist/doc/latex/handout/examples/example7-biblatex.pdf
index 719cb8eaecd..413ea2f96cd 100644
--- a/Master/texmf-dist/doc/latex/handout/examples/example7-biblatex.pdf
+++ b/Master/texmf-dist/doc/latex/handout/examples/example7-biblatex.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/handout.pdf b/Master/texmf-dist/doc/latex/handout/handout.pdf
index c0aa8f509c5..ae261da92c7 100644
--- a/Master/texmf-dist/doc/latex/handout/handout.pdf
+++ b/Master/texmf-dist/doc/latex/handout/handout.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/handout/handout.tex b/Master/texmf-dist/doc/latex/handout/handout.tex
index a2e9854f011..9f2e1465e83 100644
--- a/Master/texmf-dist/doc/latex/handout/handout.tex
+++ b/Master/texmf-dist/doc/latex/handout/handout.tex
@@ -12,12 +12,12 @@
\usepackage{bidi}
% Meta-datas
\titlepage{%
- title={Handout's making},
- subtitle={to prepare your speech},
+ title={Making handout},
+ subtitle={to support your talk},
email={maieul <at> maieul <dot> net},
author={Maïeul Rouquette},
- revision={1.2.1},
- date={14/02/2015},
+ revision={1.2.1a},
+ date={16/04/2015},
url={https://github.com/maieul/handout}}
@@ -29,22 +29,21 @@
\section{Introduction}
\subsection{Goal}
-In some fields of schol­ar­ship, a beamer does not of­fer good sup­port when giv­ing a talk in a pro­ceed­ing. For ex­am­ple, in clas­si­cal philol­ogy, the main sources are text, and it will be bet­ter to dis­tribute a hand­out to the au­di­ence with ex­tracts of the texts about which we will talk.
+In some fields of schol­ar­ship, a beamer does not of­fer good sup­port when giv­ing a talk. For ex­am­ple, in clas­si­cal philol­ogy, the main sources are text, and it will be bet­ter to dis­tribute a hand­out to the au­di­ence with ex­tracts of the texts about which we will talk.
The pack­age sup­ports prepa­ra­tion of such hand­outs when writ­ing the talk.
\subsection{Credits}
-This package was created for Maïeul Rouquette's PHD\footnote{\url{http://apocryphes.hypothese.org}.} in 2014. It is licenced on the \emph{\LaTeX\ Project Public Licence}\footnote{\url{http://latex-project.org/lppl/lppl-1-3c.html}.}.
+This package was created for Maïeul Rouquette's PHD\footnote{\url{http://apocryphes.hypothese.org}.} in 2014. It is licenced under the \emph{\LaTeX\ Project Public Licence}.\footnote{\url{http://latex-project.org/lppl/lppl-1-3c.html}.}
-All issues can be submitted, in French or English, in the GitHub issues page\footnote{\url{https://github.com/maieul/handout/issues}.}.
+All issues can be submitted, in French or English, on the GitHub issues page.\footnote{\url{https://github.com/maieul/handout/issues}.}
\subsection{French tutorial}
-As the idea of the package behavior was send by French \LaTeX\ users\footnote{\url{http://fr.comp.text.tex.narkive.com/pXMop2kE/fabrication-d-un-exemplier}.}, and as the package's author has French as native language, a French tutorial is available in \url{http://geekographie.maieul.net/136}.
-
-All files in the examples' folder are in French, but that should not have consequence for the meaning of their behaviors. They have to be run with \XeLaTeX.
+As the idea for the package behavior came from French \LaTeX\ users\footnote{\url{http://fr.comp.text.tex.narkive.com/pXMop2kE/fabrication-d-un-exemplier}.}, and as the package's author speaks French as a native language, a French tutorial is available in \url{http://geekographie.maieul.net/136}.
+All files in the examples’ folder are in French, but the effect of the commands they use should still be clear. They have to be run with \XeLaTeX.
\section{Basis}
@@ -53,7 +52,7 @@ The package can be loaded very quickly with the standard command \cs{usepackage}
\begin{minted}{tex}
\usepackage{handout}
\end{minted}
-The idea of the this package is to prepare handout during the writing of the paper. When you want to add something in your handout, just write it on an external file, and call this external file with the command \cs{handout} :
++The idea of the this package is to prepare a handout during the writing of a paper. When you want to add something to your handout, just write it in an external file, and call this external file with the command \cs{handout}:
\begin{minted}{tex}
Your text
@@ -67,28 +66,29 @@ The PDF output will contain two parts:
\item The handout.
\end{enumerate}
-You have just to split your pdf in two parts to obtain your handout for auditors.
+You have just to split your pdf in two parts to obtain your handout for your audience.
See example~1.
\section{Code to be run at the beginning of the handout}
-You can execute any code at the beginning of the handout by defining a command \cmd{beforehandout}. For example, to suppress extra margins of the \env{quotation} environment:
+You can execute any code at the beginning of the handout by defining a command \cmd{beforehandout}. For example, to suppress the extra margins of the \env{quotation} environment:
\begin{minted}{tex}
\newcommand{\beforehandout}{%
- \renewenvironment{quotation}{}{}
+ \renewenvironment{quotation}{}{}%
}
\end{minted}
See example~2.
-Note that the package always do some action before the handout:
+Note that some actions are always performed before the handout:
\begin{itemize}
\item Start a new page.
\item Reset page and footnote.
\item Disable \cmd{index} and \cmd{label} command.
\end{itemize}
-\section{Putting all the example's files in a same folder}
-In most cases, your file will be put in the same folder. So you can fix this folder with the package's option \opt{dir}:
+\section{Putting all your examples in a single folder}
+
+In most cases, all your external files will be in a single folder. So you can fix this folder with the package's option \opt{dir}:
\begin{minted}{tex}
\usepackage[dir=folder]{handout}
...
@@ -105,7 +105,7 @@ If you want your handout be organized with the same sectioning commands as your
\section{Numbering the examples}
-The package option \opt{numbering} automatically numbers the examples. The example's number is by default printed in margin, in a frame. See example~5.
+The package option \opt{numbering} automatically numbers the examples. Each example's number is by default printed in the margin, in a frame. See example~5.
To customize number's presentation, you can redefine three commands:
\begin{enumerate}
@@ -114,7 +114,7 @@ To customize number's presentation, you can redefine three commands:
\renewcommand{\thehandoutnumber}{\fbox{\arabic{handoutnumber}}}
\end{minted}
See \LaTeX\ documentation on counter's appearance.
- \item \cmd{handoutnumber} to redefine the position of the number. Standard is :
+ \item \cmd{handoutnumber} to redefine the position of the number. Standard is:
\begin{minted}{tex}
\newcommand{\handoutnumber}[1]{\marginpar{#1}}
\end{minted}
@@ -126,24 +126,25 @@ See \LaTeX\ documentation on counter's appearance.
\section{Temporarily disabling the handout generation}
-The package's option \opt{disabled} allows to disable the handout generation.
+The package option \opt{disabled} allows you to disable the handout's generation.
-\label{enablehandout}You can also disable it for only some parts of the text: use \cmd{disablehandout} to disable handout's generation from the current point and \cmd{enablehandout} to enable it from the current point.
+\label{enablehandout}You can also disable it for only some parts of the text: use \cmd{disablehandout} to disable the handout's generation from the current point and \cmd{enablehandout} to enable it from the current point.
-\label{printing} You can also use \opt{printing=false}, which makes \LaTeX\ not printing the handout BUT numbering the examples.
+\label{printing} You can also use \opt{printing=false}, which makes \LaTeX\ number the examples without producing the handout.
\section{Advanced use}
\subsection{Conditional code}
-The argument of a \cmd{onlyhandout} command will be printed only in the handout. Conversely, the argument of a command \cmd{nothandout} will printed only in the main text. See example~6.
+The argument of a \cmd{onlyhandout} command will be printed only in the handout. Conversely, the argument of a command \cmd{nothandout} will be printed only in the main text. See example~6.
\subsection{Insert code in the handout}
-The argument of the \cmd{forhandout} command will be add in the handout, even if called outside a included file.
+The argument of the \cmd{forhandout} command will be added to the handout, even if used outside any included file.
-\emph{Be careful} : if the content of the argument start by a command, this command won't be run before the handout.
+\emph{Be careful}: if the content of the argument starts with a command, this command won't be run before the handout.
+
+The \cmd{forhandout} command is quite complex to manage, but can be useful if you want to insert bibliographic references automatically into your handout. If you use \emph{biblatex} to manage your bibliography, you can define a \cmd{citehandout} command with this code:
-The \cmd{forhandout} command is quite complexe to manage, but can be useful if you want to insert automatically bibliographic reference in your handout. If you use \emph{biblatex} to manage bibliography, you can define a \cmd{citehandout} command this code :
\begin{minted}{tex}
\newcommand{\citehandout}{%
@@ -163,7 +164,8 @@ The \cmd{forhandout} command is quite complexe to manage, but can be useful if y
\newcommand{\afterhandoutref}{\par\vskip0.25\baselineskip}
\end{minted}
-You can call \cmd{citehandout} command before citation commands that you want reference be copied in the handout. See example~7 and the \emph{biblatex} handbook.
+You can call the \cmd{citehandout} command before citation commands when you want the reference to be copied to the handout. See example~7 and the \emph{biblatex} handbook.
+
Note that the citation tracker is automatically reset at the beginning of the handout.
@@ -172,12 +174,12 @@ Note that the citation tracker is automatically reset at the beginning of the ha
\begin{changelog}
\begin{release}{1.2.1}{2015-01-06}
-\item Optimize performances with \opt{sectioning} option.
+\item Optimize performance with \opt{sectioning} option.
\end{release}
\begin{release}{1.2.0}{2015-01-06}
\item Add new option printing. \see{printing}
-\item Optimize performances.
+\item Optimize performance.
\end{release}
\begin{release}{1.1.0}{2014-12-15}
@@ -185,7 +187,7 @@ Note that the citation tracker is automatically reset at the beginning of the ha
\end{release}
\begin{release}{1.0.1}{2014-05-23}
-\item Disable indexing in handout also when using multiple index.
+\item Also disable indexing in the handout when using multiple index.
\end{release}
\begin{release}{1.0.0}{2014-03-20}