doclifter - Online w chmurze

PROGRAM:

IMIĘ

doclifter - tłumaczy żądania Troffa na DocBook

STRESZCZENIE

doklifter [-mi kodowanie] [-H plik podpowiedzi] [-q] [-x] [-v] [-w] [-V] [-D token=typ] [-I ścieżka]
[-I ścieżka] filet...

OPIS

doklifter tłumaczy dokumenty zapisane w makrach troffa na DocBook. Podzbiory strukturalne
żądania w mężczyzna(7) mdoc(7) ms(7) me(7) mm(7), a troff(1) są obsługiwane.

Tłumaczenie odzwierciedla całą strukturę oryginalnego dokumentu w sekcji,
podrozdziału i poziomu akapitu. Streszczenia poleceń i funkcji C są tłumaczone na
Znaczniki DocBook, a nie tylko dosłowne wyświetlanie. Tabele (znaczniki TBL) są tłumaczone na
Znaczniki tabeli DocBook. Diagramy PIC są tłumaczone na format SVG. Informacje na poziomie Troffa
mogące mieć konsekwencje strukturalne, jest zachowywane w komentarzach XML.

Tam, gdzie to możliwe, makra zmiany czcionki są tłumaczone na znaczniki strukturalne. doklifter
rozpoznaje stereotypowe wzorce znaczników i treści (takie jak użycie kursywy w a
FILES, aby zaznaczyć nazwy plików) i podnosi je. Sposób edycji, dodawania i zapisywania semantyki
obsługiwane są wskazówki dotyczące wyróżniania.

Niektóre klisze są rozpoznawane i podnoszone do znaczników strukturalnych nawet bez wyróżniania.
Rozpoznawane wzorce obejmują takie elementy, jak adresy URL, adresy e-mail, odniesienia do stron podręcznika i
Listy programów w języku C.

Tag . i ti prośby są przekazywane wraz ze skargami. Wskazują
znaczniki na poziomie prezentacji doklifter nie można przełożyć na strukturę; wyjście będzie
wymagają ręcznego mocowania.

Tag .za zostaje rozpatrzona w drodze reklamacji, chyba że następuje ona bezpośrednio po treści SMS
linie zawierają tabulatory, w takim przypadku podnoszony jest następujący zakres linii zawierających tabulatory
do stołu.

W pewnych okolicznościach doklifter może nawet podnieść sformatowane strony podręcznika i tekst
produkcja wytworzona przez ryś(1) z HTML. Jeśli nie znajdzie żadnych makr na wejściu, ale znajdzie
nagłówka sekcji NAME, próbuje zinterpretować zwykły tekst jako stronę podręcznika (pomijanie
nagłówki i stopki szablonów wygenerowane przez ryś(1)). Powstałe w ten sposób tłumaczenia
będzie skłonny do pominięcia cech strukturalnych, ale to rozwiązanie jest wystarczające dla prostego człowieka
stron.

doklifter nie wykonuje swojej pracy idealnie, a jedynie zaskakująco dobrze. Ostateczne polerowanie powinno
być stosowane przez człowieka zdolnego do rozpoznawania wzorców zbyt subtelnych dla komputera. Ale
doklifter prawie zawsze tworzy tłumaczenia, które są na tyle dobre, że można je było wykorzystać wcześniej
hakowanie ręczne.

Zobacz sekcję Rozwiązywanie problemów, aby dowiedzieć się, jak rozwiązać problem konwersji dokumentów
problemy.

OPCJE

Jeśli zostanie wywołany bez argumentów doklifter działa jak filtr, włączając wejście źródła troffa
standardowe wejście do znaczników DocBook na standardowym wyjściu. Jeśli wywołane z argumentami, each
plik argumentów jest tłumaczony osobno (ale wskazówki zostają zachowane, patrz poniżej); przyrostek
Do przetłumaczonego wyniku podawany jest plik .xml.

-h
Nazwij plik, do którego powinny trafić informacje o wskazówkach semantycznych zebranych podczas analizy
napisany.

-D
Połączenia -D pozwala na opublikowanie podpowiedzi. Może się to przydać np. jeśli doklifter is
błędna analiza streszczenia, ponieważ nie rozpoznaje tokenu jako polecenia. Ta wskazówka jest
scalone po przeczytaniu podpowiedzi w źródle wejściowym.

