https://github.com/esther-poniatowski/exercise-sheet-tex-toolkit
Utility package to design exercise sheets in LaTeX
https://github.com/esther-poniatowski/exercise-sheet-tex-toolkit
exercises latex-template teaching-resources
Last synced: 3 months ago
JSON representation
Utility package to design exercise sheets in LaTeX
- Host: GitHub
- URL: https://github.com/esther-poniatowski/exercise-sheet-tex-toolkit
- Owner: esther-poniatowski
- License: other
- Created: 2025-01-06T17:08:11.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-15T08:13:12.000Z (5 months ago)
- Last Synced: 2025-01-15T10:15:15.867Z (5 months ago)
- Topics: exercises, latex-template, teaching-resources
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# exercise-sheet-tex-toolkit
## Overview
Utility package designed to streamline the creation of exercise sheets in LaTeX.
By automating common formatting tasks, this toolkit allows users to focus on content creation.
## Features
This package provides a set of macros and styles that are relevant in the content of educational resources:
- **Mcros**: Simplify common exercise sheet elements (e.g. questions numbering, exercise titles, problem statements).
- **Styles**: Ensure a consistent layout for exercise sheets through customizable style options
## Installation
To use `exercise-sheet-tex-toolkit` in a LaTeX project:
1. Add the repository as a submodule in a designated directory (e.g. `./include/`):
```bash
git submodule add https://github.com/username/exercise-sheet-tex-toolkit.git include/exercise-sheet-tex-toolkit
```
2. (Optinal) Add the path to the toolkit directory to LaTeX search path. Options include:
- Updating the TEXINPUTS environment variable.
- Modifying the local project configuration file (e.g., `.latexmkrc`).
- Adding any other custom method relevant to the setup (e.g., tools in LaTeX Workshop extention, if using VS Code).
## Usage
1. In a LaTeX document, import the package:
- If the package directory is in the LaTeX search path:
```latex
\usepackage{exercise-sheet-tex-toolkit}
```
- Otherwise, specify the relative path:
```latex
\usepackage{./include/exercise-sheet-tex-toolkit/exercise-sheet-tex-toolkit}
```
2. Utilize the provided macros and styles in the document. Refer to the package documentation for detailed usage instructions and examples.
## Versioning
Stable releases are tagged on the `main` branch.
To select a specific version compatible with a project, check out the corresponding tag:
```bash
cd include/exercise-sheet-tex-toolkit
git checkout v1.2.3
```
> [!NOTE]
> The project follows a Git flow versioning strategy.