dtplite - Online w chmurze

PROGRAM:

IMIĘ

dtplite — lekki procesor znaczników DocTools

STRESZCZENIE

dtplit -o wydajność ?opcje? format plik wejściowy

dtplit uprawomocnić plik wejściowy

dtplit -o wydajność ?opcje? format katalog wejściowy

dtplit -łączyć -o wydajność ?opcje? format katalog wejściowy

_________________________________________________________________________________________________

OPIS

Aplikacja opisana w tym dokumencie, dtplit, jest następcą niezwykle
prosty mprozwiń. Wpływ na jego funkcjonalność ma m.in dtp procesor doctools to dużo
mocniejszy niż mprozwiń, a mimo to równie łatwy w użyciu; zdecydowanie łatwiej niż dtp z jego
mnóstwo podpoleceń i opcji.

dtplit opiera się na pakiecie dokumenty, podobnie jak pozostałe dwa procesory.

UŻYWAĆ OBUDOWY
dtplit został napisany z myślą o następujących trzech przypadkach użycia.

[1] Zatwierdzenie pojedynczego dokumentu, czyli sprawdzenie, czy został sporządzony w sposób ważny
formacie doctools. Tego trybu można również użyć do uzyskania wstępnej wersji pliku
sformatowane wyjście dla pojedynczego dokumentu, do wyświetlenia w przeglądarce, nroff itp.,
umożliwiając korektę formatowania.

[2] Generowanie sformatowanej dokumentacji dla pojedynczego pakietu, tj. wszystkich
stron podręcznika, a także spis treści i indeks słów kluczowych.

[3] Rozszerzenie poprzedniego trybu pracy, sposób na łatwe generowanie
jedno drzewo dokumentacji dla kilku pakietów, a zwłaszcza ujednoliconej tabeli
zawartość i indeks słów kluczowych.

Oprócz powyższego chcemy także skorzystać z funkcji dostosowywania udostępnianych przez
Formater HTML. Nie jest to jedyny format, który aplikacja powinna być w stanie wygenerować, ale
spodziewamy się, że będzie on najczęściej używany i jest jednym z niewielu, które to zapewniają
haczyki do personalizacji.

Pozwalamy wywołującemu określić ciąg nagłówka, ciąg stopki, arkusz stylów i dane dla
pasek łączy nawigacyjnych u góry wygenerowanego dokumentu. Chociaż wszystko można ustawić jako
o ile silnik formatowania zapewnia odpowiedni parametr silnika (patrz sekcja
OPCJE) dwa ostatnie mają wewnętrzne przetwarzanie, które czyni je specyficznymi dla HTML.

COMMAND LINE
dtplit -o wydajność ?opcje? format plik wejściowy
To jest formularz przypadku użycia [1]. The Opcje zostanie wyjaśnione w dalszej części rozdziału
OPCJE.

ścieżka wydajność (w)
Ten argument określa, gdzie zapisać wygenerowany dokument. Może to być
ścieżka do pliku lub katalogu, lub -. Ostatnia wartość powoduje, że aplikacja
zapisz wygenerowane udokumentowane do stdout.

Jeśli wydajność nie istnieje, to [nazwa katalogu pliku $wyjście] musi istnieć i
musi być katalogiem z możliwością zapisu. Wygenerowany dokument zostanie zapisany w formacie a
plik w tym katalogu, a nazwa tego pliku będzie pochodzić z
plik wejściowyThe formati wartość podaną opcji -wewnętrzny (Jeśli obecny).

(ścieżka|uchwyt) format (w)
Ten argument określa aparat formatowania, który ma być używany podczas przetwarzania pliku
danych wejściowych, a tym samym format wygenerowanego dokumentu. Patrz sekcja FORMATY
dla możliwości rozpoznawanych przez aplikację.

ścieżka plik wejściowy (w)
Ten argument określa ścieżkę do pliku do przetworzenia. Musi istnieć,
muszą być czytelne i zapisane dokumenty Format.

