mot pour mot, de commande, et texte ordinaire.
=head1 titre
=head2 titre
=item texte
=over N
=back
=cut
=pod
=for X
=begin X
=end X
=for html <br> <p> This is a raw HTML paragraph </p>
La paire de commandes « =begin » et « =end » fonctionne de façon très similaires à « =for », mais au lieu de n'accepter seulement qu'un seul paragraphe, tout le texte depuis le « =begin » jusqu'au paragraphe ayant un « =end » assorti est traité comme d'un format particulier.
Voici des exemples de l'utilisation de ceci :
=begin html
<br>Figure 1.<IMG SRC="figure1.png"><br>
=end html
=begin text
--------------- | foo | | bar | ---------------
^^^^ Figure 1. ^^^^
=end text
Certains noms de format que les formateurs sont connus pour accepter actuellement incluent « roff », « man », « latex », « tex », « text », et « html » (certains formateurs traiteront certains de ceux-ci comme des synonymes).
Et n'oubliez pas, en utilisant toute commande, que son effet dure jusqu'à la fin du paragraphe, pas de la ligne. D'où dans les exemples ci-dessus, les lignes vides que vous pouvez voir après chaque commande pour terminer son paragraphe.
Des exemples de listes incluent :
=over 4
=item *
First item
=item *
Second item
=back
=over 4
=item Foo()
Description of Foo function
=item Bar()
Description of Bar function
=back
I<texte> Texte en italique, utilisé pour l'accentuation ou les variables
B<texte> Texte en gras, utilisé pour les options et les programmes
S<texte> Le texte contient des espaces insécables
C<code> Code littéral
L<nom> Un lien (référence croisée) vers nom
L<nom> page de manuel
L<nom/ident> élément dans la page de manuel
L<nom/"sec"> section dans une autre page de manuel
L<"sec"> section dans cette page de manuel
(les guillemets sont optionels)
L</"sec"> idem
la même chose que ci-dessus mais seul 'texte' est utilisé comme sortie.
(Le Texte ne peut pas contenir les caractères '/' et '|',
et devrait contenir des '<' ou des '>' appariés)
L<texte|nom>
L<texte|nom/ident>
L<texte|nom/"sec">
L<texte|"sec">
L<texte|/"sec">
F<file> Utilisé pour les noms de fichier
X<index> Une entrée d'index
Z<> Un caractère de largeur nulle
E<escape> Un caractère nommé (très similaire aux séquences d'échappement HTML)
E<lt> Un < litteral
E<gt> Un > litteral
E<sol> Un / litteral
E<verbar> Un | litteral
(Ceux-ci sont optionnels sauf dans d'autres séquences internes
et quand ils sont précédés d'une lettre majuscule)
E<n> Caractère numéro n (probablement en ASCII)
E<html> Une entité HTML non numérique, comme
E<Agrave>
La plupart du temps, vous n'aurez besoin que d'un seul jeu de crochets pour délimiter le début et la fin des séquences internes. Toutefois vous voudrez parfois mettre un signe supérieur à dans une séquence. C'est particulièrement courant lorsqu'on utilise une séquence pour fournir une fonte différente pour un petit bout de code. Comme pour toute chose en Perl, il y a plus d'une façon de le faire. L'une d'elle est de simplement protéger le crochet fermant en utilisant une séquence "E" :
C<$a E<lt>=E<gt> $b>
Ce qui produira : ""$a <=> $b""
Une méthode plus lisible, et peut-etre plus « simple », est d'utiliser une autre paire de délimiteurs qui n'ont pas besoin d'un « > » pour leur protection. À partir de perl5.5.660, les crochets doublés (« << » et « >> ») peuvent etre utilisés si et seulement si des espaces suivent immédiatement le crochet ouvrant et précèdent le crochet fermant ! Par exemple, ce qui suit fonctionnera :
C<< $a <=> $b >>
En fait, vous pouvez utiliser autant de crochets répétés que vous le désirez tant qu'il y en a autant dans les délimiteurs ouvrants et fermants, et que vous vous assurez que l'espace suit immédiatement le dernier « < » du délimiteur ouvrant, et précède immédiatement le premier « > » du délimiteur fermant. Ce qui suit fonctionnera donc aussi :
C<<< $a <=> $b >>>
C<<<< $a <=> $b >>>>
C'est actuellement supporté par pod2text (Pod::Text), pod2man (Pod::Man), et tout autre traducteur pod2xxx et Pod::Xxxx qui utilise Pod::Parser version 1.093 ou supérieure.
En particulier, vous pouvez laisser des choses comme ceci mot pour mot dans votre texte :
Perl
FILEHANDLE
$variable
function()
manpage(3r)
Sans doute quelques commandes ou séquences supplémentaires auront besoin d'être ajoutées en cours de route, mais je m'en suis étonnemment bien sorti avec juste celles-ci.
Notez que je ne proclame pas du tout que ceci est suffisant pour produire un livre. J'essaye juste de faire une source commune à l'épreuve des idiots pour nroff, TeX, et les autres langages de marquage, tels qu'ils sont utilisés pour la documentation en ligne. Des traducteurs existent pour pod2man (ceci est pour nroff(1) et troff(1)), pod2text, pod2html, pod2latex, et pod2fm.
__END__
=head1 NAME
modern - I am a modern module
Si vous n'aviez pas eu cette ligne vide à cet endroit, alors les traducteurs ne l'auraient pas vue.
Si vous avez besoin du contrôle total du texte utilisé pour un lien dans la sortie, utilisez la forme L<show this text|foo> à la place.