a2x - Online en la nube

PROGRAMA:

NOMBRE

a2x: un administrador de cadena de herramientas para AsciiDoc (convierte archivos de texto Asciidoc a otro archivo
formatos)

SINOPSIS

a2x [CAMPUS] ARCHIVO FUENTE

DESCRIPCIÓN

Un administrador de cadena de herramientas DocBook que traduce un archivo de texto AsciiDoc ARCHIVO FUENTE a PDF,
EPUB, DVI, PS, LaTeX, XHTML (página única o fragmentada), página de manual, ayuda HTML o texto sin formato
formatos usando Asciidoc(1) y otras aplicaciones (ver sección REQUISITOS). ARCHIVO FUENTE podemos
también debe ser un archivo DocBook con extensión .xml.

CAMPUS

-a --atributo=ATRIBUTO
Set Asciidoc(1) valor de atributo (atajo para --asciidoc-opta="-a ATRIBUTO" opción).
Esta opción se puede especificar más de una vez.

--asciidoc-opta=ASCIIDOC_OPTS
Adicionales Asciidoc(1) opciones. Esta opción se puede especificar más de una vez.

--conf-archivo=CONF_ARCHIVO
Cargar archivo de configuración. Consulte la sección ARCHIVOS CONF.

-RE, --dirección-destino=DESTINO_DIR
Directorio de salida. Predeterminado a ARCHIVO FUENTE directorio. Esta opción solo es aplicable a
Formatos de salida basados ​​en HTML (troceado, epub, ayuda html, xhtml).

-D, --tipo de documento=DOCTYPE
Tipo de documento DocBook: artículo, página de manual or primer libro. El tipo de documento predeterminado es artículo
a menos que el formato sea página de manual (en cuyo caso por defecto es página de manual).

-B, - backend=BACKEND
BACKEND es el nombre de un complemento de backend instalado. Cuando se especifica esta opción a2x
intenta cargar un nombre de archivo a2x-backend.py del desplegable BACKEND directorio de complementos Entonces
convierte el ARCHIVO FUENTE a una BACKEND archivo de salida formateado usando una función global
definido en a2x-backend.py , que son a_BACKEND.

-F, --formato=FORMATO
Formatos de salida: troceado, libro de documentos, Dvi, epub, ayuda html, página de manual, pdf (Predeterminado), ps,
Texas, texto, xhtml. El AsciiDoc formato a2x el valor del atributo se establece en FORMATO.

-h, --ayuda
Imprime la sintaxis de la línea de comandos y las opciones del programa en stdout.

--iconos
Utilice imágenes de iconos de advertencia o navegación en los documentos de salida. El comportamiento predeterminado es
para utilizar texto en lugar de iconos.

--iconos-dir=TRAYECTORIA
Una ruta (relativa a los archivos de salida) que contiene iconos de advertencia y navegación. Defaults
a imágenes / iconos. El --iconos La opción está implícita si se utiliza esta opción.

-k, --mantener-artefactos
No elimine los archivos de compilación temporales.

--lince
Uso lince(1) para generar salida con formato de texto. El comportamiento predeterminado es usar w3m(1).

-l, --no-xmllint
No verifique la salida de asciidoc con xmlint(1).

--- epubcheck
Compruebe la salida EPUB con cheque electrónico(1).

-norte, - corrida en seco
No hagas nada, solo imprime lo que se hubiera hecho.

-r, --recurso=RECURSO_ESPECIFICACIÓN
Especifica un recurso. Esta opción se puede especificar más de una vez. Ver el DIGITALES
Sección para más detalles.

-metro, --recurso-manifiesto=ARCHIVO
ARCHIVO contiene una lista de recursos (uno por línea). Manifiesto ARCHIVO las entradas están formateadas
al igual que --recurso argumentos de opción. Variables de entorno y tilde home
Se permiten directorios.

- hoja de estilo=HOJA DE ESTILOS
Una lista delimitada por espacios de uno o más nombres de archivo de hoja de estilo CSS que se utilizan para diseñar
Salida HTML generada por las hojas de estilo DocBook XSL. Predeterminado a docbook-xsl.css.
las hojas de estilo se procesan en orden de lista. Las hojas de estilo deben residir en un
ubicación del archivo de recursos. Se aplica a formatos HTML: xhtml, epub, troceado, ayuda html
formatos.

