diff options
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/README | 3 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/examples/lecturebib.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/examples/lectureprogram.tex | 6 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf | bin | 107750 -> 108592 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex | 174 |
5 files changed, 101 insertions, 84 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/README b/Master/texmf-dist/doc/latex/jslectureplanner/README index 3a34df38740..92e5511cf6d 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/README +++ b/Master/texmf-dist/doc/latex/jslectureplanner/README @@ -56,6 +56,9 @@ instructions; also have a look at the example files. == CHANGES == +* V. 0.6b (2014-12-12): Minor corrections in the manual and + example files. + * V. 0.6 (2014-12-12): Initial release to CTAN. diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/examples/lecturebib.tex b/Master/texmf-dist/doc/latex/jslectureplanner/examples/lecturebib.tex index 9f7ed363324..ba5d02cdea2 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/examples/lecturebib.tex +++ b/Master/texmf-dist/doc/latex/jslectureplanner/examples/lecturebib.tex @@ -20,7 +20,7 @@ \input{metadata.tex} -\bibliography{/home/juergen/latex/jsp/jslectureplanner/examples/lectureplanner-examples} +\bibliography{lectureplanner-examples} \usepackage{babel} diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/examples/lectureprogram.tex b/Master/texmf-dist/doc/latex/jslectureplanner/examples/lectureprogram.tex index fbb41d59aaf..cced2b550ea 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/examples/lectureprogram.tex +++ b/Master/texmf-dist/doc/latex/jslectureplanner/examples/lectureprogram.tex @@ -31,9 +31,9 @@ \noindent% \fbox{\begin{minipage}[t][1.3\totalheight][c]{1\columnwidth}% -\begin{labeling}{\textbf{~Sprechstunden:}} -\item [{\textbf{~Sprechstunden:}}] \officehours\setlength\itemsep{0pt} -\item [{\textbf{~Materialien:}}] \lecplatform\end{labeling} +\begin{labeling}{\textbf{Sprechstunden:}} +\item [{\textbf{Sprechstunden:}}] \officehours\setlength\itemsep{0pt} +\item [{\textbf{Materialien:}}] \lecplatform\end{labeling} % \end{minipage}} \end{document} diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf Binary files differindex d14814f3809..dd83890d434 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf +++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex index bde16dedffc..8d3a0399dc5 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex +++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex @@ -5,9 +5,12 @@ \usepackage[T1]{fontenc} \usepackage[latin9]{inputenc} +% markup \newcommand*\jmacro[1]{\textbf{\texttt{#1}}} +\newcommand*\jcsmacro[1]{\jmacro{\textbackslash{#1}}} \newcommand*\joption[1]{\textbf{\texttt{#1}}} \newcommand*\jfmacro[1]{\texttt{#1}} +\newcommand*\jfcsmacro[1]{\jfmacro{\textbackslash{#1}}} \usepackage{babel} \usepackage{listings} @@ -16,16 +19,20 @@ frame=single} \renewcommand{\lstlistingname}{Listing} +\setcounter{tocdepth}{2} + \begin{document} \title{The jslectureplanner package} \author{Jürgen Spitzmüller\thanks{juergen@spitzmueller.org}} -\date{Version 0.6, 2014/12/12} +\date{Version 0.6\,b, 2014/12/12} \maketitle +\tableofcontents + \section{Aim of this package} I have written this package in order to facilitate (and somewhat systematize) @@ -72,8 +79,8 @@ The general idea goes as follows: \item Set up a \emph{metadata.tex} file (or whatever name you prefer) and insert all meta information of the course there (as described in sec.~\ref{sec:course-metadata} and \ref{sec:lecplan}). -\item In your documents, load the package (\jmacro{\textbackslash{}usepackage\{jslectureplanner\}}) -and then input the metadata file (\jmacro{\textbackslash{}input\{metadata.tex\}}). +\item In your documents, load the package (\jcsmacro{usepackage\{jslectureplanner\}}) +and then input the metadata file (\jcsmacro{input\{metadata.tex\}}). \item Then use the macros described below (sec.~\ref{sec:general-course-info} and \ref{sec:session-specific-info}) to retrieve the respective data. \end{itemize} @@ -87,7 +94,7 @@ you load the package in the metadata file; see sec.~\ref{sub:package-options}) or via specific macros (see sec.~\ref{sec:via-macros}). -\subsection{Via package Options\label{sub:package-options}} +\subsection{Via package options\label{sub:package-options}} \subsubsection{Course classification\label{sec:lecture-classification}} @@ -101,8 +108,8 @@ in ``the second \emph{session} of this course''). \item [{type=<type>,}] where \joption{<type>} is one of \begin{itemize} -\item \joption{vl}: a lecture (verbose form: ``Vorlesung''\footnote{Sec.~\ref{sec:customizing-strings} explains how to customize these -strings.}, short form: ``VL'', session form: ``Vorlesung'') +\item \joption{vl}: a lecture (verbose form: ``Vorlesung''\footnote{Sec.~\ref{sec:customizing-strings} +explains how to customize these strings.}, short form: ``VL'', session form: ``Vorlesung'') \item \joption{vo}: also a lecture\footnote{The division of ``vl'' and ``vo'' has historical (personal) reasons.} (verbose form: ``Vorlesung'', short form: ``VO'', session form: ``Vorlesung'') @@ -153,11 +160,14 @@ must} have the form DD/MM/YYYY) \subsection{Via macros\label{sec:via-macros}} +The following macros provide an alternative interface to set up the course metadata described in the previous +subsection. \subsubsection{Course classification} \begin{itemize} -\item \jmacro{\textbackslash{}LecType\{<course type>\}}: Set course type; -\joption{<course type>} is one of\footnote{See above sec.~\ref{sec:lecture-classification} for a detailed description.} +\item \jcsmacro{LecType\{<course type>\}}: Set course type; +\joption{<course type>} is one of\footnote{See above sec.~\ref{sec:lecture-classification} for a detailed +description.} \begin{itemize} \item \joption{vl} @@ -172,18 +182,19 @@ must} have the form DD/MM/YYYY) \subsubsection{Course title} \begin{itemize} -\item \jmacro{\textbackslash{}LecTitle{[}<options>{]}\{<title>\}}: Set +\item \jcsmacro{LecTitle{[}<options>{]}\{<title>\}}: Set course title; \joption{<options>} might be any set of package options described in sec.~\ref{sub:package-options} -\item \jmacro{\textbackslash{}LecTitleSep\{<title separator>\}}: Set course +\item \jcsmacro{LecTitleSep\{<title separator>\}}: Set course title-subtitle separator -\item \jmacro{\textbackslash{}LecSubTitle\{<subtitle>\}}: Set course subtitle +\item \jcsmacro{LecSubTitle\{<subtitle>\}}: Set course subtitle \end{itemize} \subsubsection{Date and place} \begin{itemize} \item \textbackslash{}\jmacro{LecYear\{<term>\}\{<year>\}}, Set term and -year of the course; \joption{<term>} is one of\footnote{See above sec.~\ref{sec:date-and-place} for a detailed description.} +year of the course; \joption{<term>} is one of\footnote{See above sec.~\ref{sec:date-and-place} for a detailed +description.} \begin{itemize} \item \joption{fs} @@ -191,19 +202,19 @@ year of the course; \joption{<term>} is one of\footnote{See above sec.~\ref{sec: \item \joption{ss} \item \joption{ws} \end{itemize} -\item \jmacro{\textbackslash{}LecUni\{<university>\}}: Set the name of +\item \jcsmacro{LecUni\{<university>\}}: Set the name of your university -\item \jmacro{\textbackslash{}LecInstitute\{<institute>\}}: Set your institute +\item \jcsmacro{LecInstitute\{<institute>\}}: Set your institute name -\item \jmacro{\textbackslash{}LecStartDate\{<startdate>\}}: Set date of +\item \jcsmacro{LecStartDate\{<startdate>\}}: Set date of the first session (argument\emph{ must} have the form DD/MM/YYYY) \end{itemize} \subsubsection{Additional information} \begin{itemize} -\item \jmacro{\textbackslash{}SetOfficeHours\{<office hours>\}}: Set date +\item \jcsmacro{SetOfficeHours\{<office hours>\}}: Set date of your office hours -\item \jmacro{\textbackslash{}SetPlatform\{<platform information>\}}: Set +\item \jcsmacro{SetPlatform\{<platform information>\}}: Set information (e.g., URL) of the e-learning platform \end{itemize} @@ -213,7 +224,7 @@ In the metadata file, you can setup a plan for the course by entering session information in chronological order. This is done via the following macro: \begin{itemize} -\item \jmacro{\textbackslash{}NewSession{[}<options>{]}\{Session title\}} +\item \jcsmacro{NewSession{[}<options>{]}\{Session title\}} \joption{<options>} include: @@ -226,11 +237,11 @@ headings etc.) \item \joption{bibsec=<keyword>}: Session keyword for the bibliography (see below sec.~\ref{sub:bibliographies}) \item \joption{cancel=<true|false>}: Whether this session takes place. -If you specify \joption{cancel=false}, the program will mark the +If you specify \joption{cancel=true}, the program will mark the session as ``canceled''. For instance, -\jmacro{\textbackslash{}NewSession{[}cancel=true{]}\{Dies Academicus\}} +\jcsmacro{NewSession{[}cancel=true{]}\{Dies Academicus\}} will output something like @@ -241,7 +252,7 @@ will output something like (i.\,e., ``Dies Academicus -- no session'') \end{itemize} -\item \jmacro{\textbackslash{}SetBreak{[}<span>{]}\{Reason\}}: Add a semester +\item \jcsmacro{SetBreak{[}<span>{]}\{Reason\}}: Add a semester break (e.g., holidays). This increments the counter for one week and outputs in the program @@ -251,7 +262,7 @@ outputs in the program \par\end{center} -E.\,g., \jmacro{\textbackslash{}SetBreak{[}28.05.-{}-3.06.{]}\{Whitsun holidays\}} +E.\,g., \jcsmacro{SetBreak{[}28.05.-{}-3.06.{]}\{Whitsun holidays\}} expands to @@ -259,7 +270,7 @@ expands to \textbf{(28.05.--3.06.: Whitsun holidays)} \par\end{center} -\item \jmacro{\textbackslash{}SetBreaks{[}<options>{]}\{Reason\}}: Add +\item \jcsmacro{SetBreaks{[}<options>{]}\{Reason\}}: Add a semester break (e.g., holidays) that is longer than one week. This increments the counter respectively, and outputs in the program @@ -275,15 +286,15 @@ increments the counter respectively, and outputs in the program the internal counter that is used to calculate the session dates) \item \joption{span=<time span>}: time span (to be output on the program) \end{itemize} -\item \jmacro{\textbackslash{}SetBeamerFrameBreak}: Add a frame break in +\item \jcsmacro{SetBeamerFrameBreak}: Add a frame break in the beamer program at this position. This also increments the frame counter which is used for subsequent program frame titles. Note that you can insert maximally 3 breaks. -\item \jmacro{\textbackslash{}SetBeamerHook\{<code>\}}: Add arbitrary \LaTeX{} +\item \jcsmacro{SetBeamerHook\{<code>\}}: Add arbitrary \LaTeX{} code to the beamer program -\item \jmacro{\textbackslash{}begin\{SessionBlock\}\{<Block title>\}}\\ +\item \jcsmacro{begin\{SessionBlock\}\{<Block title>\}}\\ \ldots{} \\ -\jmacro{\textbackslash{}end\{SessionBlock\}}:\\ +\jcsmacro{end\{SessionBlock\}}:\\ Thematic block consisting of several sessions. Respective sessions are nested inside this block. \end{itemize} @@ -299,41 +310,41 @@ information by means the following macros. The following macros output general course-specific information: \begin{itemize} -\item \jmacro{\textbackslash{}lectype}: Outputs the course type in short +\item \jcsmacro{lectype}: Outputs the course type in short form (e.\,g., ``SE'') -\item \jmacro{\textbackslash{}lectypeverb}: Outputs the course type in +\item \jcsmacro{lectypeverb}: Outputs the course type in verbose form (e.\,g., ``Seminar'') -\item \jmacro{\textbackslash{}lectypesession}: Outputs the appropriate +\item \jcsmacro{lectypesession}: Outputs the appropriate ``session'' string (e.\,g., ``Vorlesung'' or ``Sitzung'') -\item \jmacro{\textbackslash{}lectitle}: Outputs the main title of the +\item \jcsmacro{lectitle}: Outputs the main title of the course -\item \jmacro{\textbackslash{}lectitlesep}: Outputs the separator between +\item \jcsmacro{lectitlesep}: Outputs the separator between title and subtitle -\item \jmacro{\textbackslash{}lecsubtitle}: Outputs the subtitle of the +\item \jcsmacro{lecsubtitle}: Outputs the subtitle of the course -\item \jmacro{\textbackslash{}lecfulltitle}: Outputs the full title of +\item \jcsmacro{lecfulltitle}: Outputs the full title of the course (title, separator, subtitle) -\item \jmacro{\textbackslash{}lecshorttitle}: Outputs the short version +\item \jcsmacro{lecshorttitle}: Outputs the short version of the course title -\item \jmacro{\textbackslash{}lecsemshort}: Outputs the short version of +\item \jcsmacro{lecsemshort}: Outputs the short version of the term type (e.\,g., ``WS'') -\item \jmacro{\textbackslash{}lecsemverb}: Outputs the verbose version +\item \jcsmacro{lecsemverb}: Outputs the verbose version of the term type (e.\,g., ``Wintersemester'') -\item \jmacro{\textbackslash{}lecyear}: Outputs the year -\item \jmacro{\textbackslash{}lecsemester}: Outputs the short version of +\item \jcsmacro{lecyear}: Outputs the year +\item \jcsmacro{lecsemester}: Outputs the short version of the semester (e.\,g., ``WS 2014'') -\item \jmacro{\textbackslash{}lecsemesterverb}: Outputs the verbose version +\item \jcsmacro{lecsemesterverb}: Outputs the verbose version of the semester (e.\,g., ``Wintersemester 2014'') -\item \jmacro{\textbackslash{}lecuniversity}: Outputs the university name -\item \jmacro{\textbackslash{}lecinstitute}: Outputs the institute name -\item \jmacro{\textbackslash{}lecplatform}: Outputs information on the +\item \jcsmacro{lecuniversity}: Outputs the university name +\item \jcsmacro{lecinstitute}: Outputs the institute name +\item \jcsmacro{lecplatform}: Outputs information on the e-learning platform -\item \jmacro{\textbackslash{}officehours}: Outputs the office hours +\item \jcsmacro{officehours}: Outputs the office hours \end{itemize} \subsection{Generating lecture programs} \begin{itemize} -\item \jmacro{\textbackslash{}makeprogram}: Generates a lecture program +\item \jcsmacro{makeprogram}: Generates a lecture program from the metadata in the form @@ -352,7 +363,7 @@ from the metadata in the form The \jmacro{labeling} environment is defined by the KOMA classes. The package provides a fallback, however, if another class is used. -\item \jmacro{\textbackslash{}makebeamerprogram{[}<options>{]}}: Generates +\item \jcsmacro{makebeamerprogram{[}<options>{]}}: Generates a beamer-suited lecture program from the metadata in the form @@ -378,7 +389,7 @@ a beamer-suited lecture program from the metadata in the form \end{itemize} Note that multiple subsequent frames are generated if the metadata -file contains \jmacro{\textbackslash{}SetBeamerFrameBreak} macros. +file contains \jcsmacro{SetBeamerFrameBreak} macros. Also note that you can refer to the frames via the automatically generated labels \emph{beamerprogram} (for the first frame), \emph{beamerprogram2} for the second, etc. Finally note that the number of program frames @@ -392,7 +403,7 @@ your program structure. The package provides macros for easy generation of sectioned bibliographies via \textsf{biblatex}. The macro \begin{itemize} -\item \jmacro{\textbackslash{}makesessionbib} +\item \jcsmacro{makesessionbib} \end{itemize} generates code in the form @@ -417,46 +428,46 @@ to the current session. This is done as follows. \subsection{Setting the current session} -Use \jmacro{\textbackslash{}ThisSession\{<nr>\}} to tell the package +Use \jcsmacro{ThisSession\{<nr>\}} to tell the package which session is current. \joption{<nr>} is an integer value, e.g. -\jmacro{\textbackslash{}ThisSession\{3\}} for the 3rd session of +\jcsmacro{ThisSession\{3\}} for the 3rd session of the lecture. \subsection{Generating session-specific information for the current session} -If you have specified the current session via the macro \jmacro{\textbackslash{}ThisSession}, +If you have specified the current session via the macro \jcsmacro{ThisSession}, the following macros output general session-specific information: \begin{itemize} -\item \jmacro{\textbackslash{}sesdate}: Date of the current session -\item \jmacro{\textbackslash{}sesshortdate}: Date of the current session, +\item \jcsmacro{sesdate}: Date of the current session +\item \jcsmacro{sesshortdate}: Date of the current session, short form (no year) -\item \jmacro{\textbackslash{}sestitle}: Main title of the current session -\item \jmacro{\textbackslash{}sestitlesep}: Title-subtitle separator of +\item \jcsmacro{sestitle}: Main title of the current session +\item \jcsmacro{sestitlesep}: Title-subtitle separator of the current session -\item \jmacro{\textbackslash{}sessubtitle}: Subtitle of the current session -\item \jmacro{\textbackslash{}sesfulltitle}: Full title of the current +\item \jcsmacro{sessubtitle}: Subtitle of the current session +\item \jcsmacro{sesfulltitle}: Full title of the current session (title, separator, subtitle) -\item \jmacro{\textbackslash{}sesnr}: Number of the current session +\item \jcsmacro{sesnr}: Number of the current session \end{itemize} \subsection{Generating session-specific information for an arbitrary session} -Independent of the value of \jmacro{\textbackslash{}ThisSession}, +Independent of the value of \jcsmacro{ThisSession}, you can retrieve the following information for arbitrary sessions (session number \joption{<nr>}) via the following macros: \begin{itemize} -\item \jmacro{\textbackslash{}SessionTitle\{<nr>\}}: Outputs the main title +\item \jcsmacro{SessionTitle\{<nr>\}}: Outputs the main title of session number \joption{<nr>} -\item \jmacro{\textbackslash{}SessionFullTitle\{<nr>\}}: Outputs the full +\item \jcsmacro{SessionFullTitle\{<nr>\}}: Outputs the full title (main title, separator, subtitle) of session number \joption{<nr>} -\item \jmacro{\textbackslash{}SessionShortTitle\{<nr>\}}: Outputs the short +\item \jcsmacro{SessionShortTitle\{<nr>\}}: Outputs the short title of session number \joption{<nr>} -\item \jmacro{\textbackslash{}SessionDate\{<nr>\}}: Outputs the date of +\item \jcsmacro{SessionDate\{<nr>\}}: Outputs the date of session number \joption{<nr>} -\item \jmacro{\textbackslash{}SessionShortDate\{<nr>\}}: Outputs the short +\item \jcsmacro{SessionShortDate\{<nr>\}}: Outputs the short date (no year) of session number \joption{<nr>} -\item \jmacro{\textbackslash{}MakeProgramline\{<nr>\}}: Outputs a list +\item \jcsmacro{MakeProgramline\{<nr>\}}: Outputs a list item line for session number \joption{<nr>} in the form @@ -474,17 +485,17 @@ item line for session number \joption{<nr>} in the form The strings of the course types can be changed via the macros: \begin{itemize} -\item \jmacro{\textbackslash{}DefTypeVL\{<short form>\}\{<title>\}\{<session title>\}} -\item \jmacro{\textbackslash{}DefTypeVO\{<short form>\}\{<title>\}\{<session title>\}} -\item \jmacro{\textbackslash{}DefTypePS\{<short form>\}\{<title>\}\{<session title>\}} -\item \jmacro{\textbackslash{}DefTypeSE\{<short form>\}\{<title>\}\{<session title>\}} -\item \jmacro{\textbackslash{}DefTypeUE\{<short form>\}\{<title>\}\{<session title>\}} -\item \jmacro{\textbackslash{}DefTypeKO\{<short form>\}\{<title>\}\{<session title>\}} -\item \jmacro{\textbackslash{}DefTypePV\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypeVL\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypeVO\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypePS\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypeSE\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypeUE\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypeKO\{<short form>\}\{<title>\}\{<session title>\}} +\item \jcsmacro{DefTypePV\{<short form>\}\{<title>\}\{<session title>\}} \end{itemize} An English form for a lecture, thus, can be achieved by e.\,g. \begin{itemize} -\item \jmacro{\textbackslash{}DefTypeVL\{LEC\}\{Lecture\}\{Session\}} +\item \jcsmacro{DefTypeVL\{LEC\}\{Lecture\}\{Session\}} \end{itemize} The types themselves are hardcoded. If you need further\slash{}other types, you need to modify the package. @@ -494,16 +505,16 @@ types, you need to modify the package. The strings of the term types can be changed via the macros: \begin{itemize} -\item \jmacro{\textbackslash{}DefTypeFS\{<short form>\}\{<verbose form>\}} -\item \jmacro{\textbackslash{}DefTypeHS\{<short form>\}\{<verbose form>\}} -\item \jmacro{\textbackslash{}DefTypeSS\{<short form>\}\{<verbose form>\}} -\item \jmacro{\textbackslash{}DefTypeWS\{<short form>\}\{<verbose form>\}} +\item \jcsmacro{DefTypeFS\{<short form>\}\{<verbose form>\}} +\item \jcsmacro{DefTypeHS\{<short form>\}\{<verbose form>\}} +\item \jcsmacro{DefTypeSS\{<short form>\}\{<verbose form>\}} +\item \jcsmacro{DefTypeWS\{<short form>\}\{<verbose form>\}} \end{itemize} \subsection{Customizing the date format} -If you need to change the date format, redefine the macros \jmacro{\textbackslash{}lecdateformat} -(for the long format) and \jmacro{\textbackslash{}lecdateshortformat} +If you need to change the date format, redefine the macros \jcsmacro{lecdateformat} +(for the long format) and \jcsmacro{lecdateshortformat} (for the short format), using the syntax provided by the \textsf{datetime} package. By default, the two formats are defined as follows: @@ -549,7 +560,10 @@ those. \section{History} + \begin{itemize} -\item 2012/12/12 (v. 0.6): Initial release to CTAN.\end{itemize} +\item 2012/12/12 (v. 0.6\,b): Minor corrections in the manual and example files. +\item 2012/12/12 (v. 0.6): Initial release to CTAN. +\end{itemize} \end{document} |