-Ejemplo breve de Linuxdoc-SGML
Matt Welsh,
[email protected]
[email protected]
v1.0, 28 Marzo 1994
Este documento es un breve ejemplo del uso del DTD Linuxdoc-SGML
______________________________________________________________________
�ndice General:
1. Introducci�n
2. El fuente
3. Algunos ejemplos
3.1. Esto es una subsecci�n
3.1.1. Esto es una subsubsecci�n
3.2. Texto de muestra
3.3. Referencias cruzadas
3.4. Empleo de fuentes
3.5. Listados
4. Notas del Traductor
5. Anexo: El INSFLUG
______________________________________________________________________
1. Introducci�n
Este documento es un breve ejemplo del uso del Linuxdoc-SGML DTD.
Puedes formatearlo empleando el comando:
% sgml2txt example.sgml
esto producir� texto ASCII simple. Se puede producir tambi�n LaTeX,
HTML y texinfo.
2. El fuente
El observar el fuente de este fichero ser� instructivo para mostrar
c�mo usar varias de las estructuras del paquete Linuxdoc-SGML. Debe
leerse tambi�n Linuxdoc-SGML, Gu�a de usuario, del archivo gu�a.sgml.
Los fuentes son y parecen similares al LaTeX, como puede verse. Los
p�rrafos se separan mediante l�neas en blanco, y las macros se colocan
entre signos "mayor-menor que". Es bastante simple.
3. Algunos ejemplos
He aqu� algunos ejemplos de elementos que ser�n empleados en el
fuente. Primero, descendamos a una subsecci�n:
3.1. Esto es una subsecci�n
Como reza en la cabecera. N�tese que se precisa usar el comando p para
comenzar el cuerpo de la secci�n, tras el comando sect1. He aqu� una
subsubsecci�n:
3.1.1. Esto es una subsubsecci�n
Ok. Hay 5 niveles de secciones disponibles. Emplear los siguientes
comandos sect, sect1, sect2, sect3, y sect4 para obtenerlas. Este
documento emplea el estilo article que es apropiado para HOWTOs y
otros documentos; el estilo report, (que incluye el comando de secci�n
chapt) deben ser los empleados en la documentacion del LDP.
3.2. Texto de muestra
Todo va bien, as� que sigues tecleando, y quieres mostrar c�digo de
ejemplo, o un ejemplo de I/O con un programa, o cualquier cosa. Usa
los screen, como este:
Este es un ejemplo de entorno ''verb''
O tambi�n este:
______________________________________________________________________
Este es un ejemplo de entorno ''code''
______________________________________________________________________
El entorno tscreen simplemente define un tamano de fuente peque�o,
indentandolo de forma agradable. No es necesario para definir un
entorno verb or code, pero sugiero que se haga as�.
La Linuxdoc-SGML, Gu�a de usuario , explica que caracteres especiales
pueden y no pueden ser empleados bajo un entorno verb y code.
3.3. Referencias cruzadas
Y �qu� hay sobre las referencias cruzadas? Esta secci�n ha sido
marcada con el comando label; el uso de ref nos proporciona una
referencia cruzada, como la que hay en en ''Ver secci�n ``''''para mas
se�as.
Hasta ahora, las referencias cruzadas no funcionaban en la
transformaci�n de nroff para texto ASCII simple.
3.4. Empleo de fuentes
Quieres fuentes, y las tenemos. Por supuesto no aparecen como son en
la versi�n ASCII del texto, pero todas ellas s� son modeladas en los
variados formatos de salida: boldface, emphasis, sans serif, slanted,
typewriter, e ita lics.
3.5. Listados
Los listados son tambien f�ciles. Simplemente, emplee el elemento
itemize con el comando item, como se observa aqui:
� Esto es un listado
� No hay nada excitante en ello.
� Tambi�n se soportan m�ltiples elementos.
� Nuevamente, no nos sorprende.
1. Listados enumerados con enum tambi�n funcionan.
2. Descripciones de entorno empleando descrip junto tag pueden ser
empleadas, como aqu� puede verse.
Primer item.
He aqu� un item.
Segundo item.
Aqu� hay otro
Tercer item.
�Vamos a por el tercero?
� Un item final para acabarlos.
Esto es simplemente todo lo que se necesita para ponerse en marcha
escribiendo documentos SGML, empleando linuxdoc-sgml DTD. Por favor,
hazmelo saber si piensas que se deber�a cambiar o a�adir algo a este
documento.
4. Notas del Traductor
Para que las tildes, e�es y dem�s elementos tipogr�ficos
caracter�sticos de nuestro idioma aparezcan al procesarlos, es preciso
pasar el par�metro fuente; el sgml2xxx se encargar� de expa ndirlos a
``&xxcute'' etc...
5. Anexo: El INSFLUG
El INSFLUG forma parte del grupo internacional Linux Documentation
Project, encarg�ndose de las traducciones al castellano de los Howtos
(Comos), as� como la producci�n de documentos originales en aquellos
casos en los que no existe an�logo en ingl�s.
En el INSFLUG se orienta preferentemente a la traducci�n de documentos
breves, como los COMOs y PUFs (Preguntas de Uso Frecuente, las FAQs.
:) ), etc.
Dir�jase a la sede del INSFLUG para m�s informaci�n al respecto.
En la sede del INSFLUG encontrar� siempre las �ltimas versiones de las
traducciones: www.insflug.org. Aseg�rese de comprobar cu�l es la
�ltima versi�n disponible en el Insflug antes de bajar un documento de
un servidor r�plica.
Se proporciona tambi�n una lista de los servidores r�plica (mirror)
del Insflug m�s cercanos a Vd., e informaci�n relativa a otros
recursos en castellano.
Francisco Jos� Montilla,
[email protected].