Esta sección contiene algunas indicaciones sobre las pautas que LDP ha acordado establecer para dotar a todos sus documentos de un aspecto uniforme, y que todo autor ha de tener en cuenta.
La etiqueta <pubdate> del encabezamiento debe tener el siguiente formato:
v1.0, 21 de abril de 2000 |
Cuando envíe imágenes a LDP, remita un grupo en formato .eps y otro en formatos .gif o .jpg. Con .gif obtendrá imágenes algo mejores que con .jpg, pero tendrá que tener en cuenta cuestiones en materia de patentes.
Actualmente, LDP sólo trabaja con la versión Docbook 3.1, aunque se está estudiando la posibilidad de incorporar DocBook 4.0. Muchos documentos de 3.1 pueden convertirse fácilmente a 4.0 evitando el uso de etiquetas obsoletas.
Debe escribir el encabezamiento de DocBook de la siguiente manera:
<!doctype article public "-//OASIS//DTD DocBook V3.1//EN"> |
Está desaconsejado el uso de las etiquetas consideradas obsoletas en DocBook: The Definitive Guide para la documentación de LDP. La sección "Tips and Tricks" de este libro informa sobre el uso de nuevas etiquetas.
A fin de minimizar etiquetas, se está utilizando </> para indicar el final de una etiqueta en lugar de la forma completa (por ejemplo</para>). No obstante, esto hace el documento más confuso para futuros autores, y no es posible en DocBook XML. Por tanto, procure evitar esta práctica.
Las siguientes convenciones son válidas para varios tipos de texto:
Si va a mostrar el uso de una orden, dele un formato similar a las líneas de órdenes de usuario. La línea de órdenes debe contener el tipo de shell (bash, tcsh, zsh,etc) seguido de un símbolo $ para las órdenes que hayan de ejecutarse como usuario normal (no como root), o un signo # para los que se ejecuten como root.
Por tanto, una orden debe tener el siguiente aspecto:
bash$ orden "me ejecuto como usuario normal" bash# orden "me ejecuto como superusuario root" tcsh# setenv DISPLAY :0.0 |