Cómo abrir y convertir POD a PDF para leer la documentación de Perl

Un archivo POD es la antigua documentación simple del lenguaje de programación Perl. Le mostramos cómo convertir POD a PDF, HTML, Markdown, LaTeX o texto sin formato.

Un archivo POD es la antigua documentación simple del lenguaje de programación Perl.  Le mostramos cómo convertir POD a PDF, HTML, Markdown, LaTeX o texto sin formato.
Anuncio

Aunque alguna vez fue un lenguaje integral para la programación web, qué lenguaje de programación para aprender, programación web, qué lenguaje de programación para aprender, programación web Hoy vamos a echar un vistazo a los diversos lenguajes de programación web que alimentan Internet. Esta es la cuarta parte en una serie de programación para principiantes. En la parte 1, aprendimos lo básico de ... Leer más, Perl ahora se ha quedado en el camino a favor de idiomas más modernos como Python, Ruby y JavaScript. Muy pocas personas piensan que vale la pena el esfuerzo de aprender Perl en estos días.

Pero eso no significa que el lenguaje sea inútil u obsoleto. De hecho, muchos sitios web modernos y herramientas web todavía confían en Perl para las operaciones cotidianas, como Craigslist, IMDb y DuckDuckGo, por lo que si está interesado en aprenderlo, no permita que nadie lo detenga ni lo disuada. usted 7 Trucos útiles para dominar un nuevo lenguaje de programación 7 Trucos útiles para dominar un nuevo lenguaje de programación Está bien sentirse abrumado cuando está aprendiendo a codificar. Probablemente olvidará las cosas tan rápido como las aprenda. Estos consejos pueden ayudarlo a conservar mejor toda esa nueva información. Lee mas .

Si vas a aprender Perl, entonces también querrás familiarizarte con POD. Esto es lo que es, por qué es importante y qué hacer cuando se encuentra con dichos archivos.

¿Qué son los archivos POD?

POD significa "Plain Old Documentation", que es un lenguaje de marcado básico que se utiliza para formatear texto sin mucho esfuerzo. Es similar al lenguaje de marcado Markdown ¿Qué es Markdown? 4 razones por las que debería aprender ahora ¿Qué es Markdown? 4 razones por las que debería aprender ahora ¿Cansado de los editores HTML y WYSIWYG? Entonces Markdown es la respuesta para ti sin importar quién eres. Lea más, pero específicamente diseñado para documentar el código fuente y los módulos de Perl.

POD se puede usar de dos maneras: puede existir directamente dentro del código fuente de un archivo Perl O puede existir como un archivo POD separado. Cuando existe dentro del código, puede pensarlo como comentarios en cualquier otro lenguaje de programación, excepto más elegante y más flexible.

#!/usr/bin/perl

usar estricto;

usa advertencias;

= pod

= Ejemplo de encabezado head1

Este script hace algunas cosas interesantes, como esto y aquello. Los siguientes parámetros deben existir para que funcione correctamente. No intente hacer esto en una máquina con problemas.

= corte

print "Solo se ejecuta este código. \norte";

La documentación integrada funciona bien para scripts independientes o cuando desea asegurarse de que cualquier persona que se encuentre con el archivo también tenga acceso garantizado a la documentación, pero puede ser engorroso cuando quiera documentar una base de código completa en un nivel superior.

Afortunadamente, POD también se puede usar para crear páginas de tipo manual que son más adecuadas para documentos orientados al usuario (dado que los usuarios pueden no querer profundizar en el código fuente de un script en sí). Es entonces cuando los archivos POD son útiles.

Cómo leer archivos POD

Para que quede claro, la documentación de POD integrada se encuentra dentro de los archivos de script de Perl entre líneas de código, y estos archivos de script vienen en uno de los dos formatos de extensión: .PL o .PM. Cuando ve una extensión .POD, indica que el archivo es documentación pura e incluye ningún código fuente.

Si bien es posible abrir archivos POD en cualquier editor de texto, incluido el Bloc de notas, probablemente solo desee hacerlo si realmente está editando la documentación en bruto. Piense que es como abrir un archivo HTML en un editor: con todo el marcado, el contenido de texto real es difícil de leer.

pod-documentation-editing

En su lugar, debe usar algún tipo de herramienta de lectura que tome la documentación POD en bruto y la presente de una manera fácil de leer.

