En esta sección presentamos ejemplos del uso de las convenciones, la documentación completa sobre las mismas la encuentra en el manual del script que genera los archivos para repasa a partir de fuentes DocBook: db2rep (db2rep(1))
Por ejemplo los logros de este documento, que se presentan en la introducción (ver Sección 2, “Sobre esta documentación”) se escribieron en las fuentes DocBook así:
<itemizedlist> <listitem role="logro" id="formato"> <para>Escribe bancos de definiciones, los clasifica y organiza las clasificaciones en secuencias empleando los formatos XML. Además chequea los diversos archivos que crea.</para> </listitem> <listitem role="logro" id="herram-repasa"> <para>Emplea las herramientas <command>repasa</command> y <command>repasatk</command> bien para repaso personal o para realizar autoevaluaciones, y en los archivos que escribe tiene en cuenta las características disponibles para estas herramientas. </para> </listitem> <listitem role="logro" id="docbook"> <para>Emplea las convenciones y herramientas para DocBook que permiten extraer bancos de definiciones clasificados y su secuencia. </para> </listitem> </itemizedlist>
Los indicadores se escribirían de forma análoga pero empleando
role="indicador"
en lugar de
role="logro"
.
Una definición introducida en este documento y cuya palabra puede ver en el índice es:
<indexterm role="pal"> <primary>.def</primary> </indexterm> <para role="sig" id="formato.def.def" userlevel="3:indist"> Extensión sugerida para archivos de definiciones </para>
y una definición introducida en [AA1.1] cuya palabra no puede verse en el índice es:
<para role="nipal:/home/patricio/cfil.txt" id="arch.gnome.ejruta1" userlevel="3">Ruta completa de un archivo con nombre <filename>cfil.txt</filename> ubicado en el directorio del usuario patricio.</para>
El siguiente ejemplo de ejercicio es extraído de [AA1.1]:
<qandaset> <qandaentry> <question role="ejer" id="gnome.conf.e1"> <para>Abra un editor de texto, escriba algo de texto, y después cópielo y péguelo empleando el ratón (para pegar emplee el botón del centro).</para> </question> <answer> <para>Menú; gedit; escribir; marcar presionando botón izquierdo y arrastrando; pegar ubicando el cursor y presionando botón del centro.</para> </answer> </qandaentry> <qandaentry> </qandaset>