Universe

Create project in app
Version 0.1.0

The letterloom package is a user-friendly and customizable template designed to streamline the creation of professional-looking letters. Whether for personal or business correspondence, it eliminates the challenges of traditional typesetting tools like LaTeX while delivering polished and elegant results.

Key Features:

  • Multiple Signatures: Effortlessly include one or more signatures for joint communications or approvals.
  • Customizable Footnotes: Add informative footnotes with flexible formatting options.
  • Enclosures and Attachments: Clearly list additional documents included with the letter.
  • Internationalization Support: Customize labels and text for different languages and regions.

Benefits:

  • Simplifies the letter-writing process with an intuitive template.
  • Eliminates the steep learning curve of tools like LaTeX.
  • Delivers professional-quality output without requiring technical expertise.
  • Supports multilingual documents with customizable labels.

Regardless of whether you are preparing a formal business correspondence, or crafting a personal letter, letterloom makes creating visually appealing documents both straightforward and efficient.

Usage

The letterloom package offers extensive customization options, enabling you to tailor your letters to suit various needs and preferences.

Here is a simple example demonstrating the essential arguments needed to use the letterloom package:

#import "@preview/letterloom:0.1.0": *

#show: letterloom.with(
  //Sender's contact information (name and address)
  from: (
    name: "The Dimbleby Family",
    address: [The Lodge \
              Cheswick Village \
              Middle Upton \
              Bristol BS16 1GU]
  ),
  //Recipient's contact information (name and address)
  to: (
    name: "Evergreen Tree Surgeons",
    address: [Midtown Lane \
              Cheswick Village \
              Stoke Gifford \
              Bristol BS16 1GU]
  ),
  // Letter date (automatically set to today's date)
  date: datetime.today().display("[day padding:zero] [month repr:long] [year repr:full]"),
  // Opening greeting
  salutation: "Dear Mr Hawthorne",
  // Letter subject line
  subject: text(weight: "bold")[#smallcaps("Pruning of Heritage Oak Trees in the Dimbleby Estate")],
  // Closing phrase
  closing: "Sincerely yours,",
  // List of signatories with their names
  signatures: (
    (
      name: "Lord Albus Dimbleby",
      signature: image("images/albus-sig.png")
    ),
    (
      name: "Lady Abigail Dimbleby",
      signature: image("images/abigail-sig.png")
    ),
    (
      name: "Sir Austin Dimbleby",
      signature: image("images/austin-sig.png")
    ),
  ),
)

// Letter content
We are writing to request you to visit The Lodge at the Dimbleby Estate in Cheswick Village to assess a stand of lordly Heritage Oak Trees that have stood the test of time, but whose strength might have been compromised by the wild squall that ripped through the region last week. We are keen to avoid any danger to passers by from weakened roots, branches, and sundry debris.

Your specific task would be to render the grove safe to human traffic while at the same time minimizing the residual damage to the trees. You would, of course, also undertake to clear the area thereafter.

Since this estate is jointly owned by the Dimbleby family, the signatures of all three of us appear in this letter to avoid any legal wrangles in the future.

Kindly contact our Head Groundsman, Mr Jethro Tull, on 0117-12345678. to fix an appointment to view the trees and give a quotation for the contemplated work.

Thank you kindly.

For a detailed overview of all options and features, consult the package’s official manual, which provides comprehensive usage instructions and a more elaborate example.

Development

If you wish to contribute to this package you may follow the steps below to prepare your development environment:

  1. Typst: Install Typst (version 0.13.0 or higher) following the official guide. Typst is the core tool required for this project.

  2. Just: Install Just, a handy command runner for executing predefined tasks. You can install it using a package manager or by downloading a pre-built binary. Refer to the available packages for installation instructions specific to your operating system.

  3. tytanic: Install tytanic, a library essential for testing and working with Typst projects. Use the quickstart installation guide to get it up and running.

  4. Clone the Repository: Download the project’s source code by cloning the repository to your local machine:

    git clone https://github.com/nandac/letterloom.git

    Your development environment is now ready.

Next Steps

The package’s source code resides in the src directory:

── src
│   ├── construct-outputs.typ
│   ├── lib.typ
│   └── validate-inputs.typ

Modify the files in this directory as needed.

Running Tests

To validate the package functionality, execute the following command:

just test

To add a new test case execute:

tt new

This will create a new folder with the following structure under the tests directory:

├── 
│   ├── .gitignore
│   ├── ref
│   │   └── 1.png
│   └── test.typ

You may then write your tests in the test.typ file.

For more information on writing tests using tytanic please see this guide.

Once you have written your test run:

just update
just test

Ensure all tests pass before submitting changes to maintain code quality.

To test the package with an actual Typst file, install the letterloom package locally in the preview location by running:

just install-preview

Once installed, import it into your Typst file using:

#import "@preview/letterloom:0.1.0": *

This allows experimentation with the package before finalizing updates.

Releasing a New Version

Follow these steps to release a new version of the package:

  1. Update Version Number:

    • Increment the major and/or minor version number in all files referencing the old version.

  2. Update CHANGELOG:

    • Document added features, modifications, and optionally include a migration guide for the new version in CHANGELOG.md.

  3. Commit Changes:

    • Push your updates to the repository:

      git add .
git commit -m "Bump version and update CHANGELOG"
git push

  4. Tag the Release:

    • Create and push a new tag for the version:

      git tag -a v -m ""
git push --tags origin

  5. Create a Pull Request:

    • The release action in GitHub will create a branch in your fork of typst-packages.
    • Use this branch to open a pull request in the main Typst Packages repository.

Acknowledgments

Grateful thanks to the Typst community on Discord for their invaluable guidance and support during development.