Utiliser le squelette « Documentation » pour rédiger un livre

La manière la plus simple pour se lancer dans le projet « un livre avec SPIP » est d’utiliser le squelette documentation pour SPIP 3.

Ce squelette est celui utilisé par le site de Marcimat Programmer avec SPIP, mais porté sur SPIP 3.

Dans cet article, j’explique comment installer et l’utiliser de manière à optimiser l’export en .tex.

Installation

Le squelette est distribué sous forme de plugin. Il s’installe comme n’importe quel plugin.

Toutefois il nécessite au minimum SPIP 3.

En outre il a besoin des plugins :
-  ZPIP 1.7.x
-  Critères precedent et suivant
-  Saisie
-  Champ extra 3

Utilisation

Arborescence

Puisque le but est d’utiliser le squelette pour ensuite fabriquer un .tex pour l’impression, il est bon de savoir comment est organisé la hiérachie des titres dans un fichier LaTeX.
Par défaut, tout les titres sont numérotés automatiquement. Voici les différents niveaux de titre, du plus important au plus faible.

Nom de titreCode LaTeXSpécificité lors de la conversion en PDF
Partie \part Le titre est sur une page de droite dédiée.
Chapitre \chapter Un chapitre commence en haut de page, sur une page de droite.
Section \section Une section provoque un changement de paragraphe.
Sous-section \subsection Une sous-section provoque un changement de paragraphe

Il existe également les niveaux \subsubsection, \paragraph et \subparagraph, mais ces nivaux ne sont pas utilisés lors de la génération des fichiers .tex par SPIP.

À ces niveaux de titre LaTeX correspondent des nivaux dans la hiérachie des rubriques.

-  Le premier niveau (secteur) correspond à un livre entier. Un secteur correspondant à une langue.
-  Le second niveau correspond à un partie au sens LaTeX (\part). Exemple de rubrique de niveau \part : http://programmer.spip.org/-Ecriture-des-squelettes-.
-  Le troisième niveau correspond à un chapitre au sens LaTeX (\chapter) http://programmer.spip.org/-Les-boucles-.
-  Un article correspond à une section au sens LaTeX (\section) http://programmer.spip.org/Syntaxe-des-boucles.
-  Les raccourcis {{{…}}} provoquent des sous-sections. (\subsection).

Contenu des articles
En plus du classique champs titre et texte, chaque article peut avoir un exemple, un exercice et une réponse à l’exercice. Le champ PS est également utilisé.

Lors de l’export en .tex, les trois champs supplémentaires (exemple, exercice, réponse) seront encadrés d’un code signalant qu’il faudra les mettre dans un cadre gris dans le PDF final.

Les champs exemple, exercice, réponse et PS seront précédés d’intertitres.

Ordre des rubriques / articles

Il est possible de ne pas écrire les rubriques / articles dans leur ordre logiques. Pour déterminer l’ordre des rubriques / articles, il suffit de faire précéder les titres d’un nombre, suivi d’un point, suivi d’un espace :

1. Rubrique qui apparaîtra en premier

Raccourcis typographique

On peut utiliser l’ensemble des raccourcis typographique de SPIP. Si on cite du code, il faut utiliser le plugin coloration code.

Un code entre <cadre> aura ses lignes numérotées, pas un code entre <code>.

Par ailleurs, le module LaTeX de gestion du code sources colorés n’est pas capable de couper automatiquement les lignes trop longues : il faut donc les limiter directement au sein des balises <cadre> ou <code> (60 caractères approximativement, si vous gardez les réglage de format de papier et de marge standard).

Production du PDF

La production du PDF est détaillé dans un autre article.

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom