The bei-report Package

Version 0.1.0

This project is based on the charged-ieee Typst template.

This is a Typst template for a two-column paper from the proceedings of the Institute of Electrical and Electronics Engineers. The paper is tightly spaced, fits a lot of content and comes preconfigured for numeric citations from BibLaTeX or Hayagriva files. The first page corresponds to the one required by ENSIMAG for internship reports.

Getting Started

#import "@preview/bei-report:0.1.0": ensimag

#show: ensimag.with(
  logos: (
    company: rect([MON ENTREPRISE]),
    ensimag: rect([ENSIMAG]),
  ),
  title: [A Typesetting System to Untangle the Scientific Writing Process],
  author: (
    name: "Martin Haug",
    year: [3#super[e] année],
    option: [ISI],
  ),
  period: (
    begin: datetime(year: 1970, month: 01, day: 01),
    end: datetime(year: 1970, month: 03, day: 01),
  ),
  company: (
    name: [mon entreprise],
    address: [
      1 cours Jean Jaurès \
      38000 Grenoble
    ]
  ),
  internship-tutor: [Charles Dupond],
  school-tutor: [Charles Dupont],
)

Installation

$ typst init "@preview/bei-report" [DIR]

Usage

This template exports the ensimag function with the following named arguments:

• logos - A dictionary which must have the company and ensimag logos (content).
• title - The paper's title as content.
• author - A dictionary which must have the name (str or an array), year (content) and option (content) keys.
• period - A dictionary which must have the begin and the end date (datetime).
• date-fmt - The date format string used (see the format syntax).
• company - A dictionary describing the information about the company with its name (content) and its address (content).
• internship-tutor - The internship tutor (content).
• school-tutor - The school tutor (content).
• abstract - The content of a brief summary of the paper or none. Appears at the top of the first column in boldface.
• index-terms - Array of index terms to display after the abstract. Shall be content.
• paper-size - Defaults to a4. Specify a paper size string to change the page format.
• bibliography - The result of a call to the bibliography function or none. Specifying this will configure numeric, IEEE-style citations.
• figure-supplement - How figures are referred to from within the text. Use "Figure" instead of "Fig." for computer-related publications.

The function also accepts a single, positional argument for the body of the paper.

The template will initialize your package with a sample call to the ensimag function in a show rule. If you want to change an existing project to use this template, you can add a show rule like described above.

Licenses

As explained above, the code of this software is licensed under GPL-3 or any later version. Details of the rights applying to the various third-party files are described in the copyright file in the Debian debian/copyright file format.