a2x - Online w chmurze

PROGRAM:

IMIĘ

a2x - Menedżer łańcucha narzędzi dla AsciiDoc (konwertuje pliki tekstowe Asciidoc na inny plik)
formaty)

STRESZCZENIE

a2x [OPCJE] PLIK ŹRÓDŁOWY

OPIS

Menedżer łańcucha narzędzi DocBook, który tłumaczy plik tekstowy AsciiDoc PLIK ŹRÓDŁOWY do PDF,
EPUB, DVI, PS, LaTeX, XHTML (pojedyncza strona lub fragmentarycznie), strona podręcznika, pomoc HTML lub zwykły tekst
formaty używające asciidoc(1) i inne aplikacje (patrz sekcja WYMAGANIA). PLIK ŹRÓDŁOWY mogą
być również plikiem DocBook z rozszerzeniem .xml.

OPCJE

-za, --atrybut=ATRYBUT
Zestaw asciidoc(1) wartość atrybutu (skrót do --asciidoc-opts="-a ATRYBUT" opcja).
Ta opcja może być podana więcej niż raz.

--asciidoc-opts=ASCIIDOC_OPTS
Dodatkowy asciidoc(1) opcje. Ta opcja może być podana więcej niż raz.

--plik-konf=PLIK_KONF
Załaduj plik konfiguracyjny. Zobacz sekcję PLIKI KONF.

-D, --docelowy-dir=DESTINATION_DIR
Katalog wyjściowy. Domyślnie do PLIK ŹRÓDŁOWY informator. Ta opcja ma zastosowanie tylko do
Formaty wyjściowe oparte na HTML (porcje, epub, htmlpomoc, xhtml).

-D, --typ dokumentu=DOCTYP
Typ dokumentu DocBook: artykuł, strona podręcznika or książka. Domyślny typ dokumentu to artykuł
chyba że format to strona podręcznika (w takim przypadku domyślnie jest to strona podręcznika).

-B, --zaplecze=WSTECZ
WSTECZ to nazwa zainstalowanej wtyczki backendu. Gdy ta opcja jest określona a2x
próbuje wczytać nazwę pliku a2x-backend.py z WSTECZ katalog wtyczek To wtedy
konwertuje PLIK ŹRÓDŁOWY do WSTECZ sformatowany plik wyjściowy przy użyciu funkcji globalnej
zdefiniowane w a2x-backend.py nazywa do_POWRÓTEND.

-F, --format=FORMAT
Formaty wyjściowe: porcje, dokumentacja, Dvi, epub, htmlpomoc, strona podręcznika, pdf (Domyślne) ps,
tex, XNUMX, xhtml. AsciiDoc format a2x wartość atrybutu jest ustawiona na FORMAT.

-H, --help
Wypisz składnię wiersza poleceń i opcje programu na standardowe wyjście.

--ikony
Używaj obrazów ikon upomnienia lub nawigacji w dokumentach wyjściowych. Domyślne zachowanie to
używać tekstu zamiast ikon.

--ikony-dir=PATH
Ścieżka (względem plików wyjściowych) zawierająca ikony upomnień i nawigacji. Domyślne
do obrazów/ikon. ten --ikony opcja jest niejawna, jeśli ta opcja jest używana.

-k, --przechowaj-artefakty
Nie usuwaj tymczasowych plików kompilacji.

--ryś
Zastosowanie ryś(1) do generowania danych wyjściowych w formacie tekstowym. Domyślnym zachowaniem jest użycie w3m(1).

-L, --no-xmlint
Nie sprawdzaj wyjścia asciidoc za pomocą xmllint(1).

--- epubcheck
Sprawdź wyjście EPUB za pomocą epubcheck(1).

-N, --próba
Nie rób nic, tylko wydrukuj to, co zostałoby zrobione.

-R, --ratunek=ZASOBY_SPEC
Określ zasób. Ta opcja może być podana więcej niż raz. Zobacz ZASOBY
sekcja po więcej szczegółów.

-M, --manifest-zasobu=FILE
FILE zawiera listę zasobów (jeden w wierszu). Oczywisty FILE wpisy są sformatowane
tak jak --ratunek argumenty opcji. Zmienne środowiskowe i dom tyldy
katalogi są dozwolone.

--arkusz stylów=ARKUSZ STYLÓW
Rozdzielana spacjami lista zawierająca jedną lub więcej nazw plików arkuszy stylów CSS, które są używane do stylizowania
Dane wyjściowe HTML generowane przez arkusze stylów DocBook XSL. Domyślnie do docbook-xsl.css,
arkusze stylów są przetwarzane w kolejności listy. Arkusze stylów muszą znajdować się w prawidłowym
lokalizacja pliku zasobów. Dotyczy formatów HTML: xhtml, epub, porcje, htmlpomoc
formaty.

