Tutorial de DocBook: Un enfoque integrado y a través de ejemplos
AnteriorRetrocederCapítulo 4. Usando opciones más avanzadasAvanzarSiguiente

4.5. Dando información adicional

Una vez escrito un documento, es útil incluirle anexos en los cuales se profundiza algunos de los temas tratados en la estructura principal. A continuación presentamos dos anexos que serán parte de nuestro pequeño documento.

4.5.1. Incluyendo listados de programas

En nuestro pequeño documento vamos a incluir un apéndice con un listado del archivo hola.txt, para ello basta que usemos las marquillas programlisting. Es usual además que dichas listados vayan incluidas dentro de ejemplos, para lo cuál es útil usar la marquilla example o informalexample. A continuación presentamos un ejemplo usado en este documento y como es mostrado.

<appendix id="archivo-hola">
  <title>El archivo <filename>hola.txt</filename></title>
  <para>Por motivos de referencia incluímos el contenido del
  archivo <filename>hola.txt</filename></para>

  <informalexample>
<programlisting>
Hola Mundo
</programlisting>
  </informalexample>
</appendix>

Hola Mundo

Atención

Note que la marquilla programlisting está justificada a la izquierda, es necesario hacer esto pues los espacios dentro de programlisting son significativos.

En caso de querer incluir un listado que incluya caracteres como < o &, el contenido dentro de programlisting se incluye dentro de CDATA, como se muestra a continuación 

   <informalexample>
<programlisting<![CDATA[
Hola <emphasis>Mundo</emphasis>
]]>
</programlisting>
   </informalexample>     

Hola <emphasis>Mundo</emphasis>

4.5.2. Preguntas Frecuentes

La sección de preguntas frecuentes o faq (Frequently Asked Questions) es quizás una de las más populares y leídas dentro de un documento técnico. A continuación presentamos un ejemplo de esto, como un apéndice de herramientas.sgml 

<appendix id="faq">
  <title>Preguntas Frecuentes</title>
  <qandaset defaultlabel="number">
    <qandaentry>
      <question>
        <para>¿Qué es <acronym>DocBook</acronym>?</para>
      </question>
      <answer>
        <para>Es un lenguaje de marcado útil para escribir
         documentación técnica.</para>
      </answer>
    </qandaentry>
  </qandaset>
</appendix>

4.5.2.1. ¿Qué es DocBook?

4.5.2.1. ¿Qué es DocBook?

Es un lenguaje de marcado útil para escribir documentación técnica.

Sugerencia

En caso de querer cambiar la numeración de las preguntas frecuentes, se utiliza el atributo defaultlabel. Las posibles opciones para dicho atributo son number, qanda y none.

AnteriorInicioSiguiente
Facilitando la búsquedas al usuarioSubirSegundo listado de herramientas.sgml