SZARP PLC HOWTO | ||
---|---|---|
Poprzedni | Rozdział 13. Automatycznie generowana dokumentacja do programów technologicznych przy użyciu skryptu docgen | Następny |
Istnieje możliwość generowania plików PDF. Format PDF, w porównaniu z html ma kilka zalet:
Jest formatem skompresowanym, więc teoretycznie zajmuje mniej miejsca.
Jest formatem zwartym, w jednym pliku znajduje się zarówno text jak i grafika.
Dokument w formacie PDF jest w przeciwieństwie do html, plikiem wyrenderowanym tzn. na każdym komputerze, jak i na wydruku będzie wyglądał tak samo.
Istnieje możliwość prostego podziału na strony, dodanie nagłówków, stopek i numerów stron.
Do generowania plików PDF wykorzystany został odpowiednio skonfigurowany program OpenOffice.org. Aby go wstępnie skonfigurować należy:
Zainstalować pakiet:
# apt-get install openoffice.org-headlessktóry umożliwia wykonywanie skryptów StarBasic z linii poleceń.
Na koncie użytkownika, na którym będzie dokonywana konwersja zainstalować następujący skrypt:
$ cp ~/programy/trunk/utils/docgen/Module1.xba ~/.openoffice.org2/user/basic/Standard/
UWAGA! Przed dalszymi czynnościami należy zapisać i zamknąć wszystkie otwarte dokumenty w OpenOffice.org gdyż istnieje ryzyko utraty danych!
W celu wygenerowania dokumentacji w formacie PDF należy wykonać polecenie:
$ ./docgen.pl weze -pW przypadku, gdy chcemy, aby pierwsza strona nie zaczynała się od "1", tylko od dowolnej liczby, należy wydać polecenie:
$ ./docgen.pl weze -o <przesunięcie>gdzie: <przesunięcie> - liczba pierwszych stron jakie mają być pominięte. Przykładowo, jeśli istnieje potrzeba numeracji stron począwszy od "10" należy wydać polecenie:
$ ./docgen.pl weze -o 9Generowanie dokumentacji w formacie PDF jest procesem bardziej złożonym niż html dlatego też jest procesem dużo dłuższym i trwa przeciętnie od kilku do kilkunastu sekund.
Poprzedni | Spis treści | Następny |
Dobre zwyczaje obowiązujące przy pisaniu dokumentacji | Początek rozdziału | Tworzenie wzorów na potrzeby dokumentacji z wykorzystaniem programu LaTeX |