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

Anuncio

Aunque alguna vez fue un lenguaje integral para programación web Qué lenguaje de programación aprender: programación webHoy vamos a echar un vistazo a los diversos lenguajes de programación web que impulsan Internet. Esta es la cuarta parte de una serie de programación para principiantes. En la parte 1, aprendimos lo básico de ... Lee mas , 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 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 confían en Perl para las operaciones diarias, incluidos Craigslist, IMDb y DuckDuckGo, por lo que si está interesado en aprenderlo, no dejes que nadie te detenga o te disuada 7 trucos útiles para dominar un nuevo lenguaje de programaciónEstá bien sentirse abrumado cuando aprende a codificar. Probablemente olvidará las cosas tan rápido como las aprenda. Estos consejos pueden ayudarlo a retener mejor toda esa 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 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 a el lenguaje de marcado Markdown ¿Qué es Markdown? 4 razones por las que deberías aprenderlo ahora¿Cansado de los editores HTML y WYSIWYG? Entonces Markdown es la respuesta para ti sin importar quién seas. Lee mas , 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

uso estricto;

usar advertencias;

= vaina

= encabezado1 Ejemplo de encabezado

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

= cortar

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

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

Afortunadamente, POD también se puede utilizar para crear páginas de tipo manual que se adaptan mejor a los documentos orientados al usuario. (ya que los usuarios pueden no querer profundizar 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 incrustada 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 vea una extensión .POD, indica que el archivo es pura 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, probablemente solo desee hacerlo si realmente está editando la 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 comando 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 tendrán que instalarlo manualmente. (Afortunadamente, no es más difícil que ejecutar un archivo instalador).

Ahora inicie la línea de comando, navegue hasta donde se encuentra el archivo POD y escriba perldoc [archivo .POD] para verlo con el formato correcto. Por ejemplo, si el archivo fue nombrado library.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 otras personas o cuando desea leerla desde su computadora. Es entonces cuando es posible que desee considerar la conversión a otro formato.

Conversión a HTML: Instalar y usar el pod2html herramienta 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: Instalar y usar el pod2pdf herramienta, 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 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.

Conversión a Markdown: Instalar y usar el pod2markdown herramienta 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: Instalar y usar el pod2latex herramienta. 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: Instalar y usar el pod2text herramienta, que produce un archivo de solo texto con formato basado en ASCII. Probablemente no necesite usar esto, pero en caso de que lo haga, sepa que existe la opción.

¿Fue útil esta publicación?

Una vez que lo domine, los archivos POD son extremadamente simples y convenientes 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 tratando con archivos POD.

Si te sientes abrumado, pregúntate esto preguntas importantes para los programadores novatos 4 preguntas que debe hacerse antes de aprender a codificarAprender 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 debes ser programador 6 señales de que no debes ser programadorNo todos están hechos para ser programadores. Si no está completamente seguro de que está destinado a ser un programador, aquí hay algunas señales que pueden indicarle la dirección correcta. Lee mas , pero es importante ser honesto contigo mismo y gestionar tus expectativas.

Dicho esto, preste atención a estos consejos para aprendiendo a codificar sin estrés Cómo aprender a programar sin todo el estrésQuizás hayas decidido dedicarte a la programación, ya sea para una carrera o simplemente como un hobby. ¡Excelente! Pero tal vez estés empezando a sentirte abrumado. No muy bien. Aquí hay ayuda para facilitar su viaje. Lee mas y sabiendo cómo distinguir los buenos tutoriales de codificación de los malos ¿Qué hace un buen tutorial de programación?No todos los tutoriales de programación son iguales. Algunos te benefician y otros terminan perdiendo tu tiempo. Esto es lo que debe buscar en un tutorial de programación de calidad. Lee mas .

¿Para qué estás usando Perl? ¿Tienes otros consejos para compartir o preguntas para hacer? ¡Háganos saber en los comentarios a continuación!