Como abrir e converter POD para PDF para ler a documentação Perl

Um arquivo POD é a documentação antiga da linguagem de programação Perl. Mostramos a você como converter POD para PDF, HTML, Markdown, LaTeX ou texto simples.

Um arquivo POD é a documentação antiga da linguagem de programação Perl.  Mostramos a você como converter POD para PDF, HTML, Markdown, LaTeX ou texto simples.
Propaganda

Embora já tenha sido uma linguagem integral para a programação da Web Que Linguagem de Programação Aprender - Programação da Web Que Linguagem de Programação Aprender - Programação da Web Hoje vamos dar uma olhada nas diversas linguagens de programação da Web que alimentam a Internet. Esta é a quarta parte de uma série de programação para iniciantes. Na parte 1, aprendemos o básico de ... Leia mais, o Perl já caiu no esquecimento em favor de linguagens mais modernas, como Python, Ruby e JavaScript. Muito poucas pessoas acham que vale a pena o esforço para aprender Perl nesses dias.

Mas isso não significa que a linguagem seja inútil ou obsoleta. Na verdade, muitos sites modernos e ferramentas da Web ainda contam com o Perl para operações cotidianas - incluindo Craigslist, IMDb e DuckDuckGo - então, se você estiver interessado em aprendê-lo, não deixe ninguém te impedir ou dissuadir. Você 7 Truques Úteis para Dominar uma Nova Linguagem de Programação 7 Truques Úteis para Dominar uma Nova Linguagem de Programação Não há problema em ficar sobrecarregado quando você estiver aprendendo a programar. Você provavelmente esquece as coisas tão rapidamente quanto as aprende. Essas dicas podem ajudar você a reter melhor todas essas novas informações. Consulte Mais informação .

Se você vai aprender Perl, então você também vai querer se familiarizar com o POD. Aqui está o que é isso, por que é importante e o que fazer quando você encontra esses arquivos.

O que são arquivos POD?

POD significa Plain Old Documentation, que é uma linguagem de marcação básica usada para formatar texto sem muito esforço envolvido. É semelhante à linguagem Markup Markup What Is Markdown? 4 razões pelas quais você deve aprender agora O que é o Markdown? 4 razões pelas quais você deve aprender agora Cansado dos editores HTML e WYSIWYG? Em seguida, o Markdown é a resposta para você, não importa quem você é. Leia mais, mas especificamente projetado para documentar código fonte Perl e módulos.

O POD pode ser usado de duas maneiras: ele pode existir diretamente no código-fonte de um arquivo Perl OU pode existir como um arquivo POD separado. Quando existe dentro do código, você pode pensar nisso como comentários em qualquer outra linguagem de programação, exceto mais sofisticada e mais flexível.

#!/usr/bin/perl

use estrito;

use avisos;

= pod

= Head1 Header Example

Este script faz algumas coisas legais, como isto e aquilo. Os seguintes parâmetros devem existir para que funcione corretamente. Não tente fazer isso em uma máquina com problemas.

= corte

print “Apenas este código é executado. \ n ”;

A documentação incorporada funciona bem para scripts autônomos ou quando você quer ter certeza de que qualquer um que se deparar com o arquivo também tenha acesso garantido à documentação, mas pode ser complicado quando você deseja documentar uma base de código inteira em um nível superior.

Felizmente, o POD também pode ser usado para criar páginas do tipo manual que são mais adequadas para documentos orientados ao usuário (uma vez que os usuários podem não querer se aprofundar no código-fonte de um script em si). É quando os arquivos POD são úteis.

Como ler arquivos POD

Para ser claro, a documentação incorporada do POD é encontrada nos arquivos de script Perl reais entre as linhas de código, e esses arquivos de script vêm em um dos dois formatos de extensão: .PL ou .PM. Quando você vê uma extensão .POD, isso indica que o arquivo é puro e não inclui código-fonte.

Embora seja possível abrir arquivos POD em qualquer editor de texto, incluindo o Bloco de notas, você provavelmente só desejará fazer isso se estiver realmente editando a própria documentação. Pense nisso como abrir um arquivo HTML em um editor: com toda a marcação, o conteúdo real do texto é difícil de ler.

edição de documentação de pod

Em vez disso, você deve usar algum tipo de ferramenta de leitura que use a documentação do POD e apresente-a de maneira fácil de ler.