-v, --verboso
Imprima los detalles operativos en stderr. Un segundo -v La opción aplica la opción detallada a
comandos de la cadena de herramientas.

--versión
Imprime la versión del programa en stdout.

--xsltproc-opciones=XSLTPROC_OPTS
Adicionales xsltproc(1) opciones. Esta opción se puede especificar más de una vez.

--archivo xsl=XSL_FILE
Reemplazar la hoja de estilo XSL incorporada con la hoja de estilo XSL personalizada XSL_FILE.

--petimetre
Utilice FOP para generar archivos PDF. El comportamiento predeterminado es usar dblatex(1). --petimetre opción
está implícito si se utiliza esta opción.

--fop-opciones=FOP_OPTS
Adicionales petimetre(1) opciones. Si se especifica esta opción, se utiliza FOP para generar archivos PDF.
Esta opción se puede especificar más de una vez.

--dblatex-opciones=DBLATEX_OPTS
Adicionales dblatex(1) opciones. Esta opción se puede especificar más de una vez.

- backend-opts=VOLVEREND_OPTS
Opciones para el complemento de backend especificado por el - backend opción. Esta opción puede ser
especificado más de una vez.

Las opciones también se pueden configurar en el archivo fuente AsciiDoc. Si ARCHIVO FUENTE contiene un comentario
línea que comienza con // a2x: entonces el resto de la línea se tratará como a2x
opciones de la línea de comandos. Por ejemplo:

// opciones predeterminadas de a2x.
// a2x: -dlibro --epubcheck
// Suprime el historial de revisiones en las salidas de dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory = 0"

· Se concatenarán las opciones que abarcan varias de estas líneas de comentarios.

· Pueden aparecer cero o más caracteres de espacio en blanco entre los // y a2x:.

· Las opciones de la línea de comandos tienen prioridad sobre las opciones establecidas en el archivo de origen.

SALIDA ARCHIVOS

Los archivos de salida se escriben en el directorio especificado por el --dirección-destino opción. Si no
--dirección-destino La opción se establece los archivos de salida se escriben en el ARCHIVO FUENTE directorio.

Los archivos de salida tienen el mismo nombre que el ARCHIVO FUENTE pero con un nombre de archivo apropiado
extensión: .html para xhtml; .epub para epub; .hhp para ayuda html; .pdf para pdf; .texto para
texto, .xml para libro de documentos. Por convención, las páginas de manual no tienen extensión .man (sección de la página de manual
número solamente). Los nombres de directorios HTML fragmentados tienen una extensión fragmentada; Ayuda HTML fragmentada
los nombres de directorio tienen una extensión .htmlhelp.

Se sobrescriben los archivos existentes con el mismo nombre.

Además de generar archivos HTML, xhtml, epub, troceado y ayuda html los formatos aseguran
Los archivos de recursos se copian en sus ubicaciones de directorio de destino correctas.

DIGITALES

Los recursos son archivos (normalmente CSS e imágenes) que son necesarios para las salidas basadas en HTML
(xhtml, epub, troceado, ayuda html formatos). a2x escanea los archivos HTML generados y crea un
lista de CSS y archivos de imagen necesarios. Se pueden especificar archivos de recursos adicionales
utilizando explícitamente el --recurso .

a2x busca archivos de recursos en las siguientes ubicaciones en el siguiente orden:

1. los ARCHIVO FUENTE directorio.

2. Directorios de recursos especificados por --recurso opción (búsqueda recursiva).

3. Directorios de recursos especificados por --recurso-manifiesto opción (buscada recursivamente
en el orden en que aparecen en el archivo de manifiesto).

4. Los directorios de imágenes de archivo y hojas de estilo en el Asciidoc(1) Archivos de configuración
directorios (buscados de forma recursiva).

5. El directorio de destino.

Cuando se encuentra un archivo de recursos, se copia en el directorio de destino relativo correcto.
Los subdirectorios de destino que faltan se crean automáticamente.

Hay dos mecanismos distintos para especificar recursos adicionales:

1. Un directorio de recursos en el que se buscarán de forma recursiva los archivos de recursos que faltan.

2. Un archivo de recursos que se copiará en el directorio de destino de salida.

Los recursos se especifican con --recurso valores de opción que pueden ser uno de los siguientes
formatos:


[= ]
. =

Lugar:


Especifica un directorio (absoluto o relativo al ARCHIVO FUENTE) que se busca
de forma recursiva para los archivos de recursos que faltan. Para eliminar la ambigüedad nombre
debe terminar con un carácter separador de directorio.


Especifica un archivo de recursos (absoluto o relativo al ARCHIVO FUENTE) Cuál podría ser
copiado a . Si no se especifica, entonces es el
igual que el .


Especifica el destino del archivo de origen copiado. El camino es
relativo al directorio de destino (no se permiten rutas absolutas). La locación
del directorio de destino depende de la salida FORMATO (Véase el SALIDA ARCHIVOS
sección para más detalles):

fragmentado, htmlhelp
El directorio de salida fragmentado.

epub
El directorio OEBPS archivado.

xhtml
La salida DESTINO_DIR.

. =
Al agregar recursos a archivos EPUB, el tipo MIME se infiere de la
file> extensión, si no se puede adivinar el tipo MIME, se produce un error. El
. = La sintaxis de recursos se puede utilizar para establecer explícitamente tipos MIME. es
la extensión del nombre del archivo, es el tipo MIME correspondiente.

Ejemplos de opciones de recursos:

--recurso ../imágenes/
--resource doc / README.txt = README.txt
--recurso ~ / images / tiger.png= images / tiger.png
--resource .ttf = application / x-font-ttf

EJEMPLOS

a2x -f pdf doc / source-highlight-filter.txt
Genera el archivo doc / source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/equipo.txt
Crea un archivo HTML ../doc/team.html, usa íconos de advertencia y busca recursivamente el
../images/ directorio para los recursos que faltan.

a2x -f página de manual doc / asciidoc.1.txt
Genere la página de manual de doc / asciidoc.1.

REQUISITOS

a2x utiliza los siguientes programas:

· asciidoc: http://asciidoc.org/

· xsltproc: (todos los formatos excepto texto): http://xmlsoft.org/XSLT/

· DocBook XSL Hojas de estilo (todos los formatos excepto texto):
http://docbook.sourceforge.net/projects/xsl/

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

· PETIMETRE (formato pdf - generador de archivos PDF alternativo): http://xmlgraphics.apache.org/fop/

· w3m (formato de texto): http://w3m.sourceforge.net/index.en.html

· Lynx (formato de texto - generador de archivos de texto alternativo): http://lynx.isc.org/

· cheque electrónico (formato epub - validador de archivos EPUB): http://code.google.com/p/epubcheck/

Consulte también el archivo README más reciente.

CONF ARCHIVOS

Un archivo de configuración contiene código Python ejecutable que anula el global
parámetros de configuración en a2x.py. Los archivos de configuración opcionales se cargan en el
siguiente orden:

1. a2x.conf del directorio que contiene el a2x.py ejecutable.

2. a2x.conf del directorio de configuración global de AsciiDoc. Omita este paso si estamos
ejecutar una copia instalada localmente (no en todo el sistema).

3. a2x.conf del directorio de configuración AsciiDoc $ HOME / .asciidoc.

4. los CONF_ARCHIVO especificado en el --conf-archivo .

Estos son los valores predeterminados de las opciones del archivo de configuración:

# Diccionario de variables de entorno opcional pasado a
# ejecutando programas. Si se establece en Ninguno, el existente
# se utiliza el entorno.
ENV = Ninguno

# Ejecutables externos.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # generación de pdf.
FOP = 'fop' # generación de pdf (opción --fop).
W3M = 'w3m' # generación de texto.
LYNX = 'lynx' # generación de texto (si no hay w3m).
XMLLINT = 'xmllint' # Establecer en '' para deshabilitar.
EPUBCHECK = 'epubcheck' # Establecer en '' para deshabilitar.
# Opciones predeterminadas ejecutables externas.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

Utilice a2x en línea utilizando los servicios de onworks.net