-I
Połączenia -I opcja dodaje swój argument do ścieżki dołączania używanej podczas wyszukiwania przez docfilter
inkluzje. Ścieżka dołączania to początkowo tylko bieżący katalog.

-e
Połączenia -e umożliwia ustawienie pola kodowania, które będzie emitowane w wyjściowym formacie XML. To
domyślnie ISO-8859-1 (Latin-1).

-q
Zwykle o to prosi doklifter nie mogłem zinterpretować (zwykle dlatego, że są
na poziomie prezentacji) są przekazywane do komentarzy XML na wyjściu. Opcja -q
tłumi to. Pomija także listę makr. Wiadomości o prośbach o to
są nierozpoznane lub nie można ich przetłumaczyć, przejdź do błędu standardowego, niezależnie od stanu
ta opcja. Ta opcja ma na celu zmniejszenie bałaganu, gdy uważasz, że masz plik
czyste podniesienie dokumentu i chcesz stracić dziedzictwo Troffa.

-x
Opcja -x tego wymaga doklifter wygenerowano plik XML zgodny z DocBookiem w wersji 5
zawartość, a nie domyślne wyjście DocBook w wersji 4.4. Inkluzje i byty
mogą nie być obsługiwane poprawnie przy włączonym tym przełączniku.

-v
Opcja -v powoduje, że doklifter głośniej o tym, co robi. Jest to przydatne głównie do
debugowanie.

-w
Włącz ścisłe sprawdzanie przenośności. Wiele wystąpień opcji -w zwiększa ścisłość.
Zobacz sekcję zatytułowaną „SPRAWDZANIE PRZENOŚNOŚCI”.

-V
Dzięki tej opcji program wysyła komunikat o wersji i kończy działanie.

TŁUMACZENIE ZASADY

Ogólnie rzecz biorąc, można się spodziewać, że zmiany czcionek zostaną przekształcone w makra wyróżnienia za pomocą ponownego mapowania
atrybut pobrany z nazwy czcionki troff. Podstawowe nazwy czcionek to R, I, B, U, CW i SM.

Ucieczki znaków specjalnych Troffa i makropakietów są mapowane na jednostki znakowe ISO.

Kiedy doklifter spotyka .so dyrektywy, szuka pliku. Jeśli uda się to przeczytać
uzyskaj dostęp do pliku i otwórz go, a plik składa się wyłącznie z wierszy poleceń i
komentarze, zostaną one uwzględnione. Jeśli którykolwiek z tych warunków nie zostanie spełniony, odwołanie do jednostki dla
jest generowane.

doklifter wykonuje specjalną analizę, gdy rozpoznaje wyświetlacz taki, jak jest generowany przez
.DS/.DE. Wielokrotnie próbuje najpierw przeanalizować streszczenie funkcji, a następnie usunąć zwykły tekst
co pozostaje na wyświetlaczu. W ten sposób większość wbudowanych prototypów funkcji C zostanie przeniesiona do
znaczniki strukturalne.

Kilka uwag na temat konkretnych tłumaczeń:

Mężczyzna Tłumaczenie
doklifter wykonuje dobrą robotę na większości stron podręcznika, wie o rozszerzonych UR/UE/UN i URL
żądania obsługiwane pod Linuksem. Jeśli w ogóle .UR żądanie jest obecne, przetłumaczy je, ale
nie zawijaj adresów URL poza nimi tagami Ulink. Wie również o rozszerzeniu .L (dosłowny)
znaczniki czcionek z Bell Labs w wersji 8 i jego przyjaciół.

Połączenia .TH makro służy do generowania sekcji RefMeta. Jeżeli występuje, data/źródło/instrukcja
argumenty (zob mężczyzna(7)) są opakowane w pary znaczników RefMiscInfo z tymi atrybutami klasy.
Należy pamiętać, że doklifter nie zmienia daty.

doklifter wykonuje specjalną analizę, gdy rozpoznaje sekcję streszczenia. To wielokrotnie
próbuje najpierw przeanalizować streszczenie funkcji, następnie streszczenie poleceń, a następnie zwykły tekst
co pozostało w tej sekcji.

