Jak otwierać i konwertować POD na PDF, aby czytać dokumentację Perla

Reklama

Chociaż to było kiedyś język integralny do programowania w Internecie Jakiego języka programowania się uczyć - programowanie siecioweDzisiaj przyjrzymy się różnym językom programowania sieci, które napędzają Internet. To czwarta część serii dla początkujących. W części 1 poznaliśmy podstawy ... Czytaj więcej , Perl jest teraz na uboczu na korzyść bardziej nowoczesnych języków, takich jak Python, Ruby i JavaScript. Bardzo niewiele osób uważa, że ​​warto dziś nauczyć się Perla.

Ale to nie znaczy, że język jest bezużyteczny lub przestarzały. W rzeczywistości wiele nowoczesnych witryn i narzędzi internetowych nadal korzysta z Perla w codziennych operacjach - w tym Craigslist, IMDb i DuckDuckGo - więc jeśli chcesz się tego nauczyć, nie pozwól nikomu Cię zatrzymać ani odwieść 7 przydatnych sztuczek do opanowania nowego języka programowaniaPodczas nauki kodowania możesz być przytłoczony. Prawdopodobnie zapomnisz o rzeczach tak szybko, jak się ich nauczysz. Te wskazówki pomogą ci lepiej zachować wszystkie nowe informacje. Czytaj więcej .

Jeśli chcesz nauczyć się Perla, musisz także zapoznać się z POD. Oto, co to jest, dlaczego jest to ważne i co zrobić, gdy napotkasz takie pliki.

Co to są pliki POD?

POD oznacza Plain Old Documentation, który jest podstawowym językiem znaczników używanym do formatowania tekstu bez większego wysiłku. Jest podobny do język znaczników Markdown Co to jest Markdown? 4 powody, dla których powinieneś się tego teraz nauczyćMasz już dość edytorów HTML i WYSIWYG? Zatem Markdown jest dla ciebie odpowiedzią bez względu na to, kim jesteś. Czytaj więcej , ale specjalnie zaprojektowany do dokumentowania kodu źródłowego i modułów Perla.

POD można używać na dwa sposoby: może istnieć bezpośrednio w kodzie źródłowym pliku Perl LUB może istnieć jako osobny plik POD. Jeśli istnieje w kodzie, możesz myśleć o nim jak o komentarzach w dowolnym innym języku programowania, z wyjątkiem bardziej wyszukanych i bardziej elastycznych.

#! / usr / bin / perl

stosować ścisłe;

używać ostrzeżeń;

= strąk

= nagłówek Przykład nagłówka 1

Ten skrypt robi fajne rzeczy, takie jak to i tamto. Aby działał poprawnie, muszą istnieć następujące parametry. Nie próbuj tego robić na komputerze z problemami.

= cięcie

print „Wykonywany jest tylko ten kod. \ n ”;

Dokumentacja osadzona działa dobrze w przypadku samodzielnych skryptów lub gdy chcesz mieć pewność, że każdy, kto napotka plik, również ma zagwarantowany dostęp do dokumentacji, ale może być kłopotliwy, gdy chcesz udokumentować całą bazę kodu w wyższej wersji poziom.

Na szczęście POD można również wykorzystać do tworzenia stron o typie ręcznym, które lepiej nadają się do dokumentów zorientowanych na użytkownika (ponieważ użytkownicy mogą nie chcieć zagłębiać się w kod źródłowy samego skryptu). Wtedy przydają się pliki POD.

Jak czytać pliki POD

Dla jasności, osadzona dokumentacja POD znajduje się w rzeczywistych plikach skryptów Perla pomiędzy wierszami kodu, a te pliki skryptów mają jeden z dwóch formatów rozszerzeń: .PL lub .PM. Gdy zobaczysz rozszerzenie .POD, oznacza to, że plik jest czystą dokumentacją i nie zawiera kodu źródłowego.

Chociaż można otwierać pliki POD w dowolnym edytorze tekstu, w tym w Notatniku, prawdopodobnie chcesz to zrobić tylko wtedy, gdy edytujesz samą surową dokumentację. Pomyśl o tym jak o otwarciu pliku HTML w edytorze: przy wszystkich znacznikach trudno jest odczytać rzeczywistą treść tekstu.

Zamiast tego powinieneś użyć jakiegoś narzędzia czytającego, które pobiera surową dokumentację POD i przedstawia ją w sposób łatwy do odczytania.

Najprostszym sposobem jest użycie perldoc narzędzie wiersza poleceń, które jest automatycznie dołączane, kiedy Perl jest zainstalowany w twoim systemie. Większość systemów OS X i Linux jest już z zainstalowanym Perlem, ale użytkownicy Windows będą musieli go zainstalować ręcznie. (Na szczęście nie jest to trudniejsze niż uruchomienie pliku instalatora).

