Skip to content

Commit

Permalink
sunny-orasis:0.1.1 (#1778)
Browse files Browse the repository at this point in the history
  • Loading branch information
edgaremy authored Feb 20, 2025
1 parent 608e4e0 commit 28ce2b5
Show file tree
Hide file tree
Showing 8 changed files with 782 additions and 0 deletions.
14 changes: 14 additions & 0 deletions packages/preview/sunny-orasis/0.1.1/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
MIT No Attribution

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.

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.
49 changes: 49 additions & 0 deletions packages/preview/sunny-orasis/0.1.1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# ☀️ sunny-orasis 🌴
A paper template made for the French national conference **ORASIS**.

The template was made following the official author guidelines, while looking as close as possible like the official LaTeX template.
This should also work for the **RFIAP** and **CAP** conferences.

## Usage
This package is meant to be used as a starting template, with the included `template/main.typ`.

However, you can also import the template using the following line:
```typst
#import "@preview/sunny-orasis:0.1.1": orasis
```
and then create the document in your main file:
```typst
#show: orasis.with(
title: "Mon merveilleux article pour ORASIS",
authors: (
(name: "M. Oimême", affiliation: "1"),
(name: "M. Oncopain", affiliation: "2"),
),
affiliations: ("Mon Institut", "Son Institut"),
emails: ("Mon adresse électronique",),
abstract_fr: [
Ceci est mon résumé pour les journées francophones des jeunes chercheurs en vision par ordinateur (ORASIS). Il doit occuper une dizaine de lignes.
],
keywords_fr: [Exemple type, format, modèle.],
abstract_en: [
This is the English version of the abstract. Exactly as in French it must be short. It must exhibit the same content...
],
keywords_en: [Example, model, template.],
document-fonts: ("Times-Roman", "TeX Gyre Termes",), // la seconde police est une alternative libre et preque identique à Times-Roman)
)
```
And that's it ! You can then simply type your paragraphs using the classic Typst syntax for headings etc.

## Dependencies
This template was tested with Typst 0.12.0

## Going further
If you want to make deeper changes, specifically to the Title and Authors formatting, I strongly recommand to copy the entire template yourself, instead of importing it.
Doing it this way, you will still have access to the `lib.typ` file, allowing you to change anything to your liking.

105 changes: 105 additions & 0 deletions packages/preview/sunny-orasis/0.1.1/orasis.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
// Patron de format Typst pour soumettre un article long à ORASIS (ou RFIAP).
// Sans garanties.
// Deux colonnes, pas de numérotation et 10 points.

#let orasis(
title: none,
authors: none,
affiliations: none,
emails: none,
abstract-fr: none,
keywords-fr: none,
abstract-en: none,
keywords-en: none,
document-fonts: ("TeX Gyre Termes",),
body,
) = {

set page(
paper: "a4",
margin: (left: 1.9cm, right: 1.9cm, top: 3cm, bottom: 3cm),
numbering: none,
columns: 2,
)

set columns(gutter: 1cm)
set text(font: document-fonts, size: 10pt)
set text(lang: "fr")


show heading: set text(font: document-fonts, weight: "bold", size: 12pt)
set footnote.entry(clearance: 4pt)

// Title header in single column.
place(
top + center,
float: true,
scope: "parent",
clearance: 3em,
)[
// Title row.
#pad(top: 1.5em, bottom: 0.5em)[
#text(weight: "bold", size: 14pt)[#title]
]

// Author information.
#set text(font: document-fonts, size: 12pt)
#pad(
bottom: 0.3em,
x: 7.5em,
grid(
columns: (1fr,) * calc.min(4, authors.len()),
gutter: 1em,
..authors.map(author => align(center)[
#author.name#super[#author.affiliation]
]),
),
)

// Affiliations informations.
#for (i, inst) in affiliations.enumerate() {
[#super[#(i+1)] #inst]
linebreak()
}
#v(0.5em)

#for email in emails {
email
linebreak()
}
]

set par(justify: true, leading: 5.6pt, spacing: 5.6pt)
show heading: set block(above: 10pt, below: 10pt)

