dtplite: en línea en la nube

PROGRAMA:

NOMBRE

dtplite - Procesador de marcado ligero de DocTools

SINOPSIS

dtplite -o salida ? opciones? formato fichero de entrada

dtplite validar fichero de entrada

dtplite -o salida ? opciones? formato directorio de entrada

dtplite -unir -o salida ? opciones? formato directorio de entrada

_________________________________________________________________________________________________

DESCRIPCIÓN

La aplicación descrita por este documento, dtplite, es el sucesor del extremadamente
simples mpexpandir. Influenciado en su funcionalidad por la dtp procesador doctools es mucho
mas poderoso que mpexpandir, pero igual de fácil de usar; definitivamente más fácil que dtp con su
gran cantidad de subcomandos y opciones.

dtplite se basa en el paquete herramientas doctorales, como los otros dos procesadores.

USO CASOS
dtplite fue escrito teniendo en cuenta los siguientes tres casos de uso.

[1] Validación de un solo documento, es decir, comprobar que está escrito en formato válido.
formato doctools. Este modo también se puede utilizar para obtener una versión preliminar del
salida formateada para un solo documento, para mostrar en un navegador, nroff, etc.,
permitiendo la revisión del formato.

[2] Generación de la documentación formateada para un solo paquete, es decir, todos los
páginas de manual, además de una tabla de contenido y un índice de palabras clave.

[3] Una extensión del modo de operación anterior, un método para la fácil generación de
un árbol de documentación para varios paquetes, y especialmente de una tabla unificada de
contenido e índice de palabras clave.

Más allá de lo anterior, también queremos hacer uso de las funciones de personalización proporcionadas por el
Formateador HTML. No es el único formato que la aplicación debería poder generar, pero
anticipamos que es el más utilizado, y es uno de los pocos que proporciona
ganchos de personalización.

Permitimos que la persona que llama especifique una cadena de encabezado, una cadena de pie de página, una hoja de estilo y datos para
una barra de enlaces de navegación en la parte superior del documento generado. Si bien todo se puede configurar como
siempre que el motor de formato proporcione un parámetro de motor apropiado (consulte la sección
OPCIONES) los dos últimos tienen un procesamiento interno que los hace específicos de HTML.

COMANDO LÍNEA
dtplite -o salida ? opciones? formato fichero de entrada
Este es el formulario para el caso de uso [1]. los opciones se explicará más adelante, en la sección
OPCIONES.

camino salida (en)
Este argumento especifica dónde escribir el documento generado. Puede ser el
ruta a un archivo o directorio, o -. El último valor hace que la aplicación
escribir el documentado generado a stdout.

Si salida no existe, entonces [file dirname $ output] tiene que existir y
debe ser un directorio grabable. El documento generado se escribirá en un
archivo en ese directorio, y el nombre de ese archivo se derivará de la
fichero de entrada, la formato, y el valor dado a la opción -ext (si está presente).

(camino | mango) formato (en)
Este argumento especifica el motor de formato que se utilizará al procesar la
entrada y, por tanto, el formato del documento generado. Mira la sección FORMATOS
por las posibilidades reconocidas por la aplicación.

camino fichero de entrada (en)
Este argumento especifica la ruta al archivo a procesar. Tiene que existir
debe ser legible y estar escrito en herramientas doctorales formato.

dtplite validar fichero de entrada
Esta es una forma más simple para el caso de uso [1]. El formato "validar" no genera salida
en absoluto, solo se realizan comprobaciones de sintaxis. Como tal, la especificación de una salida
archivo u otras opciones no es necesario y se omite.

dtplite -o salida ? opciones? formato directorio de entrada
Este es el formulario para el caso de uso [2]. Se diferencia del formulario para el caso de uso [1] por
tener los documentos de entrada especificados a través de un directorio en lugar de un archivo. los
otros argumentos son idénticos, excepto por salida, que ahora tiene que ser el camino hacia
un directorio existente y grabable.

Los documentos de entrada son todos archivos en directorio de entrada o cualquiera de sus subdirectorios
que fueron reconocidos por fileutil :: fileType como que contiene texto en herramientas doctorales formato.

dtplite -unir -o salida ? opciones? formato directorio de entrada
Este es el formulario para el caso de uso [3]. La única diferencia con el formulario para el caso de uso [2]
es la opción adicional -unir.

