iGor milhit
e02c9d59ba
- Complète la documentation pour mieux expliquer la structure du projet et l'utilisation des commandes pour générer le document PDF final. - Améliore la syntaxe markdown de la documentation. - Documente l'utilisation du modèle dans son propre projet. Fixes #2. - Documente la manière de rédiger un document en utilisant la syntaxe markdown et certaines particularités qui sont données en exemple dans le fichier `example.md`. Fixes #1 (au moins en partie). - Structure, ordonne et documente le fichier des règles de style afin d'en améliorer la lecture et la compréhension. Une partie de la documentation sur l'utilisation de ce modèle se retrouve dans ce fichier. Fixes #1 (dans une autre partie). - Implémente des améliorations de style réalisée avec le projet BibLaTeX et Zotero, notamment la numérotation de la table des matières et sur l'affichage du numéro de page de chaque section. - Configure les polices utilisées. Fixes #3. - Mets à jour la base de donnée bibliographique (`references.bib`). - Mets en forme les tableaux. - Améliore le rendu des blocs de code préformatés. - Supprime le soulignement des appels de note. Fixes #4. - Ajoute du contenu à l'exemple afin de mieux montrer le résultat obtenu. Fixes #1 (également). - Ignore le dossier `release/` qui contient des fichiers propres à la publication de version. Co-Authored-by: iGor milhit <igor@milhit.ch> |
||
|---|---|---|
| example | ||
| static | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| heg-iso-690.csl | ||
| interface.css | ||
| style.css | ||
| template.html | ||
README.md
| title | date | id | tags | ||||
|---|---|---|---|---|---|---|---|
| Un modèle pagedjs pour la BUNIGE | 2023-04-21T11:19:03+02:00 | 20230421111912 |
|
Un modèle pagedjs pour la BUNIGE
Licence
Ce projet est sous licence MIT.
Description
Ce projet est un modèle et une mise en forme pour produire un PDF suivant la charte de la Bibliothèque de l'Université de Genève.
Il a pour objectif d'être ajouté rapidement à un projet utilisant paged.js pour générer des PDF à partir d'un contenu en markdown.
Usage
Une solution est de télécharger les fichiers et répertoires suivants à la racine de votre propre projet :
static/.style.css.template.html.interface.css.
Vous pouvez faire ces téléchargement à la main, ou télécharger le fichier
.zip de la publication de version.
Une autre méthode est de cloner le projet et de rédiger votre document au sein de celui-ci.
Structure du répertoire
À la racine du répertoire se trouve les fichiers nécessaires au modèle :
- Le modèle lui-même :
template.html. - La feuille de style qui rend possible l'interface web pour la
prévisualisation du document au format HTML :
interface.css(fichier faisant partie du projet paged.js : interface.css). - Le fichier de style bibliographique qui fait partie à part entière du modèle,
car il est la norme utilisée par la charte :
heg-iso-690.csl. Il est extrait du répertoire des styles.csl: haute-ecole-de-gestion-de-geneve-iso-690.csl.
Dans le dossier example se trouvent les sources pour pouvoir donner un
exemple :
- Le document markdown lui-même :
example.md. - Une liste de références bibliographiques au format BibLaTeX :
references.bib.
Prérequis
pandoc.pagedjc-cli(npm install -g puppeteer pagedjs pagedjs-cli).
Génération du PDF d'exemple
Lancer les commandes depuis le répertoire ./example.
Pour générer le fichier HTML a visualiser dans le navigateur :
pandoc --standalone --pdf-engine=pagedjs-cli \
--template=../template.html --css=../style.css \
--toc --toc-depth=2 --citeproc \
--to=html --output=example.html example.md
Puis lancer un serveur web à la racine du projet (par exemple avec python -m http.server), et ouvrir le fichier HTML généré avec Chromium (ou Chrome) pour
pouvoir l'imprimer au format PDF.
Pour générer directement le PDF :
pandoc --standalone --citeproc \
--to=pdf --pdf-engine=pagedjs-cli \
--css=../style.css --toc --toc-depth=2 \
--output=example.pdf example.md
Pour générer le PDF en utilisant pagedjs :
pandoc --citeproc --to=html --toc --toc-depth=2 \
--template=../template.html --css=../style.css \
--output example.html example.md \
&& pagedjs-cli example.html --style ../style.css --output example.pdf
Rédaction du document
Pour la rédaction du document, il est utile de se référer à la documentation de
la syntaxe markdown, mais aussi à la documentation de pandoc. Quelques points
sont données en exemples dans le fichier example/example.md, comme par
exemple La police ou Les titres.