dtplit uprawomocnić plik wejściowy
Jest to prostsza forma przypadku użycia [1]. Format „validate” nie generuje żadnych danych wyjściowych
w ogóle przeprowadzane jest tylko sprawdzanie składni. Jako taka specyfikacja wyjścia
plik lub inne opcje nie są konieczne i pominięte.

dtplit -o wydajność ?opcje? format katalog wejściowy
To jest formularz przypadku użycia [2]. Różni się od formy przypadku użycia [1] przez
posiadanie dokumentów wejściowych określonych poprzez katalog zamiast pliku. The
pozostałe argumenty są identyczne, z wyjątkiem wydajność, który teraz musi być ścieżką do
istniejący i zapisywalny katalog.

Wszystkie dokumenty wejściowe znajdują się w plikach katalog wejściowy lub którykolwiek z jego podkatalogów
które zostały uznane przez fileutil:: typ pliku jako zawierający tekst w dokumenty Format.

dtplit -łączyć -o wydajność ?opcje? format katalog wejściowy
To jest formularz przypadku użycia [3]. Jedyna różnica w stosunku do formularza przypadku użycia [2]
jest opcją dodatkową -łączyć.

Każde takie wywołanie spowoduje połączenie wygenerowanych dokumentów pochodzących z przetwarzania danych wejściowych
dokumenty pod katalog wejściowy lub którykolwiek z jego podkatalogów do plików znajdujących się w katalogu
wydajność. W ten sposób możliwe jest stopniowe budowanie ujednolicenia
dokumentacja dla dowolnej liczby pakietów. Pamiętaj, że trzeba przebiec
wszystkie pakiety dwukrotnie, aby uzyskać w pełni poprawne odsyłacze (dla formatów
ich wspieranie).

OPCJE
W tej sekcji opisano wszystkie opcje dostępne dla użytkownika aplikacji, m.in
z wyjątkiem opcji -o oraz -łączyć. Te dwa zostały już opisane w rozdziale
COMMAND LINE.

-wykluczać ciąg
Ta opcja określa wzorzec wykluczania (glob). Wszelkie pliki zidentyfikowane jako strony podręcznika
do procesu, które pasują do wzorca wykluczania, są ignorowane. Opcja może być zapewniona
wielokrotnie, przy czym każde użycie dodaje dodatkowy wzorzec do listy wykluczeń.

-wewnętrzny ciąg
Jeśli nazwa pliku wyjściowego ma pochodzić od nazwy pliku wejściowego, to
będzie używać nazwy format domyślnie jako rozszerzenie. Ta opcja tutaj będzie
zastąpić to jednak, zmuszając go do użycia ciąg jako rozszerzenie pliku. Ta opcja
jest ignorowany, jeśli nazwa pliku wyjściowego jest w pełni określona za pomocą opcji -o.

W przypadku wielokrotnego użycia, istotna jest tylko ostatnia definicja.

-nagłówek filet
Opcji tej można użyć wtedy i tylko wtedy, gdy jest zaznaczona format zapewnia silnik
parametr o nazwie „nagłówek”. Pobiera zawartość określonego pliku i przypisuje
je do tego parametru, niezależnie od zastosowania przez silnik. Silnik HTML wstawi
tekst tuż za tagiem . Jeśli dostępne są przyciski nawigacyjne (patrz opcja
-nawigacja poniżej), następnie wygenerowany dla nich kod HTML jest dołączany do danych nagłówka
pochodzące stąd przed ostatecznym przypisaniem do parametru.

W przypadku wielokrotnego użycia, istotna jest tylko ostatnia definicja.

-stopka filet
Jak -nagłówek, z tą różnicą, że: Wszelkie przyciski nawigacyjne są ignorowane, odpowiednio
wymagany parametr silnika nosi nazwę „footer”, a dane są wstawiane tuż przed nim
tag .

