précédant | suivant | sommaire

Editer sur Linux (et ailleurs) avec ses outils

Editer de la doc sur tout, dans des formats qui vous permettrons de transformer ensuite cette doc au format que vous désiré.
Le SGML
Le POD
Les Editeurs à votre service
Groff
etc...

SGML

Le langage qui permet de lire depuis n'importe quel éditeur et qui met en forme le texte. Un document SGML sert de document base, il est structuré grâce à des balises qui permettrons de le transformer en tel ou tel format précis. Il est accessible depuis n'importe quelle console ou éditeur ou afficheur texte.
Comme son nom l'indique c'est le standard généralisé des langages à balises pour Linux, c'est le langage normalisé de la documentation sur Linux. Les HOWTO sont sous ce format, qui permet la lecture sous differants formats et tous les éditeurs.

cette page est en construction

En gros si vous avez un document texte à transformer en document sgml (utiliser mon script text2sgml.pl) ou HOWTOdoc ou
<!doctype linuxdoc system>
<linuxdoc>
<article>
<title>Le titre</title>
<author>le nom de l'auteur</author>
<date>la date</date>

<abstract>quelque mots pour expliquer de quoi ca parle</abstract>
<toc>si tu veux avoir un index avec tous les chapitres et sous chapitres centraliser au debut qui appelle les documents
<sect1>le titre d'un chapitre
<sect2>le titre d'un sous chapitre
<sect2>le titre d'un autre sous-chapitre
<sect1>le tire d'un autre chapitre
<br>saut de ligne
<p>phrase
etc... et a la fin tu ferme
</article>
</linuxdoc>

En attendant la suite voir sur lfo le document http://www.linux-france.org/article/jdanield/MaL001-7.html
voilà le tour est jouer, si tu veux maintenant convertir ton document en document html tape à la console
$ sgml2html mon_document.sgml
et tu aura un beau "mon_document.html" avec un index et des chapitres en liens dynamiques, un gros beau titre, etc...
Depuis le sgml tu peut pratiquement tout faire en passant par les outils mis à ta disposition (entre sgml_toolkit et les outils Perl) tu peux tout faire.

Le language POD aussi est trés bien voir HOWTOdoc.sgml

Le POD

Le POD (Plain Old Document) La bonne vieille doc, qui est utilisé par Perl peut aussi être directement transformé en HTML ou tout autre format de document, et encore plus facile à coder que le SGML.

Les éditeurs sur linux

ceci n'a rien à voir avec sgml mais je ne sais pas ou le mettre donc ...

Bon pour tout ce qui est éditeur de texte, et non pas mise en page: il y a

emacs : le n° 1 avec vi des éditeur de textes et de programmes (il compile ou comprend tous les langages de programmation) 300 pages pour d'ecrire emacs ne suffiré pas, il fait tout ....

