pafp - Online na nuvem

PROGRAMA:

NOME

paf - Filtro de resumo de pod. Transforme os documentos do Pod na linha de comando.

SINOPSE

sh $>
resumo do paf / usr / bin / paf
paf add_podcmds SomeModule.pm
paf sort -heading = METHODS Pod / Abstract / Node.pm # METHODS é o padrão
resumo da classificação do paf Pod / Abstract / Node.pm

# Veja Pod :: Abstract :: Filter :: overlay
paf overlay classificação corte clear_podcmds SomeClass.pm

# -p emitirá a origem do pod, em vez de gerar o perldoc.
paf -p sort Pod :: Abstract :: Node
paf -p find hoist Pod :: Abstract :: Node

DESCRIÇÃO

Paf é uma ferramenta de transformação e filtro de Pod modular, pequena, mas poderosa. Permite total
transformação de ida e volta de documentos de Pod usando a biblioteca Pod :: Abstract, com vários
filtrar cadeias sem ter que serializar / analisar novamente o documento em cada etapa.

Paf vem com um pequeno conjunto de filtros úteis, mas pode ser estendido simplesmente escrevendo novos
classes no namespace "Pod :: Abstract :: Filter".

FILTROS

add_podcmds
Adicione comandos explicit = pod no final de cada seção de corte, para que todas as seções do pod sejam
começou com um comando = pod.

clear_podcmds
Remova todos os comandos = pod que não finalizam os blocos cortados. Isso irá limpar documentos que
foram reduzidos usando o filtro "cortar" também.

corte
Remova todos os nós cortados, de modo que apenas o pod permaneça.

sobreposição
sobreposição paf Fonte.pm

Para que a sobreposição funcione, deve haver uma seção "begin: overlay / end: overlay" na fonte
, com definições de "= overlay Módulo SECTION" dentro. O efeito líquido é que qualquer
subtítulos ausentes em SECTION são adicionados a partir da mesma seção nos Módulos especificados.

Observe que isso irá sobrepor todo o subtítulo, INCLUINDO NÓS DE CORTE, para que possa adicionar o código
para o documento de origem. Use "cortar" se não quiser.

Cada seção sobreposta incluirá um marcador "= para sobreposição de", para que possa ser
substituído por uma sobreposição subsequente do mesmo arquivo / módulo. Essas seções serão
substituído no local, portanto, a ordem das seções assim que sobrepostas pela primeira vez será preservada.

desmascarar
paf unoverlay Fonte.pm

Tiras todos os seções marcadas como sobrepostas e correspondentes à especificação de sobreposição da fonte.

tipo
paf sort [-heading = METHODS] Source.pm

Classifique todos os subtítulos no título nomeado (MÉTODOS, se não fornecido).

Isso moverá os nós de corte com seus cabeçalhos, de modo que seu código sofrerá mutação. Use "cortar"
se você quiser apenas pod na saída.

Como alternativa, você também pode fazer com que a classificação de títulos ocorra incluindo "= para classificação"
no início de sua seção (antes do primeiro subtítulo).

resumo
Forneça um resumo abreviado do documento. Se houver um nó literal no corpo de
um título contendo o nome do título, será considerado um exemplo e expandido como
parte do resumo.

find
paf find [-f =] nome Source.pm

Encontre subseções específicas ou itens de lista que mencionem o nome. Usado para restringir um maior
documento para um conjunto menor no qual você está interessado. Se nenhum -f for especificado, então o
a palavra a seguir a localizar será o termo de pesquisa.

sem cortes
paf sem cortes Fonte.pm

Converta nós cortados na fonte em texto literal. Não é o inverso do corte!

numero_seções
número paf_seções Fonte.pm

Aplica numeração de seção multipart simples (3.1.2) para cabeçalhos head1 a head4.

Note que number_sections irá atualmente encher um pouco da inteligência em coisas como
resumo, já que os nomes das seções não corresponderão mais aos nomes das funções.

Use pafp online usando serviços onworks.net