Por favor, siga éstas sencillas reglas para facilitar el trabajo de toda la gente que mantiene el código fuente de la documentación.
Las etiquetas van siempre en minúsculas:
<para>
, no
<PARA>
.
El texto SGML normalmente se escribe en mayúsculas:
<!ENTITY…>
y
<!DOCTYPE…>
,
no
<!entity…>
o
<!doctype…>
.
Cada fichero comienza con un sangrado nulo, es decir, en la columna 0, sin tener en cuenta el nivel de sangrado del fichero que pueda contenerlo.
La apertura de etiquetas incrementa el nivel de sangrado en 2 espacios. Reemplace los bloques de 8 espacios al inicio de una línea con una tabulación. No use espacios antes de una tabulación y no añada espacios al final de una línea. El contenido que esté entre elementos debe sangrarse en dos espacios si el contenido ocupa más de una línea.
Por ejemplo, el código fuente de esta sección es algo parecido a esto:
Si usa Emacs o
XEmacs para editar ficheros
que forman parte de la Documentación se cargará
automáticamente el sgml-mode
y las
variables locales que Emacs
encontrará al principio de cada fichero podrán
utilizarse.
Si usa Vim puede serle muy útil incluir lo siguiente en la configuración de su editor:
Las etiquetas que comienzan en el mismo nivel de sangrado que la etiqueta anterior deben separarse con una línea en blanco, y las que no están al mismo nivel de sangrado que la anterior no:
Puede descargar éste y muchos otros documentos desde ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/
Si tiene dudas sobre FreeBSD consulte la
documentación antes de escribir a la lista
<questions@FreeBSD.org>.
Envíe sus preguntas sobre la documentación a
<doc@FreeBSD.org>.