Xemacs : Idem que emacs, seulement il faut que ce soit vous qui l'installer. Mais il existe des packages aux formats RPM donc aucune excuse pour ne pas l'avoir (installation tapez au prompt: # rpm -i xemacs-xxx_i386.rpm)

Scite: plus petit qu'Emacs mais a toutes les fonctionnalités courement utilisés, l'affichage du STDOUT, la colorisation du texte qui reconnait tout les langages et un rech/remplace efficace. Trés bon éditeur qui s'installe depuis très longtemps, même sur Windows.

kwrite: un éditeur de code aussi mais qui a des points forts vraiement forts.

son recherche/remplace: soit littéralement, soit au niveau des caractères d'échappement, soit au niveau des reg exp (expression régulières) et ça c'est énorme.
un contrôle intéligeant du codage des caractères (mettant en Lecture seule quand il voit des problèmes à venir). Possiblité de codage énorme (visible dessuite)
un affichage intelligeant des codes sources qui permet une meilleure visibilité et comprehension.

Ted : pour tous ceux qui rales en brandissant sur $oft y'avait Word, et je pouvais écrire gras sans passer par TeX ou un HTML . Il existe Ted et il fait tout mieux que Wordpad (correction d'ortographe, plein, déliés, alignement (WYSWS) et tout ça sur un logiciel hyper rapide. Il faut que vous l'installiez dés que le besoin s'en fait sentir. http://www.abul.org/ et en plus ça viens de Bordeaux.

vi, vim éditeur ultra pérformant en mode texte de tous ce que vous voulez, langage programmation, texte aussi, pourquoi pas.
Adapter parfaitement pour les usages pro (combinaison de caractères aux fonctions définis, raccourci clavier, hitlight sur types de données, etc ... bien documenté)

xedit xedit est un editeur de texte simple (peut être trés vieux aussi, mais bon il est sérvi en standard et pérmet le couper coller)

gnopad+ c'est un éditeur de texte HTML qui tout en étant simple est pratique, pour décrossir un travail .html (sur votre site)

GXedit est un editeur de texte assez complet bénéficiant de caractéristiques pro, (cvs, encodage, compréhention de plusieur langages informatique et interface pratique).

pico pour ne pas changer de main quand l'envie d'éditer vous prend sur un terminal, un peu comme edit de DOS, il est en mode texte et s'execute sur une console, parfait pour les petit script de quelques lignes et les manipulations de fichiers.

Voilà pour les plus connus, j'éspére ne pas en oublier trop. De toute façon ça devrai suffir pour commencer.

Pour le formatage de texte, (la mise en page) c'est autre chose:

------------------------------------------------------------------
Groff vous pagine vite fait un texte, et réparti bien les mots en fin de lignes. Il peut aussi vous servir pour rediger vos propres pages de man.
Il est capable de reconnaitre plein de Macro (commencant toujours par un point) qui vous aiderons pour mettre en page votre texte, exemple:

.TH   Titre du manuel
.SH   Sous-titre du manuel
.PP    comencer un nouveau paragraphe
.SS    sous section
.LP    Commencer un nouveau paragraphe
.RE    Fin d'indentation relative
.RS    Debut d'indentation
."       Ligne de commentaire
.DT   Tabulation par defaut
.HP   Debut d'indentation
.IP     Debut de paragraphe avec un mot cle sur la ligne suivante
.TP    Debut de paragraphe avec un mot cle sur la meme ligne
.B      gras
.I        Italique
.BI     gras alterné d'italique
.BR    gras altérné de Police Roman
.IB .IR .RB comme dit plus (cad: I pour italique B pour gras et R pour roman)
.SH    petit
(facile, rapide, utile) il vous mettra vos texte bien alligné avec les marges et tous ce qu'il faut.... en tapant simplement à la console
groff -Tlatin1 man monfichier | less
-----------------------------------------------------

Lout langage de formatation de texte, en voilà un qui est serieux tout en étant resonnable coté poids. Pour faire propre.

TeX et LaTeX et tout le gros pack TeTeX qui est capable de faire de belles mise en pages, mais à quel prix ...
(ceci n'engage que moi) Les packages TeTeX sont trés, pour pas dire trop lourds et pauvre en documentation accessible pour tous, c'est fait pour les Pros (tout au moins car j'éspére qu'eux au moins s'en servent).
Pour ma part un package qui fait trois tonnes, et qui est aussi inacsessible ( j'ai perdu deux dixiéme à un oeil rien qu'en feuilletant la mise en route, qui ne m'a rien appris) les docs les plus élémentaires démarrent avec un prérequis de huit ans d'experiences, souvent la vie ne suffie pas pour une assimilation profonde, tout ça pour de la mise en page.......enfin.
Autre inconveiniant le texte formatés par TeX ne sont lisible que si vous avez le package, alors à moins de n'éditer que des formules mathématique et ce d'une manière professionnelle, TeTeX peut vous gacher la vie.

Ted encore et toujours, plus simple y'a pas, en voilà un qui l'est bien. rapide, propre, mieux que WORDPAD.

Il y a aussi tout les logiciels de mise en page html.

précédant | suivant | sommaire