From 06496594cbcd07dce285e2036a6bcb369254f7f1 Mon Sep 17 00:00:00 2001 From: Gregory Trolliet Date: Tue, 3 Oct 2023 21:30:50 +0200 Subject: [PATCH] =?UTF-8?q?Met=20=C3=A0=20jour=20le=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 41 +++++++++++++++++++++++++++++++++++------ 1 file changed, 35 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fc87e85..b4c39e3 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,48 @@ Ce document est un modèle de document pour décrire une procédure. -## En-tête +## En-tête Markdown L'en-tête, au format YAML, peut contenir les informations suivantes: + * *title*, le titre du document; -* *author*, l'auteur du document; * *subtitle*, le sous-titre; +* *author*, l'auteur du document; * *authorMail*, le mail de l'auteur; * *lang*, la langue du document (`fr` pour le français, `en` pour l'anglais), par défaut l'anglais est utilisé; * *date*, la date du document, par défaut la date du jour est utilisée; * *header*, l'information centrale du header; -* *footer*, l'information de gauche du footer; +* *license*, la licence du document; * *version*, la version du document; * *geometry*, les marges du document; -* *abstract*, le résumé du document. +* *documentclass*, la classe de document latex, article par défaut, possible report et book; +* *toc*, si `true`, affiche la table des matières; +* *abstract*, le résumé du document; +* *watermark*, ajoute un filigrane aux pages. -## Problème -Sans titre, l'en-tête et le pied de page ne fonctionnent pas comme désiré... \ No newline at end of file +## Garde +Si les informations sont fournies, et avec le titre au minimum, une "page de garde" sera créé. +Au format article, cette "page" est réduite et affichée au dessus du premier chapitre. +Le format de cette zone est le suivant: +``` + TITRE + sous-titre + + author + authorMail + + date - version +``` + + +## En-tête et pied de page +Pour autant que les informations soient fournies, l'en-tête est constitué comme suit: +``` +date header(chapitre si pas spécifié) +``` +Le pied de page est constitué ainsi: +``` +license title - version page +author +``` + +## \ No newline at end of file