Skip to content

profound-labs/wallcalendar

Repository files navigation

Wallcalendar LaTeX documentclass

A wall calendar class with custom layouts and support for internationalization.

Table of Contents

Features

The documentclass comes with the following layouts:

  • Full page photo, the calendar days overlaid with opacity
  • Full page photo, the photo above the calendar days
  • Small landscape photo, with a calendar grid
  • Photo and Notes, photo and calendar on separate pages to allow space for note taking
  • Title page
  • Year planner
  • Thumbnails and captions
  • Varnish mask

There is also support for loading event marks from a CSV file.

See wallcalendar.pdf for the user manual.

The manual includes examples and tutorials, but you may also want to see the doc/examples folder on Github.

Examples

Files are in the doc/examples folder.

Load custom event footnotes from CSV

cal-marks.tex | cal-marks.pdf

cal-marks

Portrait page

cal-plain.tex | cal-plain.pdf

Full page photo, calendar days overlaid with opacity

cal-plain-01

Full page photo, photo above the calendar days

cal-plain-02

Small landscape photo, with a calendar grid

cal-plain-03

Thumbnails and captions page

cal-thumbnails.tex | cal-thumbnails.pdf

cal-thumbnails

Sunday-first week layout

The sundayFirst class option shifts the week to start on Sunday instead of Monday. All layouts respect this option.

cal-photo-and-notes-sunday.tex | cal-photo-and-notes-sunday.pdf

cal-photo-and-notes-sunday

Landscape photo and notes on two pages

cal-photo-and-notes.tex | cal-photo-and-notes.pdf

cal-photo-and-notes-titlepage

cal-photo-and-notes-photo

cal-photo-and-notes-calendar

No photos, with notes area

cal-no-photos.tex | cal-no-photos.pdf

cal-no-photos-01

Year planners

Portrait year planner

cal-year-planner.tex | cal-year-planner.pdf

cal-year-planner

Landscape year planner with dates in rows

cal-year-planner-rows.tex | cal-year-planner-rows.pdf

cal-year-planner-rows

Landscape year planner with grid

cal-year-planner-grid.tex | cal-year-planner-grid.pdf

cal-year-planner-grid

Compact year planner

cal-year-planner-compact.tex | cal-year-planner-compact.pdf

cal-year-planner-compact

Class Options

Showtrims

Cropmarks for printing and trimming bleeded images.

cal-showtrims.tex | cal-showtrims.pdf

cal-showtrims

Varnishmask

Varnishmask (or UV mask) file for applying gloss varnish on the photo when printing.

cal-varnishmask.tex | cal-varnishmask.pdf

cal-varnishmask

Showframe

Useful option for debugging layout positioning.

cal-showframe.tex | cal-showframe.pdf

cal-showframe

Overleaf examples

Set the compiler to LuaLaTeX in the project settings sidebar.

The Wall Calendar in the Overleaf Template Gallery is the same as the 'portrait page layout' example repo below, and similar to the doc/examples/cal-plain.tex example in this repo.

On overleaf.com, check Settings > Compiler > LuaLaTex and recent TeX Live year

In case of compile time out on overleaf.com:

  • Re-compiling sometimes helps due to cached assets.
  • Comment out months and test with a single month only.

Portrait page layouts:

Photo and Notes layout:

Compact year planner layout:

Installing

TeXLive

TeXLive includes the wallcalendar package since 2018.

CTAN link: https://ctan.org/pkg/wallcalendar

Using from a git clone

I recommend however to clone this repository for each new calendar project, this way you can make small changes directly in wallcalendar.cls or the lua scripts.

You can start with one of the examples and start tweaking it. Optionally, remove the docs if you don't want to include them in your project.

git clone https://github.com/profound-labs/wallcalendar.git

cd wallcalendar
cp doc/examples/cal-photo-and-notes.tex ./new-calendar.tex

cp -r doc/examples/data .
cp -r doc/examples/photos .
cp -r doc/examples/fonts .

rm doc/ -r
rm LICENSE.txt Makefile README.md wallcalendar-layouts.png wallcalendar.pdf

lualatex -interaction=nonstopmode -halt-on-error ./new-calendar.tex

As a local package

If you wanted to install it as a local package, the make local-install task in the project root will try to install it at $TEXMFHOME/tex.

Frequently Asked Questions

See FAQ

Back matter

Github: https://github.com/profound-labs/wallcalendar

CTAN: https://ctan.org/pkg/wallcalendar

Contact: https://gambhiro.github.io

LPPL LaTeX Public Project License

About

Wallcalendar LaTeX documentclass

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages