1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
\documentclass[11pt,svgnames]{article}
\usepackage[notelinecolor=MidnightBlue,notemargin=.75in]{notebeamer}
\usepackage{indentfirst,titlesec,authblk,hyperref,hologo,pgfpages,lipsum}
\geometry{margin=1in}
\titleformat*{\section}{\bfseries\large}
\titleformat*{\subsection}{\bfseries\normalsize}
\hologoFontSetup{general=\sffamily}
\usepackage{datetime}\yyyymmdddate
\usepackage[libertine,mono=false]{newtx}
\usepackage{listings}
\lstset{language=[LaTeX]TeX,basicstyle=\ttfamily,breaklines=true,columns=flexible}
\hypersetup{colorlinks,urlcolor=MidnightBlue}
\def\pkg#1{\textcolor{DarkGreen}{\textsf{#1}}}
\def\mode#1{\textcolor{Indigo}{\textsf{#1}}}
\def\cmd#1{\textcolor{MidnightBlue}{\texttt{\string#1}}}
\title{\bfseries The \pkg{notebeamer} Package}
\author{Mingyu Hsia, \href{mailto:xiamyphys@hdu.edu.cn}{\ttfamily xiamyphys@hdu.edu.cn}}
\affil{Hangzhou Dianzi University}
\date{\today\quad Version 3.0b\thanks{\url{https://github.com/xiamyphys/notebeamer}}}
\begin{document}
\maketitle
\begin{abstract}
This is the document for the \pkg{notebeamer} package, which provides an easy way to input slides on notepages quickly for making annotations.
Welcome to feedback bugs or ideas via email \href{mailto:xiamyphys@hdu.edu.cn}{\ttfamily xiamyphys@hdu.edu.cn} or \href{https://github.com/xiamyphys/notebeamer}{GitHub}.
\end{abstract}
\section{Installing \pkg{notebeamer} and loading it}
Simply download \verb|notebeamer.cls| file from \href{https://github.com/xiamyphys/notebeamer}{GitHub} or \href{https://ctan.org/pkg/notebeamer}{CTAN} and save it under your working directory. However, I strongly suggest to use terminal to install and update all packages to the latest version
\begin{verbatim}
sudo tlmgr update --self --all
\end{verbatim}
To learn more, please refer to \href{https://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \hologo{TeX} distribution?}
\section{Key values of this package}
\begin{verbatim}
\usepackage[notelinecolor=<color>,notemargin=<margin>]{notebeamer}
\end{verbatim}
This package has two keys: \cmd{notelinecolor} and \cmd{notemargin}.
The \cmd{notelinecolor} key can set the color notelines, the \cmd{notemargin} key can set the margin of notepages.
If you have not set the keys, the default values of the four keys will be applied
\begin{verbatim}
notelinecolor=MidnightBlue, notemargin=.75in
\end{verbatim}
Please set the geometry for the whole document \textbf{after} you set the notemargin, that is
\begin{verbatim}
\usepackage[notemargin=<margin>]{notebeamer} \geometry{<keyval list>}
\end{verbatim}
otherwise the notemargin configuration won't work.
\section{The margin of notepages}
The relation of the margin of notepages and the margin configuration of package \pkg{geometry} satisfies the following expression
\begin{verbatim}
topmargin = bottommargin = (\paperwidth-\textwidth)/3
leftmargin = rightmargin = (2\paperheight-2\textheight)/5
\end{verbatim}
\section{Commands of \pkg{notebeamer}}
\subsection{The \cmd{notechap} command}
\begin{verbatim}
\notechap [<notetitle>] {<filename>}
\end{verbatim}
This command can assign the following notetitle and the PDF file you want to input.
\subsection{The \cmd{notelinenum} and \cmd{notecolumnratio} commands}
\begin{verbatim}
\notelinenum{<number>} \notecolumnratio{<number>}
\end{verbatim}
The two commands can assign the number of notelines and the ratio of columns on following notepages respectively. The default value of the number of notelines is \verb|27| and that of the ratio of columns is \verb|0.5|.
\subsection{The \cmd{hidenotelinetrue} and \cmd{hidenotelinefalse} commands}
Notepages after the \cmd{hidenotelinetrue} command the notelines will be hidden while notepages after command \cmd{hidenotelinefalse} the notelines will be restored.
\subsection{The \cmd{newnotepage}}
\begin{verbatim}
\newnotepage[<number>] \newnotepage*[<number>]
\end{verbatim}
The \cmd{newnotepage} command can create empty notepage(s). If a star (*) is added after the command, the created empty notepage(s) won't have column rule.
\subsection{The \cmd{includebeamer} command}
\begin{verbatim}
\includebeamer[<number of slides per page>]{<start page>}{<end page>}
\end{verbatim}
This commands will create notepages that were inserted images on the left sidnumber of slides per page and the last two variables can set the start page and end page of the PDF file you want to insert that assigned by the command \cmd{notechap}.
\appendix
\section{Related packages}
\subsection{The \pkg{fadingimage} package}
This package provides macros for inputting full width picture at the edges of pages quickly.
\subsection{The \pkg{litesolution} class}
This class is designed for typesetting solutions of problems in exams, textbooks, etc. The \pkg{notebeamer} package is contained in the \pkg{litesolution} class now.
\clearpage
\pgfpagesuselayout{4 on 1}[letterpaper]
\notelinenum{27}\pagecolor{yellow!2}
\notechap[Chapter 1. Introduction \& Fundamental Concepts]{figures/beamerdemo.pdf}
\notecolumnratio{.57}
\hidenotelinefalse \includebeamer[3]{2}{4}
\notecolumnratio{.43}
\hidenotelinetrue \includebeamer[4]{3}{6}
\notechap[Phys. Rev. B. Volume 50, Number 8]{figures/paperdemo.pdf}
\notecolumnratio{.72}
\hidenotelinefalse \includebeamer[1]{2}{2}
\notecolumnratio{.5} \newnotepage
\end{document}
|
