Tutorial de DocBook: Un enfoque integrado y a través de ejemplos | ||||
---|---|---|---|---|
Anterior | Retroceder | Capítulo 3. Escribiendo un documento más complejo | Avanzar | Siguiente |
Cuando se escribe documentación técnica es muy útil mostrar pantallas que permitan visualizar el conjunto de acciones que se está realizando. DocBook permite hacer esto mediante la marquilla screen, a continuación mostramos un ejemplo de este tipo de codificación y cuál es su apariencia en el documento final
<chapter> <title><application>emacs</application></title> <sect1> <title>Invocación</title> <para>Para invocar a <application>emacs</application>, basta hacer lo siguiente desde una línea de comandos</para> <screen><prompt>[irving@abadon e2]$ </prompt><userinput>emacs&</userinput> <computeroutput>[1] 6251</computeroutput> <prompt>[irving@abadon e2]$ </prompt> </screen> |
Para invocar a emacs, basta hacer lo siguiente desde una línea de comandos
[irving@abadon e2]$ emacs& [1] 6251 [irving@abadon e2]$ |
La marquilla screen sirve para indicar que se el texto escrito en ella se trata de una captura de pantalla, es de notar que el texto dentro de ella es copiado tal cual, por lo cual importan los espacios y los cambios de línea.
Las marquillas prompt, computeroutput y userinput, sirven respectivamente para denotar el prompt (en una sesión de línea de comandos de UNIX), un texto que es generado por el computador y una entrada del usuario respectivamente
Con frecuencia, se desea capturar pantallas y luego utilizarlas dentro de un documento, el siguiente es un ejemplo de tal situación.
<para>Esto produce que se abra una ventana de <application>emacs</application> como la siguiente:</para> <informalfigure> <screenshot> <mediaobject> <imageobject> <imagedata fileref="emacs.eps" format="eps" scale="40"> </imageobject> <imageobject> <imagedata fileref="emacs.png" format="png"> </imageobject> <textobject> <phrase>Una ventana de <application>emacs</application></phrase> </textobject> </mediaobject> </screenshot> </informalfigure> |
Para capturar pantallas, se recomienda usar Gimp a través de Fichero->Adquirir->Captura de pantalla. |
La marquilla mediaobject hace referencia a que a continuación se encuentra un objeto, que puede tener dos representaciones gráficas (para ello es la marquilla imageobject) y una textual (para ello es la marquilla textobject). Cada representación gráfica tiene un formato en particular (aquí se usa el atributo format), el formato eps es usado para la salida en ps y el formato png es usado para la publicación en la red. Notemos que adicionalmente en el caso del eps usamos reducción de escala en un 40% para que dicha gráfica quepa mejor en el documento.
Es necesario que los archivos emacs.eps y emacs.png se encuentren en la misma ruta que el archivo herramientas.sgml, para cuando se haga la conversión a través de db2html o db2ps |