TOC

Générer un livre avec Asciidoctor

Générer un livre avec Asciidoctor

1. introduction

Dans cet article rapide, nous vous montrerons commentgenerate a book from an AsciiDoc document et comment personnaliser votre livre avec différentes options de style.

Si vous n'êtes pas familiarisé avec AsciiDoc en Java, vous pouvez lire nosIntroduction to AsciiDoctor.

2. Type de livre backend

Le moyen le plus simple de générer un livre avec AsciiDoctorj est avec Maven, comme dans l'article mentionné précédemment. The only difference is that you have to specify doctype tag and set it to “book”. 

pdf
book

Avec un doctype défini, AsciiDoctorj sait que vous voulez construire un livre, il crée donc:

  • Une page de titre

  • Une table des matières

  • La première page du contenu du corps

  • Parties et chapitres

Pour obtenir les parties mentionnées, le document Asciidoc doit avoir un titre, des sections et d’autres parties définis, qui sont normaux pour un livre.

3. Définition d'un style personnalisé

Lors de l'écriture d'un livre, il est naturel que nous souhaitons utiliser un style personnalisé. Il est possible de le faire avec le langage de formatage spécifique à AsciiDoc défini dans le fichier YAML simple.

Par exemple, cet extrait de code définira l'apparence de chaque page d'un livre. Nous voulons être en mode portrait, avec une marge de 0,75 pouce en haut et en bas et une marge de 1 pouce sur les côtés au format A4: 

page:
    layout: portrait
    margin: [0.75in, 1in, 0.75in, 1in]
    size: A4

Nous pouvons également définir un style personnalisé pour le pied de page et l’en-tête du livre: 

header:
  height: 0.5in
  line_height: 1
  recto_content:
    center: '{document-title}'
  verso_content:
    center: '{document-title}'

footer:
  height: 0.5in
  line_height: 1
  recto_content:
    right: '{chapter-title} | *{page-number}*'
  verso_content:
    left: '*{page-number}* | {chapter-title}

Plus d'options de formatage peuvent être trouvées surGithub page of AsciiDoctorj.

Pour inclure le thème personnalisé dans un processus de génération de livre, nous devons définir le chemin où se trouve notre fichier de style. L'emplacement est spécifié dans la partie attributs enpom.xml: 

${project.basedir}/src/themes
custom

La première ligne définit le chemin où notre style est défini et la deuxième ligne spécifie le nom du fichier sans extension.

Avec ces changements, notrepom.xml ressemble à ceci: 


    src/docs/asciidoc
    target/docs/asciidoc
    
        ${project.basedir}/src/themes
        custom
    
    pdf
    book

4. Livre de génération

Pour générer votre livre, il vous suffit d'exécuter Maven dans le répertoire du projet, et le livre généré se trouve dans le répertoiretarget/docs/asciidoctor/.

5. Conclusion

Dans ce tutoriel, nous vous avons montré comment générer un livre décoré avec un style simple avec Maven.

Comme toujours, le code de cet article peut être trouvéover on GitHub.

Related