Teraz uruchom wiersz polecenia, przejdź do lokalizacji pliku POD i wpisz perldoc [plik .POD] aby wyświetlić go jako poprawnie sformatowanego. Na przykład, jeśli plik został nazwany biblioteka.pod wtedy napiszesz perldoc library.pod i to wszystko.

Jak przekonwertować POD na inne formaty

Nawet jeśli perldoc narzędzie nie jest zbyt trudne w użyciu, nie jest szczególnie wygodne, gdy chcesz udostępnić dokumentację innym osobom lub gdy chcesz odczytać ją poza komputerem. Wtedy możesz rozważyć konwersję na inny format.

Konwersja do HTML: Zainstaluj i użyj pod2html narzędzie, które zapewnia łatwy sposób na przetłumaczenie dowolnego pliku POD na czytelny plik HTML. Niestety może wykonywać tylko konwersję jeden do jednego (więc nie można łączyć wielu plików POD w jeden plik HTML).

Konwersja do formatu PDF: Zainstaluj i użyj pod2pdf narzędzie, które jest podobne i równie łatwe w użyciu, jak narzędzie pod2html powyżej, z tym że konwertuje ono na format PDF, a nie HTML.

Inną opcją byłoby przekonwertowanie POD na HTML przy użyciu metody pokazanej powyżej, otwarcie pliku HTML w przeglądarce takiej jak Chrome lub Firefox, a następnie wydrukowanie strony jako PDF.

Konwersja na obniżkę: Zainstaluj i użyj pod2markdown narzędzie do tłumaczenia między POD i Markdown. Markdown jest językiem znaczników ogólnego przeznaczenia, co oznacza, że ​​użytkownicy chętniej go znają, a dostępnych jest więcej narzędzi, które mogą akceptować i wyświetlać Markdown.

Konwersja do LaTeX: Zainstaluj i użyj pod2latex narzędzie. LaTeX to kolejny język znaczników, który jest mniej popularny niż Markdown, ale wciąż bardziej popularny niż POD. LaTeX jest używany głównie w dokumentach naukowych i naukowych, ale w razie potrzeby ten konwerter istnieje.

Konwertowanie na zwykły tekst: Zainstaluj i użyj pod2text narzędzie, które tworzy plik tekstowy z formatowaniem opartym na ASCII. Prawdopodobnie nie będziesz musiał tego używać, ale na wszelki wypadek wiedz, że istnieje taka opcja.

Czy ten post był pomocny?

Gdy już się zorientujesz, pliki POD są niezwykle proste i wygodne w użyciu. Jest trochę krzywej uczenia się, ale jest bardzo niewielka - zwłaszcza jeśli wcześniej używałeś języka znaczników. Mam nadzieję, że teraz czujesz się swobodnie w pracy z plikami POD.

Jeśli czujesz się przytłoczony, zadaj sobie te pytania ważne pytania dla początkujących programistów 4 pytania, które należy sobie zadać przed nauczeniem się kodowaniaPopularna jest nauka języka programowania. Ale czy to dla wszystkich? Zanim się do tego zobowiązasz, zadaj sobie następujące pytania i bądź szczery. Czytaj więcej . Trudności niekoniecznie muszą to oznaczać nie masz zamiaru być programistą 6 znaków, że nie jesteś programistąNie każdy jest programistą. Jeśli nie masz całkowitej pewności, że chcesz zostać programistą, oto kilka znaków, które mogą skierować Cię w dobrym kierunku. Czytaj więcej , ale ważne jest, aby być uczciwym wobec siebie i zarządzać swoimi oczekiwaniami.

Biorąc to pod uwagę, zwróć uwagę na te wskazówki nauka kodowania bez stresu Jak nauczyć się programowania bez stresuMoże zdecydowałeś się kontynuować programowanie, czy to dla kariery, czy dla hobby. Wspaniały! Ale może zaczynasz czuć się przytłoczony. Nie za dobrze. Oto pomoc w ułatwieniu podróży. Czytaj więcej i wiedząc jak odróżnić dobre samouczki kodowania od złych Co stanowi dobry poradnik programowania?Nie wszystkie samouczki dotyczące programowania są sobie równe. Niektóre przynoszą korzyści Tobie, a inne marnują Twój czas. Oto, czego szukać w samouczku programowania jakości. Czytaj więcej .

Do czego używasz Perla? Masz jeszcze jakieś wskazówki lub pytania? Daj nam znać w komentarzach poniżej!