W przypadku wielokrotnego użycia, istotna jest tylko ostatnia definicja.

-Style filet
Opcji tej można użyć wtedy i tylko wtedy, gdy jest zaznaczona format zapewnia silnik
parametr o nazwie „meta”. Po określeniu wygeneruje fragment kodu HTML
deklarując filet jako arkusz stylów wygenerowanego dokumentu i przypisz go do
parametr. Silnik HTML wstawi to do dokumentu, tuż po
etykieta .

Podczas przetwarzania katalogu wejściowego plik arkusza stylów jest kopiowany na wyjście
katalog, a wygenerowany kod HTML będzie odnosił się do kopii, aby wynik był większy
samowystarczalny. Podczas przetwarzania pliku wejściowego nie mamy lokalizacji, w której można go skopiować
arkusz stylów, więc po prostu odwołuj się do niego zgodnie z opisem.

W przypadku wielokrotnego użycia, istotna jest tylko ostatnia definicja.

-toc ścieżka
Ta opcja określa plik doctoc, który ma być używany zamiast spisu treści
generując własne.

W przypadku wielokrotnego użycia, istotna jest tylko ostatnia definicja.

-pre+toc ścieżka etykiety|tekst

-post + spis ścieżka etykiety|tekst
Ta opcja określa dodatkowe pliki doctoc (lub teksty) do wykorzystania w nawigacji
bar.

Pozycjonowanie i obsługa wielu zastosowań jest taka sama jak w przypadku opcji -prenav oraz -postnawigacja,
patrz poniżej.

-nawigacja adres URL etykiety

-prenav adres URL etykiety
Użyj tej opcji, aby określić przycisk nawigacyjny za pomocą etykieta wyświetlić i url do
łączyć z. Opcji tej można użyć wtedy i tylko wtedy, gdy jest zaznaczona format zapewnia
parametr silnika o nazwie „header”. Wygenerowany w tym celu kod HTML jest dołączony do
niezależnie od danych, które otrzymaliśmy z opcji -nagłówek zanim zostanie wstawiony do wygenerowanego pliku
dokumentów.

W przypadku wielokrotnego użycia wszystkie definicje są gromadzone i wyświetlany jest pasek nawigacyjny
utworzony, z pierwszą definicją pokazaną przy lewej krawędzi i ostatnią definicją
w prawo.

Adres URL może być względny. W takim przypadku zakłada się, że jest on względny w stosunku do głównego
(TOC i indeks słów kluczowych) i zostaną przekształcone, aby wszystkie inne nadal mogły zawierać linki
prawidłowo.

-postnawigacja adres URL etykiety
Użyj tej opcji, aby określić przycisk nawigacyjny za pomocą etykieta wyświetlić i url do
łączyć z. Opcji tej można użyć wtedy i tylko wtedy, gdy jest zaznaczona format zapewnia
parametr silnika o nazwie „header”. Wygenerowany w tym celu kod HTML jest dołączony do
niezależnie od danych, które otrzymaliśmy z opcji -nagłówek zanim zostanie wstawiony do wygenerowanego pliku
dokumentów.

W przypadku wielokrotnego użycia wszystkie definicje są gromadzone i wyświetlany jest pasek nawigacyjny
utworzony, z ostatnią definicją pokazaną przy prawej krawędzi i pierwszą definicją
lewo.

Adres URL może być względny. W takim przypadku zakłada się, że jest on względny w stosunku do głównego
(TOC i indeks słów kluczowych) i zostaną przekształcone, aby wszystkie inne nadal mogły zawierać linki
prawidłowo.

FORMATY
Na początku format argument będzie traktowany jako ścieżka do pliku tcl zawierającego kod
dla żądanego silnika formatowania. Argument będzie traktowany jako nazwa jednego z
predefiniowane formaty wymienione poniżej wtedy i tylko wtedy, gdy ścieżka nie istnieje.

