https://github.com/beatussum/typst-bei-report-template
An unofficial Typst template for ENSIMAG internship report
https://github.com/beatussum/typst-bei-report-template
ensimag ieee internship internship-report report typst typst-package typst-template
Last synced: 4 months ago
JSON representation
An unofficial Typst template for ENSIMAG internship report
- Host: GitHub
- URL: https://github.com/beatussum/typst-bei-report-template
- Owner: beatussum
- License: gpl-3.0
- Created: 2025-08-15T09:21:39.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-10-08T14:35:39.000Z (8 months ago)
- Last Synced: 2025-10-08T16:23:38.703Z (8 months ago)
- Topics: ensimag, ieee, internship, internship-report, report, typst, typst-package, typst-template
- Language: Typst
- Homepage:
- Size: 3.7 MB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Copyright: copyright
Awesome Lists containing this project
README
# The `bei-report` Package
Version 0.1.2
This project is based on the [charged-ieee](https://github.com/typst/templates/tree/main/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](https://www.ieee.org/).
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](https://ensimag.grenoble-inp.fr/) for internship reports.
## Getting Started
```typ
#import "@preview/bei-report:0.1.2": 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
```console
$ 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](https://typst.app/docs/reference/foundations/datetime/#format)).
- `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](https://typst.app/docs/reference/layout/page/#parameters-paper) 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](#getting-started).
## 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](copyright) file in [the Debian `debian/copyright` file format](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/).