Как открыть и конвертировать POD в PDF для чтения документации Perl

Рекламное объявление

Хотя это было когда-то интегральный язык для веб-программирования Какой язык программирования выучить - веб-программированиеСегодня мы собираемся взглянуть на различные языки веб-программирования, которые питают Интернет. Это четвертая часть серии программ для начинающих. В части 1 мы изучили основы ... Подробнее Теперь Perl отошел на второй план в пользу более современных языков, таких как Python, Ruby и JavaScript. Мало кто думает, что в наши дни стоит учить Perl.

Но это не значит, что язык бесполезен или устарел. Фактически, многие современные веб-сайты и веб-инструменты по-прежнему полагаются на Perl для повседневных операций, включая Craigslist, IMDb и DuckDuckGo, поэтому, если вы заинтересованы в его изучении, не позволяйте никому останавливать вас или отговаривать вас 7 полезных приемов для освоения нового языка программированияЭто нормально, когда вы учитесь кодировать. Вы, вероятно, забудете вещи так же быстро, как выучите их. Эти советы помогут вам лучше сохранить всю эту новую информацию. Подробнее .

Если вы собираетесь изучать Perl, вы также захотите познакомиться с POD. Вот что это такое, почему это важно и что делать, когда вы запускаете такие файлы.

Что такое файлы POD?

POD расшифровывается как Plain Old Documentation, который является основным языком разметки, который используется для форматирования текста без особых усилий. Это похоже на язык разметки Markdown Что такое уценка? 4 причины, почему вы должны изучить это сейчасУстали от HTML и WYSIWYG редакторов? Тогда Markdown - это ответ для вас, кто бы вы ни были. Подробнее , но специально разработан для документирования исходного кода и модулей Perl.

POD можно использовать двумя способами: он может существовать непосредственно в исходном коде файла Perl ИЛИ он может существовать как отдельный файл POD. Когда он существует в коде, вы можете думать о нем как о комментариях на любом другом языке программирования, кроме более изящного и более гибкого.

#! / USR / бен / Perl

использовать строгое;

использовать предупреждения;

= стручок

= head1 Пример заголовка

Этот сценарий делает некоторые интересные вещи, как и то и это. Для правильной работы должны существовать следующие параметры. Не пытайтесь делать это на машине с проблемами.

= покрой

print «Только этот код выполняется. \ П»;

Встроенная документация хорошо работает для автономных скриптов или когда вы хотите убедиться, что любой, кто сталкивается с файлом, также имеет гарантированный доступ к документации, но это может быть громоздким, если вы хотите документировать всю кодовую базу на более высоком уровень.

К счастью, POD также можно использовать для создания страниц ручного типа, которые лучше подходят для ориентированных на пользователя документов (поскольку пользователи могут не захотеть копаться в исходном коде самого скрипта). Вот когда POD файлы пригодятся.

Как читать файлы POD

Чтобы быть понятным, встроенная документация POD находится в реальных файлах сценариев Perl между строками кода, и эти файлы сценариев имеют один из двух форматов расширения: .PL или .PM. Когда вы видите расширение .POD, это означает, что файл является чистой документацией и не содержит исходного кода.

Хотя открыть файлы POD можно в любом текстовом редакторе, включая Блокнот, вы, вероятно, захотите это сделать, только если вы действительно редактируете исходную документацию. Думайте об этом, как об открытии файла HTML в редакторе: со всей разметкой фактический текстовый контент трудно читать.

Вместо этого вы должны использовать какой-то инструмент для чтения, который берет сырую документацию POD и представляет ее в удобном для чтения виде.

Самый простой способ - это использовать perldoc инструмент командной строки, который автоматически включается при Perl установлен в вашей системе. Большинство систем OS X и Linux поставляются с уже установленным Perl, но пользователи Windows должны будут установить его вручную. (К счастью, это не сложнее, чем запустить установочный файл.)

Теперь запустите командную строку, перейдите туда, где находится файл POD, и введите perldoc [.POD файл] чтобы просмотреть его как правильно отформатированный. Например, если файл был назван library.pod тогда вы наберете perldoc library.pod и это все.

Как конвертировать POD в другие форматы

Хотя perldoc инструмент не слишком сложен в использовании, он не совсем удобен, когда вы хотите поделиться документацией с другими или когда вы хотите прочитать ее с вашего компьютера. Вот когда вы можете рассмотреть возможность преобразования в другой формат.

Преобразование в HTML: Установите и используйте pod2html инструмент, который обеспечивает простой способ перевести любой файл POD в читаемый HTML-файл. К сожалению, он может выполнять только однозначное преобразование (поэтому вы не можете объединить несколько файлов POD в один файл HTML).

Преобразование в PDF: Установите и используйте pod2pdf инструмент, который похож и так же прост в использовании, как и инструмент pod2html выше, за исключением того, что он конвертируется в PDF, а не в HTML.

Другой вариант - преобразовать POD в HTML, используя метод, показанный выше, открыть файл HTML в браузере, например Chrome или Firefox, а затем распечатать страницу в формате PDF.

Преобразование в уценку: Установите и используйте pod2markdown инструмент для перевода между POD и Markdown. Markdown - это язык разметки общего назначения, означающий, что пользователи, скорее всего, знакомы с ним, и есть больше инструментов, которые могут принимать и отображать Markdown.

Преобразование в LaTeX: Установите и используйте pod2latex инструмент. LaTeX - это другой язык разметки, менее распространенный, чем Markdown, но все же более популярный, чем POD. LaTeX в основном используется в научных и научных документах, но, если вам это нужно, этот конвертер существует.

Преобразование в обычный текст: Установите и используйте pod2text инструмент, который производит текстовый файл с ASCII-форматированием. Вероятно, вам не нужно будет использовать это, но если вы когда-нибудь это сделаете, знайте, что опция существует.

Был ли этот пост полезным?

Как только вы освоите его, POD-файлы станут чрезвычайно простыми и удобными в использовании. Существует некоторая кривая обучения, но она очень незначительна, особенно если вы раньше использовали язык разметки. Надеюсь, теперь вам удобно работать с файлами POD.

Если вы чувствуете себя подавленным, спросите себя: важные вопросы для начинающих программистов 4 вопроса, которые нужно задать себе, прежде чем научиться писать кодИзучение языка программирования популярно. Но это для всех? Перед тем, как сделать это, задайте себе следующие вопросы и будьте честны. Подробнее . Трудность не обязательно означает, что ты не должен быть программистом 6 признаков того, что вы не должны быть программистомНе каждый хочет быть программистом. Если вы не совсем уверены, что должны быть программистом, вот некоторые признаки, которые могут указать вам верное направление. Подробнее , но важно быть честным с собой и управлять своими ожиданиями.

Как говорится, прислушайтесь к этим советам научиться кодировать без стресса Как научиться программированию без стрессаВозможно, вы решили заняться программированием, будь то для карьеры или просто как хобби. Большой! Но, может быть, вы начинаете чувствовать себя разбитым. Не так здорово Вот помощь, чтобы облегчить ваше путешествие. Подробнее и зная как отличить хорошие учебники по кодированию от плохих Что делает хороший учебник по программированию?Не все учебники по программированию сделаны равными. Некоторые приносят пользу вам, а другие заканчивают тем, что теряют ваше время. Вот что нужно искать в учебнике по качественному программированию. Подробнее .

Для чего вы используете Perl? Есть какие-либо другие советы, которыми можно поделиться или вопросы задать? Дайте нам знать в комментариях ниже!