Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typos #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions handoutWithNotes.dtx
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
% \changes{1.1}{2021/11/07}{Add PDF documentation}
%
% \providecommand*{\url}{\texttt}
% \providecommand*{\opt}[1]{\texttt{#1}}
% \providecommand*\hook[1]{\texttt{#1}}
% \GetFileInfo{handoutWithNotes.dtx}
% \title{The \textsf{handoutWithNotes} package}
Expand All @@ -96,7 +97,7 @@
% \maketitle
% \begin{documentation}
% \begin{abstract}
% This package provides page layouts based on \pkg{pagepages} to allow users to create printable handouts with note pages for their \pkg{beamer} presentation.
% This package provides page layouts based on \pkg{pgfpages} to allow users to create printable handouts with note pages for their \pkg{beamer} presentation.
%
% It allows to place ruled note pages for handwritten notes or include beamers note pages directly.
% \end{abstract}
Expand All @@ -121,35 +122,35 @@
% To see all available options have a look at the \pkg{pgfpages} part of the pgf manual \cite{pgfpages}.
%
% \section{Package options}
% \pkg{handoutWithNotes} support package options to modify the note boxes.
% \pkg{handoutWithNotes} supports package options to modify the note boxes.
% There are some general options but also others which depend on the setting to use handwritten or beamer notes.
%
% \DescribeOption{slide-frame}
% \DescribeOption{note-frame}
% By default the scaled pages are not framed. Depending on the beamer layout it might be usefull to add a frame around the slides. This can be done by the two booleans options \cs{slide-frame} and \cs{note-frame}.
% By default the scaled pages are not framed. Depending on the beamer layout it might be usefull to add a frame around the slides. This can be done by the two boolean options \opt{slide-frame} and \opt{note-frame}.
%
% \subsection{Handwritten notes}
% By default the note box consists of 8 lines for handwritten notes.
% Beamer notes are ignored.
%
% \DescribeOption{lines} The \cs{lines} option accepts an integer value. It can be zero. The space between the lines will be filled. The size of the box will not change.
% \DescribeOption{lines} The \opt{lines} option accepts an integer value. It can be zero. The space between the lines will be filled. The size of the box will not change.
%
% \changes{1.1}{2021/11/07}{Add support for graph ruled paper}
% \DescribeOption{graph} The \cs{graph} option allows to switch from the ruled boxes to a graph ruled box layout. Here the scaling is done differently, because it might be usefull to select the size of the resulting grid manually. In case a boolean value is used for this opton it will simply switch between ruled and graph ruled paper layouts. The default grid size is 5mm. To change this size \cs{graph} also can accept dimen values like \cs{graph=1cm}. This size will be the resulting size. Conversion and scaling is done automatically.
% \DescribeOption{graph} The \opt{graph} option allows to switch from the ruled boxes to a graph ruled box layout. Here the scaling is done differently, because it might be usefull to select the size of the resulting grid manually. In case a boolean value is used for this opton it will simply switch between ruled and graph ruled paper layouts. The default grid size is 5mm. To change this size \opt{graph} also can accept dimen values like \opt{graph=1cm}. This size will be the resulting size. Conversion and scaling is done automatically.
%
% \DescribeOption{rule} The \cs{rule} option can be used to adjust the thickness of drawing for graph ruled paper. Please pay attention that this value depends on the scaling.
% \DescribeOption{rule} The \opt{rule} option can be used to adjust the thickness of drawing for graph ruled paper. Please pay attention that this value depends on the scaling.
%
% \subsection{Beamer notes}
% \DescribeOption{beamer-notes} The \cs{beamer-notes} option allows to use \pkg{beamer}s note pages directly.
% \DescribeOption{beamer-notes} The \opt{beamer-notes} option allows to use \pkg{beamer}s note pages directly.
% It's a boolean option which uses “true” if no value is given.
% Have a look at the \pkg{beamer} documentation for guidance on how to use it \cite{beameruserguide}.
% The template for these slides will be set to plain automatically to leave as much as space as possible for the notes.
% This option will also set beamers mode to handout to ensure the order of the note pages and the slides will match.
% This option will also set beamer mode to handout to ensure the order of the note pages and the slides will match.
% Scaling will be identical to the content slide.
%
% \section{Customization}
% \subsection{Title}
% The package useds the translator package \cite{translator} (as it's beamer's default) to translate the title of the notes box.
% The package uses the translator package \cite{translator} (as it's beamer's default) to translate the title of the notes box.
% By default \pkg{handoutWithNotes} supports English, German and French.
% Additional languages can be added by using a similar structure.
% \begin{verbatim}
Expand All @@ -160,12 +161,12 @@
%
% \subsection{Hooks}
% \pkg{handoutWithNotes} provides hooks to add \LaTeX-Code to be executed in specific positions while creating the notes box.
% These hooks only are available with the ruled or graph ruled boxes. To modify the layout of the layout of the beamer note pages use beamer templates \cite{beameruserguide}.
% These hooks only are available with the ruled or graph ruled boxes. To modify the layout of the beamer note pages use beamer templates \cite{beameruserguide}.
% The implementation is based on the kernels hook management for details have a look at the corresponding documentation \cite{lthooks-doc}.
%
% \begin{description}
% \item[\hook{handoutWithNotes/notesbox}]
% This hook will be executed at the beginning of each notsbox. One can use it to change color or add font modifications.
% This hook will be executed at the beginning of each note box. One can use it to change color or add font modifications.
% \item[\hook{handoutWithNotes/notesbox/title}]
% This hook will be used right before the title of the notes box is typeset. It's inside a group including only the title. This will (except if global changes are enforced) not affect the box content.
% \item[\hook{handoutWithNotes/notesbox/content}]
Expand All @@ -174,7 +175,7 @@
%
% \section{Layouts provided by this package}
% This section shows scaled drafts of the layouts provided by \pkg{handoutsWithNotes}.
% The illustration is using a4paper a 16:9 aspect ration for the slides and a border shrink of 5mm as described in \ref{sec:quickstart}.
% The illustration is using a4paper a 16:9 aspect ratio for the slides and a border shrink of 5mm as described in \ref{sec:quickstart}.
% \begin{itemize}
% \item 1 on 1 with notes landscape\par\nopagebreak
% \ExplSyntaxOn
Expand Down Expand Up @@ -918,4 +919,4 @@
%</package>
% \fi
%
% \end{implementation}
% \end{implementation}