-v, --gadatliwy
Wydrukuj szczegóły operacyjne na stderr. Sekunda -v opcja stosuje opcję gadatliwą do
polecenia łańcucha narzędzi.

--wersja
Wydrukuj wersję programu na standardowe wyjście.

--xsltproc-opts=XSLTPROC_OPTS
Dodatkowy xsltproc(1) opcje. Ta opcja może być podana więcej niż raz.

--plik-xsl=PLIK_XSL
Zastąp wbudowany arkusz stylów XSL niestandardowym arkuszem stylów XSL PLIK_XSL.

--fircyk
Użyj FOP do generowania plików PDF. Domyślnym zachowaniem jest użycie dblatex(1), --fircyk opcja
jest niejawna, jeśli ta opcja jest używana.

--fop-opty=FOP_OPTS
Dodatkowy fircyk(1) opcje. Jeśli ta opcja jest określona, ​​FOP jest używany do generowania plików PDF.
Ta opcja może być podana więcej niż raz.

--dblatex-opts=DBLATEX_OPTS
Dodatkowy dblatex(1) opcje. Ta opcja może być podana więcej niż raz.

--opcje-zaplecza=WSTECZEND_OPTS
Opcje wtyczki backendowej określonej przez --zaplecze opcja. Ta opcja może być
określone więcej niż raz.

Opcje można również ustawić w pliku źródłowym AsciiDoc. Jeśli PLIK ŹRÓDŁOWY zawiera komentarz
linia zaczynająca się od // a2x: wtedy pozostała część wiersza będzie traktowana jako a2x
opcje wiersza polecenia. Na przykład:

// domyślne opcje a2x.
// a2x: -dbook --epubcheck
// Pomiń historię wersji w danych wyjściowych dblatex.
// a2x: --dblatex-opts "-P lateks.output.revhistory=0"

· Opcje obejmujące wiele takich wierszy komentarza zostaną połączone.

· Między wiodącymi znakami może pojawić się zero lub więcej białych znaków // i a2x:.

· Opcje wiersza poleceń mają pierwszeństwo przed opcjami ustawionymi w pliku źródłowym.

WYDAJNOŚĆ AKTA

Pliki wyjściowe są zapisywane w katalogu określonym przez --docelowy-dir opcja. Jeśli nie
--docelowy-dir opcja jest ustawiona pliki wyjściowe są zapisywane do PLIK ŹRÓDŁOWY katalogiem.

Pliki wyjściowe mają taką samą nazwę jak PLIK ŹRÓDŁOWY ale z odpowiednią nazwą pliku
rozszerzenie: .html dla xhtml; .epub dla epub; .hhp dla htmlpomoc; .pdf dla pdf; .tekst dla
XNUMX, .xml dla dokumentacja. Zgodnie z konwencją strony podręcznika nie mają rozszerzenia .man (sekcja strony podręcznika)
tylko numer). Pofragmentowane nazwy katalogów HTML mają rozszerzenie .chunked; pofragmentowana pomoc HTML
nazwy katalogów mają rozszerzenie .htmlhelp.

Istniejące pliki o takich samych nazwach są zastępowane.

Oprócz generowania plików HTML, xhtml, epub, porcje i htmlpomoc formaty zapewniają
pliki zasobów są kopiowane do ich poprawnych lokalizacji w katalogu docelowym.

ZASOBY

Zasoby to pliki (zwykle CSS i obrazy), które są wymagane przez dane wyjściowe oparte na HTML
(xhtml, epub, porcje, htmlpomoc formaty). a2x skanuje wygenerowane pliki HTML i buduje
lista wymaganych plików CSS i obrazów. Można określić dodatkowe pliki zasobów
wyraźnie używając --ratunek opcja.

a2x wyszukuje pliki zasobów w następujących lokalizacjach w następującej kolejności:

1. PLIK ŹRÓDŁOWY katalogiem.

2. Katalogi zasobów określone przez --ratunek opcja (wyszukiwana rekurencyjnie).

3. Katalogi zasobów określone przez --manifest-zasobu opcja (przeszukiwana rekursywnie
w kolejności, w jakiej pojawiają się w pliku manifestu).

4. Katalogi zdjęć i arkuszy stylów w asciidoc(1) pliki konfiguracyjne
katalogi (wyszukiwane rekurencyjnie).

5. Katalog docelowy.

Po znalezieniu pliku zasobów jest on kopiowany do właściwego względnego katalogu docelowego.
Brakujące podkatalogi docelowe są tworzone automatycznie.

Istnieją dwa różne mechanizmy określania dodatkowych zasobów:

1. Katalog zasobów, który będzie rekursywnie przeszukiwany w poszukiwaniu brakujących plików zasobów.

