Creation: 21 mai 2013
Mise à jour:
Version: 1.0
Author: Jean-Louis Bicquelet-Salaün
Location: http://jlbicquelet.free.fr
Copyright: (c) 2013 Jean-Louis BICQUELET-SALAÜN

---

POD

POD est un langage utilisé pour documenter les programmes en perl.

Pod a été concu pour être simple et posséder une syntaxe juste suffisante pour être utile sans artifice. Pas de gestion de fontes,de couleurs ou de table, mais on peut insérer du code spécifique si on le désire.

Les objectifs principaux sont:

• facile à parser
• facile à convertir dans un autre format (HTML, man, XML, TEX ..)
• l'insertion de code est facile
• facile à lire sans un formatteur pod
• suffisament facile à écrire et à apprendre pour que les programmeur écrivent la documentation

convertion de POD dans un autre format

Il existe 3 types de filtres standards qui formattet les documents Pod dans un autre format.

Cest filtres sont:

• pod2html pour convertir les fichiers POD en HTML
• pod2man pour convertir les fichiers POD en man page
• pod2latex pour transformer du POD en Latex

Pour utiliser ces programmes, il suffit de taper:

pod2html doc.pod

ou pour générer un fichier

pod2html doc.pod > doc.html

tableaux récapitulatifs

Les directives POD

=pod	suspend l'analyse du code PERL jusqu'à =cut
=cut	termine le POD
=head1	titre spécifie un titre de niveau 1
=head2	titre spécifie un titre de niveau 2
=head3	titre spécifie un titre de niveau 3
=head4	titre spécifie un titre de niveau 4
=item	texte spécifie un élément de liste
=over N	spécifie une indentation
=back	annule l'indentation
=for X	balise annonce un formatteur
=begin X	balise indique le début d'un formatteur
=end X	balise indique la fin d'un formatteur
=encoding codage	exemple: =encoding utf8 ou =encoding big5

formattage

I	texte en italique
B	texte en gras
U	texte souligné
C	code source
S	texte contenant des espaces insécables
L	lien vers une page du manuel
L	lien vers un élément d'une page
L	lien vers une section d'une page du manuel
L<"sec">	lien vers une section de la même page
L<|"sec">	idem
F	nom de fichier
X	entrée d'index
E<échappement>	caractères nommés, exmple E correspond à <, E<#124> pour |, E pour " etc..
Z<>	caractère de longueur nulle, sert pour une ligne qui commence par= Z<>=

caractères

E	un < littéral (plus petit que)
E	un > littéral (plus grand que)
E	un | littéral | (barre verticale)
E<#124>	|
E	un / littéral (barre oblique)
E	"
E	é
E	è

exemples

man page

=head1 NAME

command - a perl program

=head1 SYNOPSIS

       command file

=head1 DESCRIPTION

This program i a template for further program written in Perl.

=head2 Methods

=over 12

=item C<-h>

give help

=item C

transforms the file

=back

=head1 AUTHOR

Bicquelet jean-Louis - 

=head1 SEE ALSO

L

=cut

mise en forme

Il est possible d'utiliser une feuille de style pour mettre en forme le document produit, en associant un fichier css.

code pod

sans mmise en forme

exemple de mise en forme