5. Guía de sintaxis

Por favor, siga éstas sencillas reglas para facilitar el trabajo de toda la gente que mantiene el código fuente de la documentación.

5.1. Minúsculas

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…>.

5.2. Sangrado

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:

+--- Ésta es la columna 0
V

  <sect1>
    <title>...</title>

    <sect2>
      <title>Sangrado</title>

      <para>Cada fichero comienza con un sangrado nulo, es decir,
	en la columna 0, <emphasis>sin tener en cuenta</emphasis>
	el nivel de sangrado del fichero que pueda contenerlo.</para>

      ...
    </sect2>
  </sect1>
</chapter>

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:

augroup sgmledit
  autocmd FileType sgml set formatoptions=cq2l " Opciones especiales de formato
  autocmd FileType sgml set textwidth=70       " Corta las lìneas a 70 espacios
  autocmd FileType sgml set shiftwidth=2       " Sangra automáticamente
  autocmd FileType sgml set softtabstop=2      " Tabulación = 2 espacios
  autocmd FileType sgml set tabstop=8          " Reemplaza 8 espacios con Tab
  autocmd FileType sgml set autoindent         " Sangrado automático
augroup END

5.3. Etiquetas

5.3.1. Espacios en las etiquetas

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:

<article lang='es'>
  <articleinfo>
    <title>NIS</title>

    <pubdate>Octubre 1999</pubdate>

    <abstract>
      <para>...
	...
	...</para>
    </abstract>
  </articleinfo>

  <sect1>
    <title>...</title>

    <para>...</para>
  </sect1>

  <sect1>
    <title>...</title>

    <para>...</para>
  </sect1>
</article>

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>.