A maneira mais fácil é usar a ferramenta de linha de comando perldoc que é incluída automaticamente quando o Perl é instalado em seu sistema. A maioria dos sistemas OS X e Linux vem com o Perl já instalado, mas os usuários do Windows terão que instalá-lo manualmente. (Felizmente, não é mais difícil do que executar um arquivo de instalação.)

Agora inicie a linha de comando, navegue até onde o arquivo POD está localizado e digite perldoc [.POD file] para visualizá-lo como formatado corretamente. Por exemplo, se o arquivo foi denominado library.pod, você perldoc library.pod e é isso.

Como converter POD para outros formatos

Mesmo que a ferramenta perldoc não seja muito difícil de usar, não é exatamente conveniente quando você deseja compartilhar a documentação com outras pessoas ou quando quiser lê-la longe do seu computador. É quando você pode querer considerar a conversão em outro formato.

Convertendo para HTML: Instale e use a ferramenta pod2html que fornece uma maneira fácil de converter qualquer arquivo POD em um arquivo HTML legível. Infelizmente, ele só pode realizar uma conversão um para um (para que você não possa combinar vários arquivos POD em um único arquivo HTML).

Convertendo para PDF: Instale e use a ferramenta pod2pdf, que é semelhante e tão fácil de usar quanto a ferramenta pod2html acima, exceto que ela é convertida em PDF em vez de HTML.

Outra opção seria converter POD para HTML usando o método mostrado acima, abrir o arquivo HTML em um navegador como o Chrome ou o Firefox e imprimir a página como PDF.

pod-documentation-markdown

Convertendo para Markdown: Instale e use a ferramenta pod2markdown para traduzir entre POD e Markdown. O Markdown é uma linguagem de marcação de uso geral, o que significa que os usuários têm maior probabilidade de estar familiarizados com ela e há mais ferramentas disponíveis que podem aceitar e exibir o Markdown.

Convertendo para LaTeX: Instale e use a ferramenta pod2latex. O LaTeX é outra linguagem de marcação, uma que é menos comum que o Markdown, mas ainda mais popular que o POD. LaTeX é usado principalmente em documentos acadêmicos e científicos, mas caso você precise, este conversor existe.

Convertendo para texto sem formatação: Instale e use a ferramenta pod2text, que produz um arquivo somente texto com formatação baseada em ASCII. Você provavelmente não precisará usar isto, mas caso você já saiba, saiba que a opção existe.

Esta postagem foi útil?

Depois que você pegar o jeito, os arquivos POD são extremamente simples e convenientes de usar. Há uma curva de aprendizado, mas é muito pequena - especialmente se você já usou uma linguagem de marcação antes. Espero que agora você se sinta confortável lidando com arquivos POD.

Se você está se sentindo sobrecarregado, pergunte a si mesmo estas questões importantes para codificadores novatos 4 Perguntas a se fazer antes de aprender Como codificar 4 perguntas a se fazer antes de aprender Como codificar Aprender uma linguagem de programação é algo popular. Mas é para todos? Antes de se comprometer com isso, faça as seguintes perguntas e seja honesto. Consulte Mais informação . Ter dificuldade não significa necessariamente que você não está destinado a ser um programador 6 Sinais de que você não está destinado a ser um programador 6 Sinais de que você não está destinado a ser um programador Nem todo mundo é cortado para ser um programador. Se você não tem certeza absoluta de que deve ser um programador, aqui estão alguns sinais que podem apontar você na direção certa. Leia mais, mas é importante ser honesto consigo mesmo e gerenciar suas expectativas.

Dito isto, preste atenção a essas dicas para aprender a programar sem estresse. Como aprender a programar sem todo o estresse Como aprender a programar sem todo o estresse Talvez você tenha decidido seguir a programação, seja para uma carreira ou apenas como um hobby. Ótimo! Mas talvez você esteja começando a se sentir sobrecarregado. Não é tão bom. Aqui está a ajuda para facilitar sua jornada. Leia mais e saber como dizer bons tutoriais de codificação de ruim O que faz um bom tutorial de programação? O que faz um bom tutorial de programação? Nem todos os tutoriais de programação são iguais. Alguns beneficiam você e outros acabam perdendo seu tempo. Aqui está o que procurar em um tutorial de programação de qualidade. Consulte Mais informação .

O que você está usando Perl para? Tem outras dicas para compartilhar ou perguntas a fazer? Deixe-nos saber nos comentários abaixo!

In this article