Exemple pas à pas

Nous allons maintenant détailler le processus de création d'un document AlcoveBook simple. Cet exemple inclut quelques uns des éléments AlcoveBook parmi les plus utilisés. Si vous cherchez une liste plus complète des éléments AlcoveBook ainsi que leur utilisation, consultez le document AlcoveBook DTD, disponible à l'URL http://debian-docs/alcovebook-sgml-doc/html/DTD-HOME.html ou voir la section intitulée Référence.<

Étape 1: Inclure la déclaration du type de document

Imaginons que vous êtes en train de formater un article, la première chose que vous avez à faire est d'inclure la déclaration suivante:

Exemple 7. Déclaration de type de document

	  
<!DOCTYPE article PUBLIC "-//Alcove//DTD DocBook V4.1-Based Subset AlcoveBook V0.1 Draft//EN">
	  
	

Étape 2: ajouter un élément racine

Après cela, vous devez définir l'élément « racine », qui contiendra tous les autres éléments de votre document. Pour un article, l'élément racine est simplement « article ». Ainsi, ajouter l'élément suivant après la déclaration du type du document:

Exemple 8. Déclaration de type de document et élément racine

	  
<!DOCTYPE article PUBLIC "-//Alcove//DTD DocBook V4.1-Based Subset AlcoveBook V0.1 Draft//EN">
<article lang="fr">
</article>
	  
	

L'élément article a deux attributs obligatoires, lang (qui peut prendre les valeurs en, fr, de et es) et role (qui peut prendre les valeurs proposal, whitepaper, specification, delivery,documentation et other). lang est utilisé par les feuilles de style pour le contenu généré (« table des matières » par exemple) et role est utilisé par les outils alcovebook2x pour choisir une feuille de style par défaut.

Tout ce que vous ajouterez par la suite dans votre document sera contenu dans l'élément article, ainsi, la dernière balise de votre document sera toujours « </article> ». Le paramètre lang="fr" permet d'utiliser les options Françaises à la génération du document.

Étape 3: Ajouter un en-tête d'article

Ensuite, vous devez ajouter des informations sur l'article que vous écrivez, ce qui inclut le titre, le nom l'auteur, son adresse email, l'historique du document, son résumé et ainsi de suite. Pour le moment, nous ajouterons juste le titre de l'article, sa date d'écriture et le nom de l'auteur (notez qu'à ce stade là, le document n'est toujours pas exploitable car il manque des éléments indispensables).

Exemple 9. Exemple d'en-tête d'article

	  
<!DOCTYPE article PUBLIC "-//Alcove//DTD DocBook V4.1-Based Subset AlcoveBook V0.1 Draft//EN">
<article lang="fr">
  <articleinfo>
    <title>Une introduction pratique à AlcoveBook</title>
    <subtitle></subtitle>
    <author>
      <firstname>Benjamin</firstname>
      <surname>Drieu</surname>
    </author>
    <date>27 août 2001</date>
  </articleinfo>
</article>
	

Note : L'élément subtitle est obligatoire. AlcoveBook vous recommande de l'utiliser pour indiquer le type du document (par exemple, « proposition commerciale ».

Étape 4: ajouter un historique

Vous devez maintenant ajouter un historique des modifications apportées au document, en utilisant l'élément revhistory.

Exemple 10. Exemple d'historique

	  
<!DOCTYPE article PUBLIC "-//Alcove//DTD DocBook V4.1-Based Subset AlcoveBook V0.1 Draft//EN">
<article lang="fr">
  <articleinfo>
    <title>Une introduction pratique à AlcoveBook</title>
    <subtitle></subtitle>
    <author>
      <firstname>Benjamin</firstname>
      <surname>Drieu</surname>
    </author>
    <date>27 août 2001</date>
    <revhistory>
      <revision>
        <revnumber>0.1</revnumber>
        <date>27 août 2001</date>
        <revremark>Révision initiale</revremark>
      </revision>
    </revhistory>
  </articleinfo>
</article>
	

Les éléments de l'historique des révisions sont détaillés dans la section intitulée Historique des révisions.

Étape 5: ajouter une section de premier niveau

Maintenant que nous avons rempli l'en-tête de l'article avec des informations utiles, nous allons ajouter du contenu à l'article dans une section de niveau un avec un titre:

Exemple 11. Exemple de document possédant des sections

	  
<!DOCTYPE article PUBLIC "-//Alcove//DTD DocBook V4.1-Based Subset AlcoveBook V0.1 Draft//EN">
<article lang="fr">
  <articleinfo>
    <title>Une introduction pratique à AlcoveBook</title>
    <subtitle></subtitle>
    <author>
      <firstname>Benjamin</firstname>
      <surname>Drieu</surname>
    </author>
    <date>27 août 2001</date>
    <revhistory>
      <revision>
        <revnumber>0.1</revnumber>
        <date>27 août 2001</date>
        <revremark>Révision initiale</revremark>
      </revision>
    </revhistory>
  </articleinfo>

  <section>
    <title>Introduction</title>
    <para>
      De tous temps, les hommes ont cherché à écrire des introductions
      bateau.
    </para>
  </section>

</article>
	

Note : Notez l'utilisation de l'élément title dans l'élément section. Cet élément permet de donner un titre à la section en question. Sous cet élément title on trouve un élément para, qui contient du contenu textuel. Notez également que dans AlcoveBook, le contenu textuel est situé dans des éléments particuliers, notamment para.

À ce stade là de la méthode, le document est exploitable.

Étape 6: ajouter des sous-sections et des sous-sous-sections

L'ajout de sous-sections et de sous-sous-sections est tout aussi simple. Il n'y a pas d'élément distinctif entre les sections de niveau un ou plus. Une section de niveau n est simplement inclue dans une section n-1. Ainsi, pour définir une sous-section:

Exemple 12. Exemple de sous-section

	    
<section>
  <title>Les belles histoires de tonton Benjamin</title>
  <section>
    <title>Paf le chien</title>
    <para>
      C'est l'histoire ...
    </para>
  </section>
  <section>
    <title>Deux grenouilles sur une voie ferrée</title>
    <para>
      C'est l'histoire ...
    </para>
  </section>
</section>