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

Aunque alguna vez fue un lenguaje integral para la programación web Qué lenguaje de programación aprender - Programación web Qué lenguaje de programación aprender - Programación web Hoy vamos a echar un vistazo a los distintos lenguajes de programación web que impulsan 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 lenguajes 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 aún dependen de Perl para las operaciones diarias, incluidos Craigslist, IMDb y DuckDuckGo, por lo que si está interesado en aprenderlo, no permita que nadie lo detenga o disuade. 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 aprende. Estos consejos pueden ayudarlo a conservar mejor toda la información nueva. 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 tales archivos.

¿Qué son los archivos POD??

POD significa Plain Old Documentation, que es un lenguaje de marcado básico que se utiliza para dar formato al texto sin mucho esfuerzo. Es similar al lenguaje de marcas Markdown ¿Qué es Markdown? 4 razones por las que deberías aprenderlo ahora ¿Qué es Markdown? 4 razones por las que deberías aprenderlo ¿Estás cansado de los editores HTML y WYSIWYG? Entonces Markdown es la respuesta para ti, no importa quién seas. Leer más, pero específicamente diseñado para documentar el código fuente y los módulos de Perl.

POD se puede utilizar 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, puedes considerarlo como comentarios en cualquier otro lenguaje de programación, excepto en los más sofisticados y flexibles..

#! / usr / bin / perl

uso estricto

utilizar advertencias;

= vaina

= head1 Ejemplo de encabezado

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

impresión “Solo se ejecuta este código. \norte”;

La documentación incrustada funciona bien con scripts independientes o cuando desea asegurarse de que cualquier persona que encuentre el archivo también tenga garantizado el acceso a la documentación, pero puede ser engorroso cuando desea documentar una base de código completa a 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 (ya que los usuarios pueden no querer ahondar en el código fuente de un script en sí). Ahí es cuando los archivos POD son útiles.

Cómo leer archivos POD

Para ser claros, la documentación POD incorporada se encuentra dentro de los archivos de script Perl reales entre líneas de código, y estos archivos de script vienen en uno de dos formatos de extensión: .PL o .PM. Cuando ve una extensión .POD, indica que el archivo es solo documentación y no incluye código fuente.

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

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

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

Ahora inicie la línea de comando, navegue hasta donde se encuentra el archivo POD y escriba perldoc [archivo .pod] para verlo correctamente formateado. Por ejemplo, si el archivo fue nombrado biblioteca.pod entonces escribirías perldoc library.pod y eso es.

Cómo convertir POD a otros formatos

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

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

Convertir a PDF: Instale y use la herramienta pod2pdf, que es similar y tan fácil de usar como la herramienta pod2html anterior, excepto que se convierte en PDF en lugar de HTML.

Otra opción sería convertir POD a HTML usando 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.

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 que haya más herramientas que puedan aceptar y mostrar Markdown..

Convertir a LaTeX: Instala y usa 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.

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

Fue útil esta publicación?

Una vez que lo dominas, los archivos POD son extremadamente simples y cómodos de usar. Hay una pequeña curva de aprendizaje, pero es muy pequeña, especialmente si ha usado un lenguaje de marcado anteriormente. Esperemos que ahora se sienta cómodo al tratar con archivos POD.

Si se siente abrumado, hágase estas preguntas importantes para los programadores novatos 4 preguntas que debe hacerse antes de aprender cómo codificar 4 preguntas que debe hacerse 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 esté destinado a ser un programador. 6 Signos de que no se pretende que sea un programador. 6 Signos de que no se pretende que sea un programador. No todos están hechos para ser programadores. Si no está completamente seguro de estar destinado a ser un programador, aquí hay algunas señales que pueden indicar la dirección correcta. Lee más, pero es importante ser honesto contigo mismo y gestionar tus expectativas.

Dicho esto, preste atención a estos consejos para aprender cómo codificar sin estrés Cómo aprender a programar sin todo el estrés Cómo aprender a programar sin todo el estrés Tal vez haya decidido dedicarse a la programación, ya sea para una carrera o simplemente como pasatiempo. ¡Genial! Pero tal vez estás empezando a sentirte abrumado. No muy bien. Aquí hay ayuda para facilitar su viaje. Lea más y sepa cómo distinguir buenos tutoriales de codificación. ¿Qué hace un buen tutorial de programación? ¿Qué hace un buen tutorial de programación? No todos los tutoriales de programación son 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.!

Explorar más sobre: ​​Conversión de archivos, PDF, Programación.