# Wallcalendar LaTeX documentclass

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

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

- [Wallcalendar LaTeX documentclass](#wallcalendar-latex-documentclass)
    - [Features](#features)
    - [Examples](#examples)
        - [Load custom event footnotes from CSV](#load-custom-event-footnotes-from-csv)
        - [Portrait page](#portrait-page)
            - [Full page photo, calendar days overlaid with opacity](#full-page-photo-calendar-days-overlaid-with-opacity)
            - [Full page photo, photo above the calendar days](#full-page-photo-photo-above-the-calendar-days)
            - [Small landscape photo, with a calendar grid](#small-landscape-photo-with-a-calendar-grid)
            - [Thumbnails and captions page](#thumbnails-and-captions-page)
        - [Sunday-first week layout](#sunday-first-week-layout)
        - [Landscape photo and notes on two pages](#landscape-photo-and-notes-on-two-pages)
            - [No photos, with notes area](#no-photos-with-notes-area)
        - [Year planners](#year-planners)
            - [Portrait year planner](#portrait-year-planner)
            - [Landscape year planner with dates in rows](#landscape-year-planner-with-dates-in-rows)
            - [Landscape year planner with grid](#landscape-year-planner-with-grid)
            - [Compact year planner](#compact-year-planner)
        - [Class Options](#class-options)
            - [Showtrims](#showtrims)
            - [Varnishmask](#varnishmask)
            - [Showframe](#showframe)
    - [Overleaf examples](#overleaf-examples)
    - [Installing](#installing)
        - [TeXLive](#texlive)
        - [Using from a git clone](#using-from-a-git-clone)
        - [As a local package](#as-a-local-package)
    - [Frequently Asked Questions](#frequently-asked-questions)
    - [Back matter](#back-matter)

<!-- markdown-toc end -->

## 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][examples] folder on Github.

[examples]: https://github.com/profound-labs/wallcalendar/tree/master/doc/examples

## Examples

Files are in the [doc/examples](https://github.com/profound-labs/wallcalendar/tree/master/doc/examples) folder.

### Load custom event footnotes from CSV

[cal-marks.tex](doc/examples/cal-marks.tex) | [cal-marks.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-marks.pdf)

![cal-marks](doc/examples/cal-marks.jpg)

### Portrait page

[cal-plain.tex](doc/examples/cal-plain.tex) | [cal-plain.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-plain.pdf)

#### Full page photo, calendar days overlaid with opacity

![cal-plain-01](doc/examples/cal-burst/cal-plain-01.jpg)

#### Full page photo, photo above the calendar days

![cal-plain-02](doc/examples/cal-burst/cal-plain-02.jpg)

#### Small landscape photo, with a calendar grid

![cal-plain-03](doc/examples/cal-burst/cal-plain-03.jpg)

#### Thumbnails and captions page

[cal-thumbnails.tex](doc/examples/cal-thumbnails.tex) | [cal-thumbnails.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-thumbnails.pdf)

![cal-thumbnails](doc/examples/cal-thumbnails.jpg)

### 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](doc/examples/cal-photo-and-notes-sunday.tex) | [cal-photo-and-notes-sunday.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-photo-and-notes-sunday.pdf)

![cal-photo-and-notes-sunday](doc/examples/cal-photo-and-notes-sunday.jpg)

### Landscape photo and notes on two pages

[cal-photo-and-notes.tex](doc/examples/cal-photo-and-notes.tex) | [cal-photo-and-notes.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-photo-and-notes.pdf)

![cal-photo-and-notes-titlepage](doc/examples/cal-photo-and-notes-titlepage.jpg)

![cal-photo-and-notes-photo](doc/examples/cal-photo-and-notes-photo.jpg)

![cal-photo-and-notes-calendar](doc/examples/cal-photo-and-notes-calendar.jpg)

#### No photos, with notes area

[cal-no-photos.tex](doc/examples/cal-no-photos.tex) | [cal-no-photos.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-no-photos.pdf)

![cal-no-photos-01](doc/examples/cal-burst/cal-no-photos-01.jpg)

### Year planners

#### Portrait year planner

[cal-year-planner.tex](doc/examples/cal-year-planner.tex) | [cal-year-planner.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-year-planner.pdf)

![cal-year-planner](doc/examples/cal-year-planner.jpg)

#### Landscape year planner with dates in rows

[cal-year-planner-rows.tex](doc/examples/cal-year-planner-rows.tex) | [cal-year-planner-rows.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-year-planner-rows.pdf)

![cal-year-planner-rows](doc/examples/cal-year-planner-rows.jpg)

#### Landscape year planner with grid

[cal-year-planner-grid.tex](doc/examples/cal-year-planner-grid.tex) | [cal-year-planner-grid.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-year-planner-grid.pdf)

![cal-year-planner-grid](doc/examples/cal-year-planner-grid.jpg)

#### Compact year planner

[cal-year-planner-compact.tex](doc/examples/cal-year-planner-compact.tex) | [cal-year-planner-compact.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-year-planner-compact.pdf)

![cal-year-planner-compact](doc/examples/cal-year-planner-compact.jpg)

### Class Options

#### Showtrims

Cropmarks for printing and trimming bleeded images.

[cal-showtrims.tex](doc/examples/cal-showtrims.tex) | [cal-showtrims.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-showtrims.pdf)

![cal-showtrims](doc/examples/cal-burst/cal-showtrims-01.jpg)

#### Varnishmask

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

[cal-varnishmask.tex](doc/examples/cal-varnishmask.tex) | [cal-varnishmask.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-varnishmask.pdf)

![cal-varnishmask](doc/examples/cal-burst/cal-varnishmask-03.jpg)

#### Showframe

Useful option for debugging layout positioning.

[cal-showframe.tex](doc/examples/cal-showframe.tex) | [cal-showframe.pdf](https://raw.githubusercontent.com/profound-labs/wallcalendar/master/doc/examples/cal-showframe.pdf)

![cal-showframe](doc/examples/cal-burst/cal-showframe-01.jpg)

## Overleaf examples

Set the compiler to `LuaLaTeX` in the project settings sidebar.

The [Wall Calendar](https://www.overleaf.com/latex/templates/wall-calendar/yyvqfsbsmssm) 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](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:

- [Overleaf project](https://www.overleaf.com/read/kjpcxcsmxkjc)
- [Github repo](https://github.com/profound-labs/wallcalendar-portrait-layouts-overleaf)

Photo and Notes layout:

- [Overleaf project](https://www.overleaf.com/read/hzjpfdmspwds)
- [Github repo](https://github.com/profound-labs/wallcalendar-photo-and-notes-overleaf)

Compact year planner layout:

- [Overleaf project](https://www.overleaf.com/read/fgcncdmpkmcy)
- [Github repo](https://github.com/profound-labs/wallcalendar-compact-year-planner-overleaf)

## 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](./FAQ.md)

## 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