// Abstracts and Keywords Sections.
heading(level: 2, "Résumé")
text(lang: "fr", style: "italic")[#abstract-fr]

heading(level: 2, "Mots Clef")
text(lang: "fr")[#keywords-fr]

heading(level: 2, "Abstract")
text(lang: "en", style: "italic")[#abstract-en]

heading(level: 2, "Keywords")
text(lang: "en")[#keywords-en]

// Body of the article.
set heading(numbering: "1.1 ")
show heading: it => [
// Format headings depending on level and numbering
#if it.numbering == none and it.level == 1 { // for Bibliography
set text(14pt) // could be 12pt, but kept 14pt to mimic LaTeX template
block(it)
} else if it.level == 1 { // numbered Headings
set text(14pt) // could be 12pt, but kept 14pt to mimic LaTeX template
block(it)
} else { // sub-section Headings
set text(12pt)
block(it)
}
]

text(lang: "fr")[#body]
}
73 changes: 73 additions & 0 deletions packages/preview/sunny-orasis/0.1.1/template/main.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// Patron de format Typst pour soumettre un article long à ORASIS (ou RFIAP).
// Sans garanties.
// Deux colonnes, pas de numérotation et 10 points.

#import "@preview/sunny-orasis:0.1.1": orasis

#show: orasis.with(

title: "Mon merveilleux article pour ORASIS",

authors: (
(name: "M. Oimême", affiliation: "1"),
(name: "M. Oncopain", affiliation: "2"),
),

affiliations: ("Mon Institut", "Son Institut"),
emails: ("Mon adresse électronique",),

abstract-fr: [
Ceci est mon résumé pour les journées francophones des jeunes chercheurs en vision par ordinateur (ORASIS). Il doit occuper une dizaine de lignes.
],
keywords-fr: [Exemple type, format, modèle.],

abstract-en: [
This is the English version of the abstract. Exactly as in French it must be short. It must exhibit the same content...
],
keywords-en: [Example, model, template.],

document-fonts: ("Times-Roman", "TeX Gyre Termes",), // la seconde police est une alternative libre et preque identique à Times-Roman)
)

= Introduction
Le contenu de l'article peut être rédigé avec n'importe quel formateur ou traitement de texte, pourvu qu'il réponde aux critères de présentation donnés ici. L'objectif visé est de proposer une unité de présentation des actes, et nous vous invitons à respecter ce modèle autant que le permet votre logiciel favori.

La soumission se fait obligatoirement au *format PDF*, quelque soit le logiciel d'édition. Chaque article doit être compris entre 6 et 8 pages.

Pour les auteurs utilisant Typst, le fichier source de ce texte (`orasis.typ`) est lui-même une base pour obtenir une sortie conforme avec Typst#footnote[patron validé sur la version Typst 0.12.0].

Les autres trouveront des renseignements (peut-être) plus lisibles pour eux dans le fichier `orasis.doc` (Word) ou le fichier `orasis.tex` (LaTeX).

La base du texte est du Times-Roman 10 points présenté en deux colonnes. La séparation inter-colonne est de 1 cm.

Le titre principal est en 14 points gras (28 points = 1cm).

Dans les sections, le titre est en 12 points gras. Les para-
graphes ne sont pas décalés.

Les sous-sections numérotées comme suit :

== État de l'art
Les en-têtes sont également en 12 points gras.

Il n'y a pas nécessairement d'espacement entre les paragraphes.

Les références à la bibliographie peuvent être de la forme @foo:baz @key:foo. Les numéros correspondent à l'ordre d'apparition dans la bibliographie, pas dans le texte. L'ordre alphabétique est conseillé.

= Le coin Typst
Pour les utilisateurs de Typst, ce patron est minimaliste et vous aurez besoin de la documentation Typst pour insérer équations et images.

Les fichiers nécessaires pour la compilation sont :
- `orasis.typ` (le patron)
- `main.typ` (le cœur de votre article)
- `refs.bib` (vos références)
- `ref_style.csl` (_facultatif_) (pour afficher les références [1], [2] de la façon suivante : [1, 2])

#set heading(numbering: none) // Pas de numérotations pour l'annexe et la bibliographie
= Annexe
Merci de votre participation.

// Bibliographie avec fichier permettant aux citations juxtaposées d'être fusionnées (IEEE) :
#bibliography("refs.bib", title: "Références", style: "ref_style.csl")
// Version sans le fichier .csl :
// #bibliography("refs.bib", title: "Références")
Loading

0 comments on commit 28ce2b5

Please sign in to comment.