Cada una de estas llamadas fusionará los documentos generados provenientes del procesamiento de la entrada
documentos bajo directorio de entrada o cualquiera de sus subdirectorios a los archivos bajo
salida. De esta manera es posible construir incrementalmente el unificado
documentación para cualquier número de paquetes. Tenga en cuenta que es necesario ejecutar
todos los paquetes dos veces para obtener referencias cruzadas completamente correctas (para formatos
apoyándolos).

OPCIONES
Esta sección describe todas las opciones disponibles para el usuario de la aplicación, con la
excepción de las opciones -o y -unir. Estos dos ya fueron descritos, en la sección
COMANDO LÍNEA.

-excluir cadena
Esta opción especifica un patrón de exclusión (global). Cualquier archivo identificado como páginas de manual
para procesar que coincidan con el patrón de exclusión se ignoran. La opción se puede proporcionar
varias veces, cada uso agrega un patrón adicional a la lista de exclusiones.

-ext cadena
Si el nombre de un archivo de salida debe derivarse del nombre de un archivo de entrada,
usará el nombre del formato como la extensión por defecto. Esta opción aquí
anule esto sin embargo, forzándolo a usar cadena como la extensión del archivo. Esta opción
se ignora si el nombre del archivo de salida se especifica completamente a través de la opción -o.

Cuando se usa varias veces, solo la última definición es relevante.

-encabezamiento presentar
Esta opción se puede utilizar si y solo si el seleccionado formato proporciona un motor
parámetro llamado "encabezado". Toma el contenido del archivo especificado y asigna
ellos a ese parámetro, para cualquier uso del motor. El motor HTML insertará
el texto justo después de la etiqueta . Si hay botones de navegación (ver opción
-navegación a continuación), el HTML generado para ellos se adjunta a los datos del encabezado
originado aquí antes de la asignación final al parámetro.

Cuando se usa varias veces, solo la última definición es relevante.

-pie de página presentar
Como -encabezamiento, excepto que: Se ignoran los botones de navegación, el correspondiente
El parámetro del motor requerido se llama "pie de página" y los datos se insertan justo antes
la etiqueta .

Cuando se usa varias veces, solo la última definición es relevante.

-Estilo presentar
Esta opción se puede utilizar si y solo si el seleccionado formato proporciona un motor
parámetro llamado "meta". Cuando se especifica, generará un fragmento de código HTML
declarando el presentar como hoja de estilo para el documento generado y asígnelo a
El parámetro. El motor HTML insertará esto en el documento, justo después de la
etiqueta .

Al procesar un directorio de entrada, el archivo de hoja de estilo se copia en la salida
directorio y el HTML generado se referirá a la copia, para hacer que el resultado sea más
autónomo. Al procesar un archivo de entrada, no tenemos una ubicación para copiar el
hoja de estilo y, por lo tanto, solo haga referencia a ella como se especifica.

Cuando se usa varias veces, solo la última definición es relevante.

-toc camino
Esta opción especifica un archivo doctoc para usar en la tabla de contenido en lugar de
generando el nuestro.

Cuando se usa varias veces, solo la última definición es relevante.

-pre + toc ruta de la etiqueta | texto

-post + toc ruta de la etiqueta | texto
Esta opción especifica archivos doctoc adicionales (o textos) para usar en la navegación
bar.

El posicionamiento y manejo de usos múltiples es como opciones -prenav y -postnav,
vea abajo.

-navegación URL de la etiqueta

-prenav URL de la etiqueta
Utilice esta opción para especificar un botón de navegación con Etiqueta para mostrar y el url a
enlace a. Esta opción se puede utilizar si y solo si el seleccionado formato proporciona un
parámetro del motor denominado "encabezado". El HTML generado para esto se adjunta a
los datos que obtuvimos de la opción -encabezamiento antes de que se inserte en el generado
documentos.

Cuando se usa varias veces, se recopilan todas las definiciones y se muestra una barra de navegación.
creado, con la primera definición mostrada en el borde izquierdo y la última definición
a la derecha.

La URL puede ser relativa. En ese caso, se supone que es relativo a la principal
archivos (TOC e índice de palabras clave), y se transformará para que todos los demás aún enlacen
correctamente.