La forma más fácil es usar la herramienta de línea de comandos perldoc que se incluye automáticamente cuando Perl está instalado en su sistema. La mayoría de los sistemas OS X y Linux vienen con Perl ya instalado, pero los usuarios de Windows deberán instalarlo manualmente. (Afortunadamente, no es más difícil que ejecutar un archivo instalador).

Ahora inicie la línea de comandos, navegue hasta donde se encuentra el archivo POD y escriba perldoc [.POD file] para verlo con el formato perldoc [.POD file] . Por ejemplo, si el archivo se llamaba library.pod, perldoc library.pod y eso es todo.

Cómo convertir POD a otros formatos

Aunque la herramienta perldoc no es demasiado difícil de usar, no es exactamente conveniente cuando desea compartir la documentación con otros o cuando desea leerla de su computadora. Es entonces cuando es posible que desee considerar la conversión a otro formato.

Conversión a HTML: instale y use la herramienta pod2html, que proporciona una manera fácil de traducir cualquier archivo POD en un archivo HTML legible. Desafortunadamente, solo puede realizar una conversión de uno a uno (por lo que no puede combinar varios archivos POD en un solo archivo HTML).

Conversión a PDF: instale y use la herramienta pod2pdf, que es similar e igual de fácil de usar que la herramienta pod2html anterior, excepto que se convierte en PDF en lugar de HTML.

Otra opción sería convertir POD a HTML utilizando el método que se muestra arriba, abrir el archivo HTML en un navegador como Chrome o Firefox, y luego imprimir la página como PDF.

pod-documentation-markdown

Convertir a Markdown: instale y use la herramienta pod2markdown para traducir entre POD y Markdown. Markdown es un lenguaje de marcado de propósito general, lo que significa que es más probable que los usuarios estén familiarizados con él y hay más herramientas que pueden aceptar y mostrar Markdown.

Conversión a LaTeX: instale y use la herramienta pod2latex. LaTeX es otro lenguaje de marcado, uno que es menos común que Markdown, pero aún más popular que POD. LaTeX se utiliza principalmente en documentos académicos y científicos, pero en caso de que lo necesite, este convertidor existe.

Conversión a texto sin formato : instale y use la herramienta pod2text, que produce un archivo de solo texto con formato ASCII. Probablemente no necesite usar esto, pero en caso de que lo haga, sepa que la opción existe.

¿Fue útil esta publicación?

Una vez que lo dominas, los archivos POD son extremadamente simples y fáciles de usar. Hay un poco de una curva de aprendizaje, pero es muy leve, especialmente si has usado un lenguaje de marcas antes. Con suerte, ahora se siente cómodo con los archivos POD.

Si se siente abrumado, hágase estas preguntas importantes para los codificadores de novatos. 4 Preguntas que debe hacerse antes de aprender Cómo codificar 4 preguntas que debe formularse antes de aprender Cómo codificar Aprender un lenguaje de programación es popular. ¿Pero es para todos? Antes de comprometerse, hágase las siguientes preguntas y sea honesto. Lee mas . Tener dificultades no significa necesariamente que no se supone que seas un programador 6 Señales de que no se pretende ser un programador 6 Señales de que no se pretende ser programador No todo el mundo está decidido a ser un programador. Si no estás completamente seguro de que debes ser un programador, aquí hay algunos signos que pueden orientarte en la dirección correcta. Lea más, pero es importante ser honesto consigo mismo y administrar sus expectativas.

Una vez dicho esto, preste atención a estos consejos para aprender a programar sin estrés Cómo aprender a programar sin todo el estrés Cómo aprender a programar sin todo el estrés Quizás haya decidido seguir con la programación, ya sea para una carrera o simplemente como un hobby. ¡Estupendo! Pero tal vez estás empezando a sentirse abrumado. No muy bien. Aquí hay ayuda para facilitar su viaje. Lea más y sepa cómo distinguir los buenos tutoriales de codificación de los malos tutoriales ¿Qué hace que una buena programación? ¿Qué hace un buen tutorial de programación? No todos los tutoriales de programación se hacen iguales. Algunos te benefician y otros terminan perdiendo el tiempo. Esto es lo que debe buscar en un tutorial de programación de calidad. Lee mas .

¿Para qué estás usando Perl? ¿Tienes algún otro consejo para compartir o preguntas para hacer? Háganos saber en los comentarios a continuación!

In this article