SZARP PLC HOWTO | ||
---|---|---|
Poprzedni | Rozdział 13. Automatycznie generowana dokumentacja do programów technologicznych przy użyciu skryptu docgen | Następny |
Do dokumentacji, wewnątrz komentarza, można wstawić formułę matematyczną zapisaną w formacie LaTeX. Zostanie ona przetworzona na obrazek w formacie PNG. Początek formuły zaznaczamy dyrektywą:
<!-- formula - start(nazwa) -->Podana nazwa będzie używana jako podstawa nazwy pliku z utworzonym obrazkiem - sam obrazek będzie umieszczony w pliku nazwa.png. Formułę kończymy dyrektywą:
<!-- formula - stop -->Jeśli chcemy mieć wpływ na wielkość obrazka końcowego, możemy do dyrektywy końcowej dołączyć opcjonalny parametr oznaczający rozdzielczość (ang. density) wynikowego pliku PNG. Wtedy dyrektywa kończąca wygląda następująco:
<!-- formula - stop(density) -->Pomiędzy dyrektywy początkową i końcową możemy wstawić dowolne wyrażenie LaTeX (szerszy opis tworzenia wzorów z wykorzystaniem języka LaTeX znaleźć można tu: Rozdział 14), bez pustych linii (!). Przykład:
<!-- formula - start(test) --> I(z) = \sin( \frac{\pi}{2} z^2 ) \sum_{n=0}^\infty \frac{ (-1)^n \pi^{2n} }{1 \cdot 3 \cdots (4n + 1) } z^{4n + 1} -\cos( \frac{\pi}{2} z^2 ) \sum_{n=0}^\infty \frac{ (-1)^n \pi^{2n + 1} }{1 \cdot 3 \cdots (4n + 3) } z^{4n + 3} <!-- formula - stop -->Przy wpisywaniu formuł przydatne jest również ich numerowanie, dzięki któremu można się później w tekście komentarza odwołać do danej formuły po jej numerze. Aby nadać formule numer (będzie on wyświetlany obok formuły, przy prawej krawędzi strony), należy dyrektywę początku formuły zapisać następująco:
<!-- formula - start(nazwa, numer) -->
Prostsze formuły matematyczne warto jest zapisywać bezpośrednio w formacie HTML, aby nie generować zbędnych grafik. Jednak i tutaj przydatna jest możliwość numerowania takich formuł - można to uzyskać dzięki dyrektywie przypisującej danemu blokowi tekstu podany numer. Jej początek wygląda następująco:
<!-- numbered - start(numer) -->Koniec tej dyrektywy wygląda następująco:
<!-- numbered - stop -->Pomiędzy można wpisać dowolny tekst (np. wzór formuły), który ma zostać oznaczony podanym numerem.
Poprzedni | Spis treści | Następny |
Dołączanie komentarzy z zewnętrznych plików | Początek rozdziału | Parametryzowanie komentarza zmiennymi |