2. Plik zasobów, który zostanie skopiowany do wyjściowego katalogu docelowego.

Zasoby są określone za pomocą --ratunek wartości opcji, które mogą być jedną z następujących
formaty:


[= ]
. =

Gdzie:


Określa katalog (bezwzględny lub względny do PLIK ŹRÓDŁOWY) który jest przeszukiwany
rekursywnie dla brakujących plików zasobów. Aby wyeliminować niejednoznaczność, Nazwa
powinien kończyć się znakiem separatora katalogu.


Określa plik zasobów (bezwzględny lub względny do PLIK ŹRÓDŁOWY) który będzie
skopiowane do . Jeśli nie jest określony, to jest
tak samo jak .


Określa miejsce docelowe kopiowanego pliku źródłowego. ten ścieżka jest
względem katalogu docelowego (ścieżki bezwzględne są niedozwolone). Lokalizacja
katalogu docelowego zależy od wyniku FORMAT (Patrz WYDAJNOŚĆ AKTA
sekcja po szczegóły):

chunked, pomoc html
Podzielony katalog wyjściowy.

epub
Zarchiwizowany katalog OEBPS.

xhtml
Wyjście DESTINATION_DIR.

. =
Podczas dodawania zasobów do plików EPUB typ MIME jest wywnioskowany z
rozszerzenie file>, jeśli nie można odgadnąć typu MIME, pojawia się błąd. ten
. = Składnia zasobów może służyć do jawnego ustawiania typów MIME. jest
rozszerzenie nazwy pliku, jest odpowiednim typem MIME.

Przykłady opcji zasobów:

--zasoby ../obrazy/
--resource doc/README.txt=README.txt
--ratunek ~/images/tygrys.png=obrazy/tygrys.png
--resource .ttf=aplikacja/x-font-ttf

PRZYKŁADY

a2x -f pdf doc/source-highlight-filter.txt
Generuje plik doc/source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/team.txt
Tworzy plik HTML ../doc/team.html, używa ikon napomnień i rekursywnie przeszukuje
../images/ dla wszystkich brakujących zasobów.

a2x -f strona podręcznika doc/asciidoc.1.txt
Wygeneruj stronę podręcznika doc/asciidoc.1.

PRZYBORY

a2x korzysta z następujących programów:

· Asciido: http://asciidoc.org/

· xsltproc: (wszystkie formaty z wyjątkiem tekstu): http://xmlsoft.org/XSLT/

· DocBook XSL Arkusze stylów (wszystkie formaty z wyjątkiem tekstu):
http://docbook.sourceforge.net/projects/xsl/

· dblatex (formaty pdf, dvi, ps, tex): http://dblatex.sourceforge.net/

· FIRCYK (format pdf — alternatywny generator plików PDF): http://xmlgraphics.apache.org/fop/

· w3m (format tekstowy): http://w3m.sourceforge.net/index.en.html

· Ryś (format tekstowy — alternatywny generator plików tekstowych): http://lynx.isc.org/

· epubcheck (format epub — walidator plików EPUB): http://code.google.com/p/epubcheck/

Zobacz także najnowszy plik README.

CONF AKTA

Plik konfiguracyjny zawiera wykonywalny kod Pythona, który zastępuje globalny
parametry konfiguracyjne w a2x.py. Opcjonalne pliki konfiguracyjne są ładowane w
następująca kolejność:

1. a2x.conf z katalogu zawierającego a2x.py plik wykonywalny.

2. a2x.conf z globalnego katalogu konfiguracyjnego AsciiDoc. Pomiń ten krok, jeśli jesteśmy
wykonywanie lokalnie zainstalowanej (nie ogólnosystemowej) kopii.

3. a2x.conf z katalogu konfiguracyjnego AsciiDoc $HOME/.asciidoc.

4. PLIK_KONF określone w --plik-konf opcja.

Oto domyślne wartości opcji pliku konfiguracyjnego:

# Opcjonalny słownik zmiennych środowiskowych przekazany do
# wykonywanych programów. Jeśli ustawione na Brak, istniejące
Używane jest # środowisko.
ENV = Brak

# Zewnętrzne pliki wykonywalne.
ASCIIDOC = „asciidok”
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # generacja pdf.
FOP = 'fop' # generowanie pdf (opcja --fop).
W3M = 'w3m' # generowanie tekstu.
LYNX = 'lynx' # generowanie tekstu (jeśli nie w3m).
XMLLINT = 'xmllint' # Ustaw na '', aby wyłączyć.
EPUBCHECK = 'epubcheck' # Ustaw na '', aby wyłączyć.
# Domyślne opcje zewnętrznego pliku wykonywalnego.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Korzystaj z a2x online za pomocą usług onworks.net