Ejemplo breve de Linuxdoc-SGML

Matt Welsh, mdw@cs.cornell.edu
Traducido por Fco. José Montilla, pacopepe@insflug.org

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:

Esto es una subsubsección

Ok. Hay 5 niveles de secciones disponibles. Emplear los siguientes comandos:

• sect
• sect1
• sect2
• sect3
• 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 "entornos" code o verb para ello, en el interior de un entorno 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

test-ref"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

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 ' -l ' al sgml2xxx que se emplee, basta con ponerlos tal cual en el 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, pacopepe@insflug.org.