pafp - En ligne dans le Cloud

PROGRAMME:

Nom

paf - Filtre abstrait de pod. Transformez les documents Pod à partir de la ligne de commande.

SYNOPSIS

sh$>
résumé paf /usr/bin/paf
paf add_podcmds SomeModule.pm
paf sort -heading=METHODS Pod/Abstract/Node.pm # METHODS est la valeur par défaut
résumé du tri paf Pod/Abstract/Node.pm

# Voir Pod::Abstract::Filter::overlay
paf overlay tri cut clear_podcmds SomeClass.pm

# -p émettra la source du pod, au lieu de générer perldoc.
paf -p trier Pod :: Abstract :: Node
paf -p find treuil Pod::Abstract::Node

DESCRIPTION

Paf est un petit mais puissant outil de transformation et de filtrage de pods modulaire. Il permet plein
transformation aller-retour de documents Pod à l'aide de la bibliothèque Pod::Abstract, avec plusieurs
chaînes de filtrage sans avoir à sérialiser/réanalyser le document à chaque étape.

Paf est livré avec un petit ensemble de filtres utiles, mais peut être étendu en écrivant simplement de nouveaux
classes dans l'espace de noms "Pod::Abstract::Filter".

FILTRES

add_podcmds
Ajoutez des commandes explicites = pod à la fin de chaque section coupée, de sorte que toutes les sections de pod soient
commencé avec une commande =pod.

clear_podcmds
Supprimez toutes les commandes =pod qui ne terminent pas les blocs coupés. Cela nettoiera les documents qui
ont également été réduits à l'aide du filtre "couper".

cut
Supprimez tous les nœuds coupés, de sorte que seul le pod reste.

revêtement
superposition paf Source.pm

Pour que la superposition fonctionne, il doit y avoir une section "begin :overlay/end :overlay" dans la source
fichier, avec les définitions "=overlay SECTION Module" à l'intérieur. L'effet net est que tout
les sous-titres manquants dans SECTION sont ajoutés à partir de la même section dans les modules spécifiés.

Notez que cela recouvrira tout le sous-titre, Y COMPRIS LES NUDS DE COUPE, afin qu'il puisse ajouter du code
au document source. Utilisez "couper" si vous ne le souhaitez pas.

Chaque section superposée comprendra un marqueur « = pour la superposition de », afin qu'il puisse être
remplacé par une superposition ultérieure du même fichier/module. Ces sections seront
remplacé sur place, de sorte que l'ordre des sections une fois superposés sera préservé.

superposition
paf non superposé Source.pm

Bandes tous sections marquées comme superposées et correspondant à la spécification de superposition de la source.

sort
paf sort [-heading=MÉTHODES] Source.pm

Triez tous les sous-titres dans le titre nommé (MÉTHODES si non fournies).

Cela déplacera les nœuds coupés avec leurs en-têtes, de sorte que votre code mutera. Utiliser "couper"
si vous ne voulez que le pod dans la sortie.

Alternativement, vous pouvez également provoquer le tri des en-têtes en incluant "=pour le tri"
au début de votre section (avant le premier sous-titre).

Sommaire
Fournissez un résumé abrégé du document. S'il y a un nœud verbatim dans le corps de
un titre contenant le nom du titre, il sera considéré comme un exemple et développé comme
partie du résumé.

trouver
paf find [-f=]nom Source.pm

Trouvez des sous-sections spécifiques ou des éléments de liste mentionnant le nom. Utilisé pour restreindre une plus grande
document jusqu'à un ensemble plus petit qui vous intéresse. Si aucun -f n'est spécifié, alors le
le mot suivant find sera le terme de recherche.

non coupé
paf non coupé Source.pm

Convertissez les nœuds coupés dans la source en texte verbatim. Pas l'inverse de la coupe !

nombre_sections
paf nombre_sections Source.pm

Applique une numérotation simple des sections (3.1.2) aux en-têtes head1 à head4.

Notez que number_sections va actuellement bourrer une partie de l'intelligence dans des choses comme
résumé, car les noms de section ne correspondront plus aux noms de fonction.

Utiliser pafp en ligne en utilisant les services onworks.net