LaTeX-lecture-notes-class

A LaTeX document class for lecture notes (for a seminar, for an entire course with several lectures, or for brief talks) that looks great and works even with basic pdflatex.

View the Project on GitHub

LaTeX class for lecture notes

Open Source Love Open Source Love

forthebadge

Author: V.H. Belvadi

Webpage: http://vhbelvadi.com/latex-lecture-notes-class/

Current release: v2.3

Description: A LaTeX document class built for lecture notes for classes/seminars, entire courses or brief talks. A detailed article about this class can be found on the author’s website. The same data condensed into brief notes about working with this class, for those who are familiar with this sort of thing, can be found below.

Download: To work with this class the absolute minimum requirements are the .cls and .sty files, but this repository has several other files too. The easiest approach is to download the latest release and manually extract the two required files. Alternately, you can use svn or git sparse checkouts.

Installing the class

Simply drop the .cls and .sty files into your LaTeX document tree. On UNIX systems this is usually ~/texmf/ and is C:\Users\user_name\texmf\ on Windows.

Although not necessary, it is highly recommended that you place these files inside their own folder with the tree .../texmf/tex/latex/folder_name for better package management.

MikTex does things differently: C:\Users\user_name\Appdata\Local\MikTex\###\tex\latex\local\. On a Mac navigate to ~/Library/texmf/ using the option key once you are in the Go menu on any Finder window.

There are several resources online that can help you in greater detail when it comes to installing .cls and .sty files. Once you figure out where they should be placed in your TEXMFHOME tree, just make sure the two files reside together in the same folder.

Working with the class

Your documents based on this lecture class must adhere to the following blueprint:

\documentclass[options]{lecture}

\title{}
\subtitle{}
\shorttitle{}
\ccode{}
\subject{}
\speaker{}
\spemail{}
\author{}
\email{}
\flag{}
\season{}
\date{}{}{}
\dateend{}{}{}
\conference{}
\place{}
\attn{}
\morelink{}

\begin{document}
\end{document}

Overview

The document class lecture calls this class file. Options for the class are as outlined below.

Only setting a title is compulsory. All other data (e.g. subtitle, course code, speaker, dates, seasons, author etc. are optional.) Some of these are used to set up the head of your document (e.g. season), headers of your pages (e.g. short title) and pdf attributes (e.g. subject data is only for the pdf metadata).

Take a look at the Sample.tex file for an example of how these lines are used in a source file and for details of exactly what each command does. Also look at the Sample.pdf output file to see how (great) things will look in the end.

NB Not all commands are shown in the sample files though most are.

NB The season command and the dates (single date or start and end dates) are mutually exclusive with the season taking precedence. You can set either Summer 2017 (season) or 24th June, 2017 (single date) or 24th June 2017–25th June 2017 (start and end dates).

Options

Compulsory

The following are primary options that must compulsorily be included. Pick one from each set below:

  1. The language of your document:
    • english
    • french
    • italian (see acknowledgements and the road ahead)
    • usenglish (same as english except for the mm/dd/yyyy format)
  2. The type of your lecture notes:
    • seminar usually for single class/session/seminar/lecture period
    • course for a collection of lectures (over a semester or over a few days)
    • talk for brief notes for speakers (or any other use you can think of for condensed, two-column layouts)

NB Please delete all aux files and then compile if you decide to change languages halfway through. Compile twice to update TOC in case of course type documents.

Optional

You can also include secondary options for your document. Again, pick one from each set below:

  1. Customise page headers as needed (default: current/next sections and subsections):
    • headertitle to display the main title/short alternative title
    • headersection to display the current/next section as appropriate
    • headersubsection to display the current/next subsection as appropriate
    • headerno for a blank header (footers still display page numbers)
  2. Customise theorem numbering as needed:
    • theoremnosection
    • theoremsection
    • theoremsubsection
  3. Choose if you want to start every new section on a new page/new right-hand page:
    • cleardoublepage
    • nocleardoublepage
  4. Optimise your document for printing:
    • oneside
    • twoside
  5. Choose between one- and two-column layouts:
    • onecolumn
    • twocolumn

Commands

There are some additional commands you can use inside your document, i.e. within \begin{document} and \end{document}, besides those which are already part of the blueprint given above:

  1. \lecture[duration]{dd}{mm}{yyyy} for use in course type documents for providing information about lectures in the margin
  2. \separator for use in talk type documents to draw a visually helpful horizontal separator line
  3. \tosay{message} for use in talk type documents to print messages inside a box to help recall important data
  4. \margintext{message} to make useful notes in the margin
  5. \\ at the start of a paragraph to give it a line break and remove any indentation
  6. \nl at the start of a paragraph without either a line break or an indent (note the space following the command)
  7. \runin{} as a handy approach to print texts in small caps (especially useful to start new sections/chapters/parts of a document)
  8. \morelink{} to add a For more visit _______. link in the footer of the first page.

Dependencies

hyperref       mathtools       csquotes       microtype       amsmath       booktabs       multirow       kpfonts       fancyhdr       mparhack       tikz       mathdots       xfrac       faktor       cancel       babel

Version history

(Besides any bug fixes)

2.3

2.2

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur porttitor et lectus.

\\Nam orci leo, tincidunt id convallis eu, luctus id nisi...

2.1

2.0

1.2

1.1

1.0

The road ahead

Contributions

  1. Translations are welcome and appreciated.
  2. General suggestions for improvement are welcome as well.

Either fork this project and submit a pull request or, only in case of translations, drop me an e-mail with the relavant translations and specify how you wish to be credited.

Known errors

  1. Not specifying a custom page header results in ugly defaults.
  2. Using the `headerno` option messes up page header text dimensions.
  3. Flag text, speaker's name and e-mail are *not* optional (yikes).

Improvements/roadmap

  1. The `headerno` and a couple of other options with minor errors will be corrected over time.
  2. Not having a speaker, i.e. if the author == speaker, there is no need to mention '(scribe)' in the footer.
  3. A .gitignore will be added at some point just to make it simpler to clone this repo.
  4. An option system that lets users specify if they prefer to use various packages regardless of pdfTeX support and then loads certain packages accordingly.
  5. Errors that crop up from time to time will be set right (since I use this class myself to teach at University) and this will go on so long as I keep using it.
  6. Package dependencies will not reduce. This type of collaboration is what LaTeX packages are for and they’re free. When (and if) some package drops support we can think of bridging the code.

End notes

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Acknowledgments

Thanks to Stefano Maggiolo for initially helping me kickstart this and for his Italian translations.

See the release article for more.