Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hei-synd-report:0.1.0, hei-synd-report:0.1.1, hei-synd-thesis:0.1.0 and hei-synd-thesis:0.1.1 #1837

Closed
wants to merge 15 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/preview/hei-synd-report/0.1.0/lib/helpers.typ
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
// Fancy pretty print with line numbers and stuff
#import "@preview/codelst:2.0.2": sourcecode
// Glossarium for glossary
#import "@preview/glossarium:0.5.1": *
#import "@preview/glossarium:0.5.3": *
// Wordometer for word and character count
#import "@preview/wordometer:0.1.4": word-count

Expand Down Expand Up @@ -120,7 +120,7 @@
toe: i18n("toe-title"),
),
before: none,
indent: true,
indent: auto,
) = {
// Table of content
if tableof.toc == true {
Expand Down Expand Up @@ -189,7 +189,7 @@
length: 100%,
depth: 3,
title: i18n("toc-title"),
indent: false,
indent: auto,
) = {
v(2em)
text(large, weight: "bold", title)
Expand Down Expand Up @@ -378,7 +378,7 @@
body
) = [
#if (after != none and before != none) {
minitoc(title: minitoc-title, after:after, before:before, indent: true)
minitoc(title: minitoc-title, after:after, before:before, indent: auto)
if pb {
pagebreak()
}
Expand Down
8 changes: 8 additions & 0 deletions packages/preview/hei-synd-report/0.1.1/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
CHANGELOG.md
cliff.toml
rustfmt.toml
report.pdf
/lib/scripts/
justfile
/img/
guide-to-typst.pdf
54 changes: 54 additions & 0 deletions packages/preview/hei-synd-report/0.1.1/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Changelog

All notable changes to this project will be documented in this file.

## [0.1.1] - 2025-02-24

### 🚀 Features

- *(toml)* Add minimum compiler version 0.13.0
- *(telemetry)* Visitor count

### 🐛 Bug Fixes

- *(README)* Release Badge
- *(just)* Fix justfile for pdf generation
- *(typst)* Add link to new version hei-synd-report:0.1.1
- *(package)* Latest version of glossarium and fracturist
- *(typst)* Compatibility with typst 0.13.0
- *(telemetry)* Visitorbadge
- *(tianji)* Link to tianji
- *(tianji)* Link to tianji
- *(tianji)* Link to tianji

### 💼 Other

- Merge remote-tracking branch 'origin/main'

## [0.1.0] - 2025-01-30

### 🚀 Features

- *(template)* Initial commit

### 🐛 Bug Fixes

- *(README)* Links to various resources
- *(just)* Changelog recipies
- *(convention)* Fixed small issues indicated by the typst convention
- *(superfluous)* Remove files which are not needed

### 📚 Documentation

- *(README)* Add metadata.typ description
- *(chapter)* Description of the content of chapters

### ⚙️ Miscellaneous Tasks

- *(metadata)* Comments
- *(README)* Minor modifications
- *(just)* Add local preview test possibility
- *(release)* 0.1.0
- *(typst.toml)* Remove exclude since it is handeled in the typst package fork

<!-- generated by git-cliff -->
21 changes: 21 additions & 0 deletions packages/preview/hei-synd-report/0.1.1/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2025] [Silvan Zahno]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
151 changes: 151 additions & 0 deletions packages/preview/hei-synd-report/0.1.1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
![GitHub Repo stars](https://img.shields.io/github/stars/hei-templates/hei-synd-report)
![GitHub Release](https://img.shields.io/github/v/release/hei-templates/hei-synd-report)
![](https://tianji.tschinz.duckdns.org/telemetry/clnzoxcy10001vy2ohi4obbi0/cm7hhb3lf0038ru047n9dnhvt.gif)

<h1 align="center">
<br>
<img src="https://github.com/hei-templates/hei-synd-report/blob/51e8aea5b38bb51cba041bfc0ab769cc12f1a865/img/hei-en.svg" alt="HEI-Vs Logo" width="350">
<br>
HEI-Vs Engineering School - Systems Engineering
<br>
</h1>
<div align="center">
<br>
<img src="https://github.com/hei-templates/hei-synd-report/blob/51e8aea5b38bb51cba041bfc0ab769cc12f1a865/img/synd-light.svg" alt="Industrial Systems Logo" width="350">
<br>
</div>


This is the official template for a students report or project or lab report for the [HEI-Vs Engineering School](https://synd.hevs.io) in Sion, Switzerland. More templates can the found in our [GitHub organization](https://github.com/hei-templates)

![](img/https://github.com/hei-templates/hei-synd-report/blob/51e8aea5b38bb51cba041bfc0ab769cc12f1a865/img/sample.png)

## Using the template

1. In the `Typst` Univers select the `hei-synd-report` template. Locally you can use the Typst CLI to initialise the project:

```bash
# from the typst universe
typst init @preview/hei-synd-report:0.1.1
```

2. Fill in the metadata in the `metadata.typ` file.

All metadata is optional, but it is recommended to fill in as much as possible. The metadata is divided into three sections: `options`, `doc`, and `settings`.

| Metadata | Type | Description |
| ------------------------ | --------------------------- | --------------------------------------------------------------------------------------------------- |
| `options` | _dictionary_ | These are fixed values for the document, who doesn't contribute to the content. |
| `option.type` | _string_ ("draft","final") | Type of the document. "final" will omit some text at the beginning of chapters (default: `"final"`) |
| `option.lang` | _string_ ("en", "fr", "de") | Language of the document. Many element will be changed accordingly (default:`"en"`) |
| `doc` | _dictionary_ | Document metadata |
| `doc.title` | _content_ | Title of the document. |
| `doc.abbr` | _content_ | Abbreviation of the Title. |
| `doc.subtitle` | _content_ | Subtitle of the document. |
| `doc.url` | _string_ | URL for the document or project |
| `doc.logos` | _dictionary_ | Dicrionary for the different logos |
| `doc.logos.tp_topleft` | _image_ | Image for the topleft section of the titlepage |
| `doc.logos.tp_topright` | _image_ | Image for the topright section of the titlepage |
| `doc.logos.tp_main` | _image_ | Image for the main section of the titlepage |
| `doc.logos.header` | _image_ | Image for the header of the document |
| `doc.authors` | _list_ of _dictionary_ | List of authors with their metadata |
| `doc.authors.name` | _content_ | Name of the author |
| `doc.authors.abbr` | _content_ | Abbreviation of the author |
| `doc.authors.email` | _string_ | Email of the author |
| `doc.authors.url` | _string_ | URL of the author |
| `doc.school` | _dictionary_ | School metadata |
| `doc.school.name` | _content_ | Name of the school |
| `doc.school.major` | _content_ | Major of the school |
| `doc.school.orientation` | _content_ | Orientation of the school |
| `doc.school.url` | _string_ | URL of the school |
| `doc.course` | _dictionary_ | Course metadata |
| `doc.course.name` | _content_ | Name of the course |
| `doc.course.url` | _string_ | URL of the course |
| `doc.course.prof` | _content_ | Name of the professor |
| `doc.course.class` | _content_ | Class of the course |
| `doc.course.semester` | _content_ | Semester of the course |
| `doc.keywords` | _list_ of _string_ | Keywords for the document |
| `doc.version` | _content_ | Version of the document |
| `date` | _datetime_ | Date of the document (default: `datetime.today()` |
| `tableof` | _dictionary_ | Table of ... settings for the document |
| `tableof.toc` | _boolean_ | Create table of contents (default: `true`) |
| `tableof.tof` | _boolean_ | Create table of figures (default: `false`) |
| `tableof.tot` | _boolean_ | Create table of tables (default: `false`) |
| `tableof.tol` | _boolean_ | Create table of listings (default: `false`) |
| `tableof.toe` | _boolean_ | Create table of equations (default: `false`) |
| `tableof.maxdepth` | _integer_ | Max depth of the table of contents (default: `3`) |
| `gloss` | _boolean_ | Create glossary and acronyms (default: `true`) |
| `appendix` | _boolean_ | Create appendix (default: `false`) |
| `bib` | _dictionary_ | Bibliography settings for the document |
| `bib.display` | _boolean_ | Display bibliography (default: `true`) |
| `bib.path` | _string_ | Path to the bibliography file (default: `"/tail/bibliography.bib"`) |
| `bib.style` | _string_ | Style of the bibliography (default: `"ieee"`) |

3. Write your content in the `report.typ` file as well as the other files in the `main` folder.

## Usage

In order to build the `Typst` document locally you can use one of the following command:

```bash
# Create pdf
typst compile report.typ

# Create pdf and watch for changes
typst watch report.typ
```

## Features

- [x] All metadata is optional
- [x] Title page
- [x] Table of contents
- [x] Table of figures
- [x] Table of tables
- [x] Table of listings
- [x] Table of equations
- [x] Custom Boxes
- [x] Sourcecode with codelst
- [x] Glossary and Acronyms with Glossarium
- [x] Bibliography
- [x] Draft and Final Typesetting
- [x] Content help
- [x] Introduction
- [x] Specification
- [x] Design
- [x] Implementation
- [x] Validation
- [x] Conclusion
- [ ] Wavedrom diagrams
- [ ] PlantUML diagrams

## Help

If you need help writting your document look at the [Typst documentation](https://typst.app/docs/) or if ou need more help with the template specifics look at the document [Guide-to-Typst](https://github.com/hei-templates/hei-synd-report/blob/51e8aea5b38bb51cba041bfc0ab769cc12f1a865/guide-to-typst.pdf).

## Contributing

If you would like to contribute to any of the repositories in this organization, please follow these steps:

1. Fork the repository you want to contribute to.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with conventional commit messages.
4. Push your branch to your forked repository.
5. Open a pull request in the original repository and describe your changes.

## Issues and Support

If you encounter any issues or have questions regarding the course or any of the repositories, please feel free to open an issue in the respective repository. Our team will be happy to assist you.

## Changelog

All notable changes to this project are documented in the [CHANGELOG.md](./CHANGELOG.md) file.

## Find us on

[hevs.ch](https://synd.hevs.io) &nbsp;&middot;&nbsp;
LinkedIn [HEI-Vs](https://www.linkedin.com/showcase/school-of-engineering-valais-wallis/) &nbsp;&middot;&nbsp;
LinkedIn [HES-SO Valais-Wallis](https://www.linkedin.com/groups/104343/) &nbsp;&middot;&nbsp;
Youtube [HES-SO Valais-Wallis](https://www.youtube.com/user/HESSOVS)
Twitter [@hessovalais](https://twitter.com/hessovalais) &nbsp;&middot;&nbsp;
Facebook [@hessovalais](https://www.facebook.com/hessovalais) &nbsp;&middot;&nbsp;
85 changes: 85 additions & 0 deletions packages/preview/hei-synd-report/0.1.1/cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[changelog]
# template for the changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{% for commit in commits %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
{ pattern = '<REPO>', replace = "https://github.com/tschinz/tschinz.github.io" }, # replace repository URL
]
# render body even when there are no releases to process
# render_always = true
# output file path
output = "CHANGELOG.md"

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = false
# process each line of a commit as an individual commit
split_commits = true
# regex for preprocessing the commit messages
commit_preprocessors = [
# Replace issue numbers
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^docs", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ message = "^chores\\(release\\): prepare for", skip = true },
{ message = "^chores\\(deps.*\\)", skip = true },
{ message = "^chores\\(pr\\)", skip = true },
{ message = "^chores\\(pull\\)", skip = true },
{ message = "^chores|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
{ message = ".*", group = "<!-- 10 -->💼 Other" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
Loading
Loading