|
Usar el estilo tmdoc |
|
Además de los macros de información de
copyright y macros transversales, los cuales han sido
docuementados antes, el estilo tmdoc viene con cierto número de otros macros y funciones,
las cuales usted debe usar cuando sea apropiado:
-
key
-
Este macro es usado para indicar una entrada de teclado como
C-x C-s. Los macros especializados kbd-gen, kbd-text,
kbd-math, kbd-symb, kbd-big,
kbd-large, kbd-ia, kbd-exec
y kbd-table son usados
para entradas de teclado correspondientes a tipos específicos
de acción o modos. Por ejemplo, kbd-math
corresponde a atajos de teclado para operaciones matemáticas,
tales como A-f, el cual inicia una fracción.
-
menu
-
Esta función con un número arbitrario de argumentos
indica un menú como Fichero
o Documento→Idioma. Las entradas de menu con automáticamente traducidas
por esta función.
-
markup
-
Esta macro es usado a fin de indicar un macro o una función
como section.
-
tmstyle
-
Este macro indica el nombre de un archivo estilo TeXmacs o un
paquete como article.
-
tmpackage
-
Este macro indica el nombre de un paquete TeXmacs como std-markup.
-
tmdtd
-
Este macro indica de un d.t.d. de TeXmacs like
number-env.
Note que los contenidos de ninguna de las etiquetas de arriba deben
ser traducidos a lenguajes extrangeros. De hecho, para etiquetas de
menú, las traducciones son hechas automáticamente,
así se mantienen sincronizadas con las traducciones en los
menus acutales de TeXmacs. En los casos de etiquetas, estilos,
paquetes y d.t.d.s, es importante mantener el nombre
original, porque a menudo corresponde a un nombre de archivo.
Los siguientes macros y funciones son usadas para propósitos de
enlace e indexación, aunque ellos deben ser mejorados en el
futuro:
-
simple-link
-
Este macro toma una URL x como argumento y es un
hiperenlace con un nombre y destinación x.
-
hyper-link
-
Este macro is un hiperenlace usual.
-
concept-link
-
Este macro toma un concepto como argumento. Después un
hiperenlace apropriado podría ser creado automaticamente
desde esta y la otra documentación.
-
only-index
-
Indexa una cadena simple.
-
def-index
-
Definición de un nuevo concepto; el texto es impreso en
itálica e indexado.
-
re-index
-
Reaparición de un concepto ya definido; el texto es impreso
en romano y puesto en el índice.
Las siguientes etiquetas son también frecuentemente usadas:
-
icon
-
Enlace a un icono en un directorio central como $TEXMACS_PATH/doc/images/pixmaps.
-
screenshot
-
Enlace a una captura de pantalla. Las capturas de pantalla actuales
son almacenadas en un directorio central como $TEXMACS_PATH/doc/images/screenshots.
-
scheme
-
El lenguage Scheme.
-
framed-fragment
-
Para mostrar un pedazo de código en un marco agradable.
-
scheme-fragment
-
Para código Scheme
multi-párrafo.
-
tm-fragment
-
Para un pedazos de etiquetas de código TeXmacs en formato
Scheme.
-
descriptive-table
-
Para tablas descriptivas; tales tablas pueden ser usadas para
documentar listas de atajos de teclado, diferentes tipos de
etiquetas, etc.
El estilo tmdoc herededa de el
estilo generic y usted debe
usar macros como em, verbatim, itemize, etc. para este estilo
donde sea apropiado.
© 1998–2002 Joris van der Hoeven, Offray Vladimir Luna
Cárdenas
Se garantiza el permiso para copiar, distribuir y/o modificar este
documento bajo los terminos de la GNU Free Documentation License,
Versión 1.1 o cualquier versión posterior publicada por
la Free Software Foundation; sin Secciones Invariantes, sin Textos de
Portada, y sin Textos de Contraportada. Una copia de la licencia
está incluida en la sección titulada "GNU Free
Documentation License".
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License".