Documentation du Pressoir

Personnalisation

Personnalisation

Hélène Beauchef, Victor Chaix, Roch Delannay, Antoine Fauchié, Clara Grometto, David Larlet, Margot Mellet, Servanne Monjour, Nicolas Sauret, Michael Sinatra, Marcello Vitali Rosati, « Personnalisation », Documentation du Pressoir (édition augmentée), Chaire de recherche du Canada sur les écritures numériques, Montréal, 2024, ISBN : , https://ecrinum.gitpages.huma-num.fr/pressoir/chapitre3.html.
version 0, 16/9/2024
Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)

Modifier les paramètres par défaut pour personnaliser le livre créé.

Par défaut, un ensemble de choix, graphiques et éditoriaux, ont été faits et sont appliqués par le Pressoir. Les paramètres peuvent être personnalisés en modifiant les fichiers présents dans le dossier pressoir et/ou les informations dans le fichier book.toml, comme par exemple : ajouter un logo, changer la police, modifier les couleurs, définir les termes à afficher dans l’index…

Un emplacement est prévu pour l’ajout d’un logo en haut à gauche du header (ici + LE PRESSOIR +, cf. pressoir/static/img/pressoir-logo.png).

Pour remplacer le logo par défaut, aller dans pressoir/book.toml et, dans la section [theme], ajouter ou modifier les informations suivantes :

[theme]
logo-url = ['url("./img/pressoir-logo.png")', 'url("./img/mon-logo.png")']

Le fichier du logo doit être au format png.

Par défaut le lien sur le logo renvoie à la racine du (sous-)domaine, mais il est possible de spécifier une autre adresse. Par exemple si le livre est servi à l’adresse pressoir.org/livres/le-livre mais que la présentation de la structure d’édition est à l’adresse edition.org, il peut être pertinent de modifier ce paramètre. Il faut ajouter un paramètre url_publisher dans le fichier textes/garde/livre.yaml :

url_publisher: 'https://edition.org'

Modifier la police

Les polices choisies doivent être déposées dans pressoir/static/fonts puis référencées dans pressoir/static/css/fonts.css.

Exemple de référencement des polices dans fonts.css

@font-face {
    font-family: 'Averia Serif Libre';
    src: url('./fonts/averiaseriflibre-light.woff2') format('woff2');
    font-weight: normal;
    font-style: normal;
    font-display: swap;
}
@font-face {
    font-family: 'Averia Libre';
    src: url('./fonts/averialibre-bold.woff2') format('woff2');
    font-weight: bold;
    font-style: normal;
    font-display: swap;
}

Source

Choisir les couleurs

Les couleurs (header et footer, table des matières, contenus additionnels…) peuvent être définies dans la section [theme] du fichier book.toml.

Exemple de paramétrage des couleurs dans book.toml

[theme]
# header
header-background-color = ["#FFF1C3", "#3dac75"]
header-border-color = ["#B35F1F", "#000"]

# table of content
toc-border-color = ["#FFF1C3", "#EBF6F1"]
toc-border-active-color = ["#B35F1F", "#3dac75"]

# balloon
balloon-color = ["#B35F1F", "#3dac75"]
balloon-color-font = ["#fff", "#000"]

# target background
target-background  = ["#78350F", "#EBF6F1"]
target-color = ["#fff", "#000"]

# contenus additionnels
contenuadd-border-color = ["#B35F1F", "#3dac75"]
contenuadd-background = ["#FFF8E3", "#EBF6F1"]

# svg
chevron-bottom-svg = ["#111", "#fffff8"]

# footer
footer-background-color = ["#FFF1C3", "#3dac75"]
footer-border-color = ["#B35F1F", "#000"]

Source

Définir l’index

Un index est un objet éditorial, sur une page dédiée (textes/index/index-np.md), qui présente une liste de termes classés par ordre alphabétique et qui renvoie aux endroits où ces termes sont cités tout au long du texte. Un index peut être constitué de plusieurs catégories.

Exemples de catégorie : Personnalités, Lieux, Organismes, Concepts…

L’index utilise le balisage infra-textuel.

Au préalable, il est nécessaire de déclarer, dans la section [indexes] du fichier book.toml :

  • les étiquettes de balise (ids),
  • le nom des catégories qui leur seront associées (names),
  • le pictogramme qui les représentera (images).

Exemple de définition de l’index dans book.toml

[indexes]
ids = [
  "personnalite",
  "glossaire",
]
names = [
  "Personnalités",
  "Lexique",
]
images = [
  "./svg/personnalite.svg",
  "./svg/glossaire.svg",
]

Source

L’étiquette de balise (ids) ne sera pas visible pour les lecteur.rice.s. Elle ne doit pas comporter d’accent ou d’espace (ex : personnalite).

Le nom de chaque catégorie (names) sera visible par tou.te.s sur la page « Index » du livre produit (ex : Personnalités).

Le pictogramme, en .svg, doit être déposé dans le dossier pressoir/static/svg. Il apparaît dans le volet Index, à gauche du terme balisé, accessible via le [+] présent dans le corps du texteVoir la section « Balisage infra-textuel » du chapitre « Personnalisation ».↩︎.

Exemple de pictogrammes pour les catégories d’index

Pour aller plus loin

Pour aller plus loin dans la personnalisation graphique de l’ouvrage, modifier autant que souhaité les paramètres définis dans le fichier pressoir/static/css/custom.css.