Następujące makra man są tłumaczone na znaczniki wyróżnienia z atrybutem remap: .B, .I,
.L, .BI, .BR, .BL, IB, .IR, .IL, Rozszerzenie pliku RB, .RI, .RL, .FUNT, .LI, .LR, .SB, SM. Niektórzy stereotypowo
wzorce obejmujące te makra są rozpoznawane i przekształcane w znaczniki semantyczne.

Następujące makra są tłumaczone na podziały akapitów: LP, .PP, .P, HPi
jednoargumentowa forma .IP.

Forma dwuargumentowa .IP jest tłumaczone albo jako Lista Zmiennych (zwykle) lub
ItemizedList (jeśli tagiem jest punktor lub znak kwadratowy Troffa).

Poniższe makra są tłumaczone semantycznie: .CII,.SS, .TP, .UR, .UE, ONZ, .IX, ZA ONZ
zadzwoń tuż przed .CII or .SS ustawia identyfikator nowej sekcji.

Połączenia \*R, \*(Tm, \*(tzw, \*(r.p symbole są tłumaczone.

Następujące makra (czysto na poziomie prezentacji) są ignorowane: .PD,.DT.

Połączenia .RS/.ODNOŚNIE makra są tłumaczone w różny sposób w zależności od tego, czy poprzedzają, czy nie
znaczniki listy. Gdy .RS następuje tuż przed .TP or .IP wynikiem są listy zagnieżdżone. W przeciwnym razie,
dotychczasowy .RS/.ODNOŚNIE jest tłumaczona na parę tagów Blockquote.

.DS/.Z nie jest częścią udokumentowanego zestawu makr man, ale jest rozpoznawany, ponieważ się pojawia
z pewną częstotliwością na starszych stronach podręcznika starszych Uniksów.

Niektóre makra rozszerzeń pierwotnie zdefiniowane w Ultrixie są tłumaczone strukturalnie,
włączając te, które okazjonalnie pojawiają się na stronach podręcznika Linuksa i innych
Uniksy o otwartym kodzie źródłowym. .BYŁY/.ee (i synonimy .Były/.Ee), .Ds/De,

.NT/NE, .PN, .SM są tłumaczone strukturalnie.

Rozpoznawane są także następujące makra rozszerzeń używane w dystrybucji X
przetłumaczone strukturalnie: .FD, .FN, .W, .ZN, hN, .C{/.C} Połączenia .TA i .W prośby są
ignorowane.

Kiedy makro man jest aktywne, any .Pp definicja makra zawierająca żądanie .PP będzie
być ignorowane. i wszystkie przypadki .Pp zastąpiony przez .PP. Podobnie, .Tp zostanie zamieniony
w .TP. Jest to najmniej bolesny sposób radzenia sobie z niektórymi często spotykanymi
stereotypowe definicje opakowań, które w przeciwnym razie powodowałyby poważne problemy interpretacyjne

Znane obszary problemów z tłumaczeniem man:

· Dziwne zastosowania .TP. Czasami generują one nieprawidłowy kod XML, a czasami powodują błąd
Komentarz FIXME w wygenerowanym pliku XML (komunikat ostrzegawczy pojawi się również przy błędzie standardowym).

· Dyskusyjne jest, w jaki sposób człowiek makro HP i .IP bez tagu należy przetłumaczyć. My
traktuj je jak zwykłe łamanie akapitu. Moglibyśmy wizualnie symulować powieszenie
akapit ze znacznikami listy, ale nie byłoby to tłumaczenie strukturalne.

Pod2man Tłumaczenie
doklifter rozpoznaje makra rozszerzeń utworzone przez pod2man (.Cii, Sp, .Ip, .Vb, .Ve)
i tłumaczy je strukturalnie.

Wyniki podnoszenia stron wyprodukowanych przez pod2man należy dokładnie sprawdzić gałką oczną,
zwłaszcza przedstawianie streszczeń poleceń i funkcji. Pod2man generuje raczej
przewrotne znaczniki; doklifterwysiłki, aby je rozplątać, czasami kończą się niepowodzeniem.

Jeśli to możliwe, wygeneruj swój DocBook ze źródeł POD. Włączony jest moduł pod2docbook
CPAN, który to robi.

Tkmana Tłumaczenie
doklifter rozpoznaje makra rozszerzeń używane przez system dokumentacji Tcl/Tk: .AP,
.TAK JAK, .BS, .BYĆ, CS, .CE, .DS, .Z, .WIĘC, SE, UL, .VS, .VE, .AP, CS, .CE, .WIĘC, SE,
UL, .QW i .PQ makra są tłumaczone strukturalnie.

Mando Tłumaczenie
doklifter powinien być w stanie wykonać świetną robotę w większości przypadków mdoc(7) stron, bo to makro
pakiet wyraża wiele struktury semantycznej.

Znane problemy z tłumaczeniem mandoc: Wszystkie .Bd/wyd bloki wyświetlacza są tłumaczone jako
Pary znaczników LiteralLayout .

Ms Tłumaczenie
doklifter radzi sobie dobrze na większości stron ms. Jednym słabym punktem, na który należy zwrócić uwagę, jest
generowanie tagów autora i afiliacji. Heurystyki wykorzystywane do wydobywania tych informacji
z .AU sekcja przeznaczona jest dla autorów, którzy formatują swoje nazwiska w zwykły sposób
angielskie (np. „ME Lesk”, „Eric S. Raymond”), ale są dość kruche.

Aby dokument został rozpoznany jako zawierający znaczniki ms, musi mieć rozszerzenie .ms.
Pozwala to uniknąć problemów z fałszywymi alarmami.

Połączenia .TL, .AU, .MIEĆ, .AE makra zamieniają się w metainformację artykułu w oczekiwany sposób.
Połączenia .PP, LP, .CII, .NH makra przekształcają się w strukturę akapitów i sekcji. Oznaczone
forma .IP jest tłumaczone jako lista zmiennych (zwykle) lub lista pozycji (jeśli tag
to znak punktora lub kwadratu Troffa); wersja nieoznaczona jest traktowana jako zwykła
przerwa w akapicie.

Połączenia .DS/.Z pair jest tłumaczona na parę tagów LiteralLayout. The .FS/.FE para jest
przetłumaczone na parę tagów Footnote. The .QP/.QS/.QE żądania definiują BlockQuotes.

Połączenia UL zmiana czcionki jest mapowana na U. SM i .LG stają się krokami numerycznymi plus lub minus
z przyrostkiem do atrybutu Remap.

Połączenia .B1 i .B2 makra box są tłumaczone na parę tagów paska bocznego.

Wszystkie makra odnoszące się do stopek stron, trybu wielokolumnowego i blokad są ignorowane (ND, .TAM,
1C, 2C, MC, .BX, .KS, .KE, .KF). .R, .RS, .ODNOŚNIE makra są również ignorowane.

Me Tłumaczenie
Tłumaczenie moich dokumentów zwykle daje surowe wyniki, które wymagają dużo
hakowanie ręczne. Format ma mało użyteczną strukturę, a dokumenty w nim zapisane zwykle tak mają
używaj wielu niskopoziomowych makr troff; obie te właściwości mają tendencję do mylenia doklifter.

Aby dokument został rozpoznany jako zawierający znaczniki me, musi mieć rozszerzenie .me.
Pozwala to uniknąć problemów z fałszywymi alarmami.

Następujące makra są tłumaczone na podziały akapitów: lp, str, .ip makro jest
przetłumaczone na listę zmiennych. The bp makro jest tłumaczone na ItemizedList. The .np
makro jest tłumaczone na OrderedList.

Czcionki b, i i r są mapowane na znaczniki wyróżnienia z atrybutami B, I i R Remap. The
.rb („prawdziwie pogrubiona”) czcionka jest traktowana tak samo jak .b.

.Q(/.Q) jest tłumaczone strukturalnie.

Większość innych żądań jest ignorowana.

Mm Tłumaczenie
Dokumenty Memorandum Makra dobrze się tłumaczą, ponieważ te makra niosą ze sobą wiele strukturalnych
Informacja. Zasady tłumaczenia są dostosowane do stylów Memorandum lub Release Paper;
informacje związane ze stylem listu zewnętrznego zostaną zachowane w komentarzach.

Aby dokument został rozpoznany jako zawierający znacznik mm, musi mieć rozszerzenie .mm.
Pozwala to uniknąć problemów z fałszywymi alarmami.

Następujące makra podświetlenia są tłumaczone na znaczniki wyróżnienia: .B, .I, .R, .BI, .BR,
IB, .IR, Rozszerzenie pliku RB, .RI.

Następujące makra są przetłumaczone strukturalnie: .AE, AF, .GLIN, .RL, APLIKACJA, APLIKACJA, .TAK JAK,
.W, .AU, .B1, .B2, .BYĆ, .BL, ML, .BS, .BVL, .VL, .Z, DL .DS, .FE, .FS, .H, .HU, .IA,
.TJ, .IND, .FUNT, LC, LE, .LI, .P, .RF, SM, .TL, .CZERW.WYŁ, .VERBON, .WA, .MY.

Następujące makra są ignorowane:

.)MI, 1C, 2C, AST, AV, AVL, .OKŁADKA, .COVEND, .EF, .EH, .EDP, .EPICKI, .FC, .FD, .HC,
HM, .POBIERZ, .POBIERZ, HM, .INITI, .INITR, .INDP, .ISODATA, .MT, .NS, ND, .Z, .OH, .OP,
.PGFORM, .PGNH, .PE, .PF, .PH, .RP, .S, SA, SP, .SG, SK, .TAB, .TB, .TC, .VM, .TOALETA.

Następujące makra generują ostrzeżenia: .WE, .BYŁY, .FG, POBIERZ, .GETPN, .POBIERZ, .POBIERZ, LT,
.LD, LO, .PRZENOSIĆ, .MULB, .MUŁN, .MUŁ, .NCOL, .nP, .FOTKA, .R & D, .RS, .ODNOŚNIE, .SETR

.BS/.BYĆ i .IA/.TJ przepuszczane są pary. Być może należy usunąć znajdujący się w nich tekst
lub przeniesiony.

Argument znaku ML jest ignorowany; następujący identyfikator listy sformatowany normalnie
Lista wyszczególniona.

Zawartość .DS/.Z or .DF/.Z zostaje zamieniony w wyświetlacz ekranowy. Argumenty
sterujące formatowaniem na poziomie prezentacji są ignorowane.

Mwww Tłumaczenie
Makra mwww są rozszerzeniem makr man obsługiwanych przez groff(1) do produkcji sieci
stron.

Połączenia URL, FTP, POCZTA, FTP, ZDJĘCIA, TAG tagi są tłumaczone strukturalnie. The HTMLINDEX,
KOLOR SKÓRY, TŁA, HTML, LINE tagi są ignorowane.

TBL Tłumaczenie
Wszystkie cechy strukturalne tabel TBL są tłumaczone, w tym zarówno poziome, jak i
rozciąganie się w pionie za pomocą „s” i „^”. Obsługiwane są formaty „l”, „r” i „c”; Następnie'
format kolumny jest renderowany jako „r”. Kontynuacje linii z T{ i T} są obsługiwane poprawnie.
Więc jest .TH.

Połączenia rozszerzać, pudełko, podwójne pudełko, wszystkobox, centrum, lewo, prawo opcje są obsługiwane. GNU
synonimy rama i podwójna ramka są również rozpoznawane. Ale rozróżnienie między singlem i
podwójne reguły i pola zostaną utracone.

Kontynuacje tabel (.T&) nie są obsługiwane.

Jeśli pierwszy niepusty wiersz tekstu bezpośrednio przed tabelą jest pogrubiony, tak jest
interpretowane jako tytuł tabeli, a tabela jest generowana przy użyciu tabeli i tytułu.
W przeciwnym razie tabela jest tłumaczona za pomocą nieformalnego.

Większość innych poleceń TBL na poziomie prezentacji jest ignorowanych. Kwalifikator formatu „b” to
przetwarzane, ale kwalifikatory rozmiaru i szerokości punktu nie są.

Pic Tłumaczenie
Sekcje PIC są tłumaczone na SVG. doclifter woła pic2plot(1) osiągnąć
Ten; musisz mieć zainstalowane to narzędzie, aby tłumaczenie PIC działało.

Równanie Tłumaczenie
Sekcje EQN są filtrowane do osadzonego MathML za pomocą równo -TMathML jeśli to możliwe, w przeciwnym razie
przeszedł przez zawarte w tagach LiteralLayout. Po zobaczeniu instrukcji delim,
wbudowane ograniczniki eqn są tłumaczone na instrukcję przetwarzania XML. Wyjątek: wbudowany
równania eqn składające się z pojedynczego znaku są tłumaczone na podkreślenie z rolą
atrybut równania

Troffa Tłumaczenie
Tłumaczenie troffa ma jedynie wspierać interpretację zestawów makr. Nie jest
przydatny samodzielnie.

Połączenia .nf i .fi makra są interpretowane jako granice układu dosłownego. Dzwoni do .so
makro albo powoduje włączenie, albo jest tłumaczone na włączenia encji XML (patrz wyżej).
Dzwoni do ul i .cu makra powodują zawijanie kolejnych wierszy znacznikiem wyróżnienia
z atrybutem Remap „U”. Dzwoni do stopy wygeneruj odpowiedni akcent początkowy lub końcowy
tagi. Dzwoni do .tr powoduje translację znaków na wyjściu. Dzwoni do bp wygenerować
Znacznik BeginPage (tylko w tekście akapitowym). Dzwoni do sp wygeneruj podział akapitu (w
tylko tekst akapitowy). Dzwoni do ti zawiń następujący wiersz w BlockQuote. Są to
tylko żądania Troffa tłumaczymy na DocBook. Pozostała część emulacji troffa istnieje
ponieważ pakiety makr używają go wewnętrznie do rozszerzania makr na elementy, które mogą być
strukturalny.

Żądania dotyczące definicji makr i ciągów znaków (.ds, .tak jak, . De, .rano, rm, rn, em) są
przetworzone i rozszerzone. The .tj makro jest również przetwarzane.

Makra warunkowe (.Jeśli, .to znaczy, el) są obsługiwane. Wbudowane warunki o, n, t, e i c
są oceniane tak, jak w przypadku nroff na pierwszej stronie dokumentu. Troff m, d i r
Warunki warunkowe są również interpretowane. Porównania ciągów są oceniane za pomocą prostego tekstu
porównanie. Wszystkie wyrażenia numeryczne mają wartość true.

Rozszerzone żądania groffa cc, c2, ab, jak, do, nie, powrót i przesunięcie jest
zinterpretowane. Jego .PSPIC rozszerzenie jest tłumaczone na obiekt MediaObject.

Połączenia .tm makro zapisuje swoje argumenty do standardowego błędu (z -t). .po południu raporty makro dot
zdefiniowane makra i ciągi znaków. Funkcje te mogą pomóc w debugowaniu tłumaczenia.

Niektóre sekwencje ucieczki troffów są zniesione:

1. Znaki ucieczki \e i \\ stają się czystym ukośnikiem odwrotnym, \. kropka i \- goła kreska.

2. Troff ucieka \^, \`, \' \&, \0 i \| są podnoszone do równoważnego specjalnego ISO
znaki odstępu.

3. Znak \, po którym następuje spacja, jest tłumaczony na nierozdzielającą przestrzeń ISO.

4. \~ jest również tłumaczone na nierozdzielającą jednostkę przestrzenną ISO; właściwie to powinno być
spacja, której nie można wykorzystać do podziału linii, ale rozciąga się ona jak zwykła biała przerwa
dostosowanie linii, ale nie ma do tego jednostki ISO ani Unicode.

5. Ruch pionowy \u i \d wymyka się ruchowi pionowemu, gdy jest sparowany, staje się
napisany u góry or indeks tagi.

6. Wyjście \c jest traktowane jako kontynuacja linii. w okolicznościach, w których ma to znaczenie
(np. do wklejania tokenów).

7. Klawisz \f zmiany czcionki jest tłumaczony na różne sposoby, w zależności od kontekstu. Pierwszy,
doklifter szuka klisz związanych ze zmianami czcionek, które mają znaczenie semantyczne, oraz
podnosi do znacznika strukturalnego. Jeśli nie może tego zrobić, generuje znacznik wyróżnienia.

8. Rozszerzenie \m[] jest tłumaczone na zakres fraz z atrybutem remap
kolor. Uwaga: arkusze stylów zazwyczaj tego nie renderują!

9. Niektóre zastosowania żądania \o są tłumaczone: w parach z literą, po której następuje jedno z
znaki ` ' : ^ o ~ są tłumaczone na łączenie form z ostrymi znakami diakrytycznymi,
odpowiednio grób, umlaut, daszek, pierścień i tylda, jeśli odpowiadają im Latin-1
lub znak Latin-2 istnieje jako literał ISO.

Inne ucieczki niż te spowodują ostrzeżenia lub błędy.

Wszystkie inne żądania troffa są ignorowane, ale przekazywane do komentarzy XML. Kilka (np
.ten) również powodują wyświetlenie komunikatu ostrzegawczego.

RUCHLIWOŚĆ SPRAWDŹ

Gdy włączone jest sprawdzanie przenośności, doklifter emituje ostrzeżenia o przenośności dotyczące znaczników
z którymi sobie poradzi, ale które złamią innych widzów i tłumaczy.

1. Na poziomie 1 będzie ostrzegał o konstrukcjach, które mogą się zepsuć man2html(1), (C
program dystrybuowany z Linuksem mężczyzna(1), a nie starszy i znacznie mniej wydajny Perl
scenariusz). Bliska pochodna tego kodu jest używana w GNOME yelp. To powinno być
minimalny poziom przenośności, do jakiego dążysz i odpowiada temu, co jest zalecane
dotychczasowy groff_man(7) strona podręcznika.

2. Na poziomie 2 będzie ostrzegać o konstrukcjach, które zakłócają przenośność z powrotem do
Klasyczne narzędzia Uniksa (w tym długie nazwy makr i odniesienia do glifów za pomocą \[]).

SEMANTYCZNY ANALIZA

doklifter przechowuje dwie listy wskazówek semantycznych, które pobiera z analizowanego źródła
dokumenty (zwłaszcza z analizowania streszczeń poleceń i funkcji). Lista lokalna
obejmuje:

· Nazwy argumentów formalnych funkcji

· Nazwy opcji poleceń

Podpowiedzi lokalne służą do oznaczenia poszczególnych stron, z których zostały zebrane. The
lista globalna obejmuje:

· Nazwy funkcji

· Nazwy poleceń

· Nazwy typów zwracanych funkcji

If doklifter zostanie zastosowany do wielu plików, lista globalna zostanie zachowana w pamięci. Możesz
zrzuć raport z globalnymi wskazówkami na koniec uruchomienia za pomocą -h opcja. Format
wskazówki są następujące:

.\" | znak Jak

gdzie jest elementem tekstu i to tekst znaczników DocBook, jaki powinien być
zawijane za każdym razem, gdy pojawiało się jako podświetlone lub jako słowo otoczone białymi znakami
w tekście źródłowym.

Wskazówki pochodzące z wcześniejszych plików są stosowane także w późniejszych. Takie zachowanie może być
przydatne podczas podnoszenia kolekcji dokumentów, które mają zastosowanie do funkcji lub biblioteki poleceń.
Bardziej przydatny powinien być fakt, że plik podpowiedzi został zrzucony -h może być jednym z
plik argumentów do doklifter; kod wykrywa ten specjalny przypadek i nie zapisuje kodu XML
wyjście dla takiego pliku. Zatem dobrą procedurą podnoszenia dużej biblioteki jest generowanie
plik wskazówek przy pierwszym uruchomieniu, sprawdź go, aby usunąć fałszywe alarmy i użyj go jako pliku wskazówek
pierwsze wejście do drugiego przebiegu.

Możliwe jest także dołączenie pliku podpowiedzi bezpośrednio do pliku źródłowego troffa. To może być
przydatne, jeśli chcesz wzbogacić plik etapami przed konwersją do formatu XML.

ROZWIĄZYWANIE PROBLEMÓW

doklifter stara się ostrzegać o problemach, które może zdiagnozować, ale których sam nie rozwiąże.
Gdy pojawi się komunikat „szukaj FIXME”, zrób to w wygenerowanym formacie XML; znacznik wokół tego tokena
może być nie tak.

Czasami (mniej niż 2% czasu) doklifter spowoduje nawet utworzenie nieprawidłowych znaczników DocBook
z prawidłowego znacznika Troff. Zwykle wynika to z dziwnych konstrukcji w źródle
stronę lub wywołania makr, które przekraczają możliwości doklifterprocesor makro, aby uzyskać
Prawidłowy. Oto kilka rzeczy, na które należy zwrócić uwagę i jak je naprawić:

Zniekształcony komenda streszczenia.
Jeśli zostanie wyświetlony komunikat „Analiza streszczenia poleceń nie powiodła się”, spróbuj przepisać streszczenie
w źródle strony podręcznika. Najczęstszą przyczyną niepowodzeń są niezrównoważone [] ugrupowania, a
błąd, który może być bardzo trudny do zauważenia gałką oczną. Aby pomóc w tym, błąd
wiadomość zawiera numer tokena w nawiasie wskazujący, na którym tokenie analiza nie powiodła się.

Aby uzyskać więcej informacji, użyj opcji -v. Spowoduje to wyświetlenie zrzutu informującego o tym, co
streszczenie polecenia wyglądało po wstępnym przetworzeniu i wskaż, na którym tokenie przeprowadzono analizę
nie powiodło się (zarówno z numerem tokena, jak i znakiem karetki wstawionym w zrzucie streszczenia
tokeny). Spróbuj przepisać streszczenie w źródle strony podręcznika. Najczęstszą przyczyną
awarią jest niezrównoważone [] grupowanie, błąd, który może być bardzo trudny do zauważenia gałką oczną.
Aby w tym pomóc, zrzut tokenu błędu próbuje wstawić „$” w ostatnim miejscu
zwiększenie głębokości zagnieżdżenia, ale kod, który to robi, jest podatny na awarie.

Mylące makro wzywa.
Niektórzy autorzy stron podręcznika zastępują standardowe żądania (np .PP, .CII i .TP) z wersjami
które robią różne rzeczy nroff i troff środowiska. Chwila doklifter próbuje sobie poradzić
i zwykle wykonuje dobrą robotę, dziwactwami [nt]roffa jest mnóstwo i mylących wywołań makr
czasami prowadzą do wygenerowania nieprawidłowego kodu XML. Typowym objawem takich problemów jest niezamknięty
Tagi podkreślające.

Zniekształcony podstęp składnia.
Parser strony podręcznika może być mylony .TP konstrukcje, które mają znaczniki nagłówka, ale nie
następujące ciało. Jeśli wygenerowany kod XML nie sprawdza się, a problem wydaje się być następujący
źle umieszczony tag listitem, spróbuj użyć szczegółowej opcji (-v). Umożliwi to numerowanie linii
ostrzeżenia, które mogą pomóc w rozwiązaniu problemu.

Sekcja gniazdowania problemy w H.H.
Komunikat „możliwy błąd zagnieżdżenia sekcji” oznacza, że ​​program zobaczył dwie sąsiadujące ze sobą
nagłówki podrozdziałów. Na stronach podręcznika podsekcje nie mają argumentu głębokości, więc doklifter
nie można mieć pewności, jak powinny być zagnieżdżone podsekcje. Dowolny nagłówek podsekcji pomiędzy
wskazany wiersz i początek następnej sekcji najwyższego poziomu może być błędny i wymagać
poprawianie ręcznie.

Łazienka wydajność w Nie doklifter błąd wiadomość
Jeśli tłumaczysz stronę korzystającą z makr zdefiniowanych przez użytkownika, a doclifterowi się to nie udaje
narzekasz, ale otrzymujesz złe wyniki, pierwszą rzeczą do zrobienia jest uproszczenie lub wyeliminowanie
makra zdefiniowane przez użytkownika. Jeśli to możliwe, zastąp je żądaniami magazynowymi.

POPRAWA TŁUMACZENIE JAKOŚĆ

Jest kilka konstrukcji, które warto sprawdzić ręcznie po podniesieniu strony.

Spójrz w pobliżu tagów BlockQuote. Żądanie tymczasowego wcięcia troffa (ti) jest tłumaczone na
opakowanie BlockQuote wokół następującego wiersza. Czasami LiteralLayout lub ProgramListing
byłoby lepszym tłumaczeniem, ale doklifter nie ma możliwości się tego dowiedzieć.

Nie jest możliwe jednoznaczne wykrycie kandydatów do zawinięcia w znaczniku opcji DocBook
w bieżącym tekście. Jeśli Ci zależy, musisz je sprawdzić i naprawić ręcznie.

Skorzystaj z docliftera online, korzystając z usług onworks.net