diff options
Diffstat (limited to 'macros/latex/contrib/pdfpc')
-rw-r--r-- | macros/latex/contrib/pdfpc/pdfpc-doc.pdf (renamed from macros/latex/contrib/pdfpc/pdfpc.pdf) | bin | 170447 -> 172285 bytes | |||
-rw-r--r-- | macros/latex/contrib/pdfpc/pdfpc-doc.tex | 140 | ||||
-rw-r--r-- | macros/latex/contrib/pdfpc/pdfpc.ins | 38 | ||||
-rw-r--r-- | macros/latex/contrib/pdfpc/pdfpc.sty (renamed from macros/latex/contrib/pdfpc/pdfpc.dtx) | 48 |
4 files changed, 150 insertions, 76 deletions
diff --git a/macros/latex/contrib/pdfpc/pdfpc.pdf b/macros/latex/contrib/pdfpc/pdfpc-doc.pdf Binary files differindex 275a168ac1..9929c83f28 100644 --- a/macros/latex/contrib/pdfpc/pdfpc.pdf +++ b/macros/latex/contrib/pdfpc/pdfpc-doc.pdf diff --git a/macros/latex/contrib/pdfpc/pdfpc-doc.tex b/macros/latex/contrib/pdfpc/pdfpc-doc.tex new file mode 100644 index 0000000000..3130ff0e80 --- /dev/null +++ b/macros/latex/contrib/pdfpc/pdfpc-doc.tex @@ -0,0 +1,140 @@ +% This file is part of pdfpc. +% Copyright (C) 2020 Evgeny Stambulchik +% +% This program is free software; you can redistribute it and/or modify +% it under the terms of the GNU General Public License as published by +% the Free Software Foundation; either version 3 of the License, or +% (at your option) any later version. +% +% This program is distributed in the hope that it will be useful, +% but WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +% GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along +% with this program; if not, write to the Free Software Foundation, Inc., +% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +% ------------------------------------------------------------------------------------------- +% +% Allow for defining some meta data and simple textual notes for use +% with the pdfpc presentation application <https://pdfpc.github.io>. +% +% ------------------------------------------------------------------------------------------- +% +% Inspired by Carsten Brandt's <https://github.com/cebe/pdfpc-latex-notes>. +% +% ------------------------------------------------------------------------------------------- +% +% Please report bugs and other problems as well as suggestions for improvements +% to the issue tracker at github <https://github.com/pdfpc/pdfpc/> +% +% ------------------------------------------------------------------------------------------- +\documentclass[11pt]{ltxdoc} + +\usepackage{iftex} + +\usepackage[english]{babel} + +\usepackage{hyperref} + +\newcommand*{\sty}[1]{\textsf{#1}} +\def\param#1{\textit{\rmfamily\mdseries\ensuremath{\langle}#1\ensuremath{\rangle}}} + + +\title{The \sty{pdfpc} package \\ {\large\url{https://github.com/pdfpc/pdfpc}}} +\author{Evgeny Stambulchik} +\date{2020/06/10 (v0.4.0)} + +\hypersetup{pdftitle={The pdfpc package}, pdfauthor={Evgeny Stambulchik}} + +\begin{document} +\maketitle +\thispagestyle{empty} + +\begin{abstract} +This package provides a convenient way to specify notes and to define certain +meta properties of the presentation when used with +\href{https://pdfpc.github.io/}{PDF Presenter Console (\texttt{pdfpc}), a +GPLv2+ licensed multi-monitor PDF presentation viewer application available on +GitHub}\footnote{\url{https://pdfpc.github.io/}}. +\end{abstract} + +\clearpage +\section*{Dependencies and other requirements} + +\sty{pdfpc} requires the use of \LaTeXe. + +It depends on the following packages: + +\begin{multicols}{4}\sffamily\centering +kvoptions \\ xstring \\ pdfcomment \\ hyperxmp +\end{multicols} + +\section*{License} + +\textcopyright\ 2020 Evgeny Stambulchik + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +This work consists of the following files: + +\begin{itemize} + \item "pdfpc.sty", + \item "pdfpc-doc.tex" + \item "pdfpc-doc.pdf" \emph{(compiled)} +\end{itemize} + +\clearpage + +\part{The documentation} +\section*{Loading \sty{pdfpc}} + +Load \sty{pdfpc} by adding \cmd{\usepackage\{pdfpc\}} to your preamble. + +The following \param{options} may be given as comma-separated list: + +\begin{itemize} +\item \texttt{duration} +\item \texttt{starttime} +\item \texttt{endtime} +\item \texttt{enduserslide} +\item \texttt{lastminutes} +\item \texttt{hidenotes} +\item \texttt{overridenote} +\item \texttt{defaulttransition} (needs pdfpc v4.5 or higher) +\end{itemize} + +The meaning and possible values of most of these options are documented in +\textit{pdfpcrc(5)} man page of the pdfpc program. The rest are explained below. + +To add a note to a slide (must not be longer than one paragraph): + +{\leftskip2.5em% +\cmd{\pdfpcnote\{Text of a note\}} +}\par + +The pdfpc package can be used standalone or together with beamer. In +the later case, it may be desirable to continue using the \cmd{\note} +command. To this end, the \texttt{overridenote} option should be provided. +Please note though, that this will work only in simple cases. + +If you prefer using full-featured beamer notes rendered alongside the +presentation (\cmd{\setbeameroption\{show notes on second screen\}}), the pdfpc +package will autodetect it, so using the \texttt{--notes} command-line option is +unnecessary. To override the autodetection, use the \texttt{notesposition} +option, accepting the same values (right/left/top/bottom/none). + +When sharing slides, one may want to omit the (private) notes, by using the +\texttt{hidenotes} option. Enabling it together with \texttt{overridenote} will +disable the beamer notes as well. + +\StopEventually{% + \clearpage + \PrintChanges} +\clearpage + +\Finale +\end{document} diff --git a/macros/latex/contrib/pdfpc/pdfpc.ins b/macros/latex/contrib/pdfpc/pdfpc.ins deleted file mode 100644 index 905306c93e..0000000000 --- a/macros/latex/contrib/pdfpc/pdfpc.ins +++ /dev/null @@ -1,38 +0,0 @@ -\input docstrip - -\preamble - pdfpc.dtx - Copyright (C) 2020 Evgeny Stambulchik - - This file is part of pdfpc. - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - - This work consists of the files pdfpc.dtx, pdfpc.ins, and the derived file - pdfpc.sty - -\endpreamble - -\askforoverwritefalse - -\generate -{% - \file{pdfpc.sty}{% - \usepreamble\defaultpreamble - \usepostamble\defaultpostamble - \from{pdfpc.dtx}{pdfpc.sty,package}% - }% -} -\endbatchfile diff --git a/macros/latex/contrib/pdfpc/pdfpc.dtx b/macros/latex/contrib/pdfpc/pdfpc.sty index ad5430f324..8a7c357063 100644 --- a/macros/latex/contrib/pdfpc/pdfpc.dtx +++ b/macros/latex/contrib/pdfpc/pdfpc.sty @@ -1,25 +1,3 @@ -%\iffalse -%<*package> -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} -%</package> -%\fi -%\iffalse -% Doc-Source file to use with LaTeX2e -% % This file is part of pdfpc. % Copyright (C) 2020 Evgeny Stambulchik % @@ -51,21 +29,15 @@ % to the issue tracker at github <https://github.com/pdfpc/pdfpc/> % % ------------------------------------------------------------------------------------------- -%\fi % -% Identify the package and force \LaTeXe: -% \begin{macrocode} -\ProvidesPackage{pdfpc}[2019/12/03 v0.2.1 PDFPC] +\ProvidesPackage{pdfpc}[2020/06/10 v0.4.0 PDFPC] \NeedsTeXFormat{LaTeX2e} -% \end{macrocode} % % Require additional packages needed by \sty{pdfpc}: -% \begin{macrocode} \RequirePackage{kvoptions} \RequirePackage{xstring} \RequirePackage{pdfcomment} \RequirePackage{hyperxmp} -% \end{macrocode} % \SetupKeyvalOptions{ family=PDFPC, @@ -77,8 +49,10 @@ \DeclareStringOption{endtime} \DeclareStringOption{enduserslide} \DeclareStringOption{lastminutes} +\DeclareBoolOption{hidenotes} \DeclareBoolOption{overridenote} \DeclareStringOption{notesposition} +\DeclareStringOption{defaulttransition} \DeclareDefaultOption{\@unknownoptionerror} % \ProcessKeyvalOptions* @@ -116,7 +90,6 @@ \fi% % % Guesswork for beamer/pgfpages notes -% \begin{macrocode} \ifx\PDFPC@notesposition\pdfpc@notespositionauto% \def\PDFPC@notesposition{none}% \def\pdfpc@onepaperheight{\paperheight}% @@ -144,10 +117,8 @@ \fi% \fi% \fi% -% \end{macrocode} % % Our schema -% \begin{macrocode} \newcommand*{\pdfpc@schema}{% \hyxmp@add@to@xml{% ______<rdf:Description xmlns:pdfpc="https://github.com/pdfpc/pdfpc">^^J% @@ -158,20 +129,21 @@ ______<rdf:Description xmlns:pdfpc="https://github.com/pdfpc/pdfpc">^^J% \hyxmp@add@simple{pdfpc:EndUserSlide}{\PDFPC@enduserslide}% \hyxmp@add@simple{pdfpc:LastMinutes}{\PDFPC@lastminutes}% \hyxmp@add@simple{pdfpc:NotesPosition}{\PDFPC@notesposition}% + \hyxmp@add@simple{pdfpc:DefaultTransition}{\PDFPC@defaulttransition}% \hyxmp@add@to@xml{% ______</rdf:Description>^^J% }% } % % Piggybacking on the hyperxmp schema... -% \begin{macrocode} \let\oldhyxmp@pdf@schema\hyxmp@pdf@schema \renewcommand{\hyxmp@pdf@schema}{{\oldhyxmp@pdf@schema}{\pdfpc@schema}} -% \end{macrocode} - +% % Note command -% \begin{macrocode} -\newcommand{\pdfpcnote}[1]{\pdfmargincomment{#1}} -% \end{macrocode} +\ifPDFPC@hidenotes% + \newcommand{\pdfpcnote}[1]{} +\else% + \newcommand{\pdfpcnote}[1]{\pdfmargincomment{#1}} +\fi% % \endinput |