Documentation de linuxdoc-make 0.13

Documentation de linuxdoc-make 0.13

Gilles Lamiral

$Revision: 1.14 $ $Date: 2001/11/22 03:21:39 $


Comment installer et utiliser linuxdoc-make 0.13

Index de la documentation

Vous trouverez la dernière version de linuxdoc-make, écrit par Gilles Lamiral, à l'adresse :
http://www.linux-france.org/prj/linuxdoc-make/

Ce document, écrit en SGML, peut être disponible en plusieurs formats: ASCII TeX SGML PostScript HTML HTM PDF Info LyX Man (à la convenance de l'administrateur du site).

1. Introduction

Le logiciel linuxdoc-make est utile pour générer facilement des fichiers aux formats ASCII, TeX, SGML, PostScript, HTML, HTML monobloc, PDF, Info, LyX, et man à partir d'un document SGML écrit avec la DTD linuxdoc. L'internationalisation des balises de navigation HTML est prise en compte.

Le logiciel linuxdoc-make est une collection de répertoires, d'un fichier Makefile, et d'exemples en SGML, associés pour pouvoir créer de la documentation selon différents formats de sortie en une seule commande de type make. Toutes les langues de sgmltools sont supportées.

2. Installation

L'installation est très simple puisqu'elle consiste à extraire l'archive à l'endroit où vous voulez générer votre documentation.

2.1 Prérequis

La plupart des logiciels nécessaires sont surement déjà présent sur votre système car ils font partie de toute bonne distribution libre qui se respecte.

Logiciels:

Vous devez savoir écrire des documents au format SGML avec la DTD linuxdoc.

2.2 Téléchargement

Téléchargez linuxdoc-make via ftp à l'adresse suivante: http://www.linux-france.org/prj/linuxdoc-make/00_dist/

L'archive est nommée linuxdoc-make-0.13.tgz où 0.13 est le numéro de version.

2.3 Mise en place

You n'avez pas besoin d'être root pour installer linuxdoc-make. Vous installez linuxdoc-make là où vous voulez créer de la documentation.

      
      gzip -tv linuxdoc-make-0.13.tgz # optionnel mais rassurant
      cd où/vous/voulez
      tar tzvf linuxdoc-make-0.13.tgz
      tar xzvf linuxdoc-make-0.13.tgz
      cd linuxdoc-make-0.13
      make # et lisez
      ...
      

Vous pouvez renommer le répertoire linuxdoc-make-0.13/ comme bon vous semble à n'importe quel moment. La commande make utilisée sans argument produit simplement un rappel des options disponibles; c'est l'équivalent de make help

3. Utilisation

3.1 Pour l'impatient

Si vous écrivez des documents dans une autre langue que l'anglais (l'anglais est la langue par défaut) vous devez terminer son nom par le suffixe .ll.sgmlll sont les deux caractères symbolisant votre langue. En voici la liste:

Créer un nouveau fichier en vous inspirant du modèle:


cd linuxdoc-make-0.13
cp sgml/lidoma-model.fr.sgml sgml/monfichier.fr.sgml

Editez le fichier sgml/monfichier.fr.sgml (emacs est particulièrement adapté pour cela). Sauvegardez le.

Générez un fichier HTML sur une seule page:

      
make htm

regardez dans le répertoire htm/


ls -l htm/
monfichier.fr.htm

Visualisez le fichier monfichier-fr.htm avec votre navigateur favori (lynx, n'est-ce pas?).

Essayez d'autres format de sortie:


make
make txt html ps pdf

Si vous désirez cloner l'essentiel de linuxdoc-make tapez juste:


make clone

et déplacer le répertoire clone/ où bon vous semble.

3.2 Index

Pour créer un fichier index, nommé index.html dans chaque répertoire, utiliser la commande:


make indexes
make i      # même comportement 
make if     # en force (élimine les anciens fichiers)

Certains traitements sont automatisés avec m4. Toutes les définitions sont définis une seule fois dans le fichier include/definitions.m4 et les fichiers qu'il inclut. Pour modifier les définitions principales les plus voyantes et utiles, éditez le fichier include/override.m4 et modifiez les valeurs à votre guise.

Bonne doc !