Note a ograniczenie: Jeśli traktujesz format jako ścieżkę do skryptu tcl implementującego
silnik zakończył się sukcesem, wówczas ten skrypt musi implementować nie tylko API silnika
doctools, tj doctools_api, ale dla doctoc_api oraz docidx_api również. W przeciwnym razie
wygenerowanie spisu treści i indeksu słów kluczowych zakończy się niepowodzeniem.

Lista predefiniowanych formatów, tj. takich jakie udostępnia pakiet dokumenty:

nroff Procesor generuje dane wyjściowe *roff, standardowy format stron podręcznika systemu UNIX.

html Procesor generuje dane wyjściowe w formacie HTML do wykorzystania i wyświetlania przez przeglądarki internetowe. Ten
silnik jest obecnie jedynym, który zapewnia różne wymagane parametry silnika
w celu dodatkowego dostosowania wyników.

tmml Procesor generuje dane wyjściowe TMML, pochodną języka Tcl Manpage Markup Language
XML-a.

lateks Procesor generuje dane wyjściowe LaTeX.

wiki Procesor generuje znaczniki Wiki w rozumieniu wiki.

podstęp Procesor pobiera informacje dostarczone przez strona_manpage_początek. Ten format jest
używane wewnętrznie do wyodrębniania metadanych, z których pochodzą zarówno spis treści, jak i
indeks słów kluczowych pochodzi z.

zero Procesor nie generuje żadnych danych wyjściowych. Jest to równoważne uprawomocnić.

KATALOG STRUKTURY
W tej sekcji opisujemy struktury katalogów generowane przez aplikację w ramach
wydajność podczas przetwarzania wszystkich dokumentów w pliku katalog wejściowy. Innymi słowy, jest to tylko
istotne dla przypadków użycia [2] i [3].

[2] Podczas przetwarzania pojedynczego zestawu danych wejściowych tworzona jest następująca struktura katalogów
dokumenty. Używane rozszerzenie pliku służy do wyprowadzania danych w formacie HTML, ale nie ma to znaczenia
do struktury i został po prostu użyty do posiadania odpowiednich nazw plików.

wyjście/
toc.html
index.html
pliki /
ścieżka/do/FOO.html

Ostatnia linia w przykładzie pokazuje dokument wygenerowany dla pliku FOO znajdującego się pod adresem

katalog wejściowy/ścieżka/do/FOO

[3] Podczas łączenia wielu pakietów w jednolity zbiór dokumentów generowany jest katalog
struktura jest nieco głębsza:

wydajność
.toc
.idx
.tocdoc
.idxdoc
.xrf
toc.html
index.html
FOO1/
...
FOO2/
toc.html
pliki /
ścieżka/do/BAR.html

Każdy z katalogów FOO1, ... zawiera dokumenty wygenerowane dla pakietu
FOO1, ... i ma strukturę pokazaną dla przypadku użycia [2]. Jedynym wyjątkiem jest
że nie ma indeksu przypadającego na pakiet.

Pliki ".toc"".idx", I".xrf„zawierają wewnętrzny status całości
wyjściowe i zostaną odczytane i zaktualizowane przy następnym wywołaniu. Ich zawartość nie będzie
być udokumentowane. Usuń te pliki, gdy wszystkie pakiety potrzebne do uzyskania danych wyjściowych zostaną już usunięte
przetworzone, tj. po zakończeniu przetwarzania danych wyjściowych.

Pliki ".tocdoc", I".idxdoc", są plikami pośrednimi w doctoc i docidx
odpowiednio znacznik zawierający główny spis treści i indeks słów kluczowych
komplet dokumentów przed ich konwersją do wybranego formatu wyjściowego. Oni są
pozostawione na miejscu, tj. nie usunięte, aby służyć jako demonstracje doctoc i docidx
narzut.

Korzystaj z dtplite online, korzystając z usług onworks.net