-postnav URL de la etiqueta
Utilice esta opción para especificar un botón de navegación con Etiqueta para mostrar y el url a
enlace a. Esta opción se puede utilizar si y solo si el seleccionado formato proporciona un
parámetro del motor denominado "encabezado". El HTML generado para esto se adjunta a
los datos que obtuvimos de la opción -encabezamiento antes de que se inserte en el generado
documentos.

Cuando se usa varias veces, se recopilan todas las definiciones y se muestra una barra de navegación.
creado, con la última definición mostrada en el borde derecho y la primera definición
a la izquierda.

La URL puede ser relativa. En ese caso, se supone que es relativo a la principal
archivos (TOC e índice de palabras clave), y se transformará para que todos los demás aún enlacen
correctamente.

FORMATOS
Al principio el formato El argumento se tratará como una ruta a un archivo tcl que contiene el código.
para el motor de formato solicitado. El argumento se tratará como el nombre de uno de
los formatos predefinidos que se enumeran a continuación si y solo si la ruta no existe.

Nota a la limitación: Si trata el formato como una ruta al script tcl que implementa el
motor tuvo éxito, entonces este script tiene que implementar no solo la API del motor para
doctools, es decir doctools_api, pero para doctor_api y docidx_api así como. De lo contrario, el
la generación de una tabla de contenido y de un índice de palabras clave fallará.

Lista de formatos predefinidos, es decir, según lo proporcionado por el paquete herramientas doctorales:

nroff El procesador genera una salida * roff, el formato estándar para las páginas de manual de Unix.

html El procesador genera salida HTML, para uso y visualización en navegadores web. Esta
El motor es actualmente el único que proporciona los diversos parámetros del motor requeridos.
para la personalización adicional de la salida.

tmml El procesador genera salida TMML, el Tcl Manpage Markup Language, un derivado
de XML.

látex El procesador genera salida LaTeX.

wiki El procesador genera el marcado Wiki como lo entiende wiki.

lista El procesador extrae la información proporcionada por página de manual_comienzo. Este formato es
utilizado internamente para extraer los metadatos de los que tanto la tabla de contenido como
el índice de palabras clave se deriva de.

nulo El procesador no genera ninguna salida. Esto es equivalente a validar.

De miembros ESTRUCTURAS
En esta sección describimos las estructuras de directorio generadas por la aplicación en
salida al procesar todos los documentos en un directorio de entrada. En otras palabras, esto es solo
relevante para los casos de uso [2] y [3].

[2] La siguiente estructura de directorio se crea al procesar un único conjunto de datos de entrada.
documentos. La extensión de archivo utilizada es para la salida en HTML, pero eso no es relevante
a la estructura y solo se usó para tener nombres de archivo adecuados.

producción/
toc.html
index.html
archivos /
ruta / a / FOO.html

La última línea del ejemplo muestra el documento generado para un archivo FOO ubicado en

inputdirectory / ruta / a / FOO

[3] Al fusionar muchos paquetes en un conjunto unificado de documentos, el directorio generado
la estructura es un poco más profunda:

salida
.toc
.idx
.tocdoc
.idxdoc
.xrf
toc.html
index.html
FOO1 /
...
FOO2 /
toc.html
archivos /
ruta / a / BAR.html

Cada uno de los directorios FOO1, ... contiene los documentos generados para el paquete
FOO1, ... y sigue la estructura mostrada para el caso de uso [2]. La única excepción es
que no hay un índice por paquete.

Los archivos ".toc"".idx", Y".xrf"contienen el estado interno del conjunto
salida y será leído y actualizado por la próxima invocación. Su contenido no
estar documentado. Elimine estos archivos cuando todos los paquetes deseados para la salida hayan sido
procesado, es decir, cuando la salida está completa.

Los archivos ".tocdoc", Y".idxdoc", son archivos intermedios en doctoc y docidx
marcado, respectivamente, que contiene la tabla de contenido principal y el índice de palabras clave para
el conjunto de documentos antes de su conversión al formato de salida elegido. Son
dejado en su lugar, es decir, no eliminado, para servir como demostraciones de doctoc y docidx
margen.

Use dtplite en línea usando los servicios de onworks.net