                         Introduccion al FDP-es

  J. Vicente Carrasco Vaya

   <carvay@FreeBSD.org>

   Este documento ha sido escrito para que sirva de guia somera a
   quienes quieren colaborar con FreeBSD traduciendo documentacion o
   alguna seccion de la web de FreeBSD al castellano. FreeBSD es un
   proyecto que crece diariamente gracias al trabajo voluntario de
   miles de personas de todo el mundo. La traduccion de documentacion
   y de la web supone una enorme ayuda para quienes se acercan a
   FreeBSD y no saben ingles (o alguna de las lenguas a las que ya
   esa traducido todo o parte de dicho material). Casi cualquier
   persona puede ayudar en alguna tarea. Si quiere colaborar reciba
   nuestra mas calurosa bienvenida y siga leyendo.

   Este documento no pretende ser exhaustivo. Casi toda la
   informacion necesaria para trabajar en el FDP esta en el libro
   fdp-primer (que esperamos poder tener traducido algun dia) y en
   cuya seccion de estilo esta basada gran parte de este texto. Si
   quiere ampliar los conocimientos que aqui se esbozan (y si va a
   trabajar con la documentacion de FreeBSD seguramente querra
   hacerlo) le rogamos que lo lea cuidadosamente. Recuerde que
   cualquier duda que pudiera salirle al paso mientras trabaja en la
   documentacion de FreeBSD puede enviarla a la lista de correo sobre
   la documentacion de FreeBSD en castellano

   Si tiene alguna sugerencia, critica o duda relacionada con este
   articulo no dude en escribir al autor.

     --------------------------------------------------------------

1. El FDP-es

   El FreeBSD Spanish Documentation Project (en adelante FDP-es)
   tiene las siguientes funciones:

     * Mantener al dia la documentacion existente en castellano e ir
       traduciendo mas siempre que los recursos lo permitan.

     * Traducir y mantener la web http://www.freebsd.org/es/.

     * Desarrollar documentos propios como este.

     --------------------------------------------------------------

2. Tareas pendientes

   Glosario: Confeccion y Mantenimiento de un Glosario de terminos
   frecuentes en la Documentacion para ayuda y referencia del
   traductor.

   Paginas man: El Proyecto de Documentacion de FreeBSD tambien se
   encarga de desarrollar, mantener y corregir las paginas man del
   sistema pero debido a la escasez de voluntarios es una tarea que
   (siendo muy optimistas) preferimos pensar que podremos acometer a
   medio o largo plazo.

   "Scripts" accent2xml y xml2accent. Existen dos "scripts" que
   traducen los caracteres que no existen en ingles a codigo sgml;
   por ejemplo &aacute; a "a", &iquest; a "?", etcetera. Seria muy
   util disponer de sus homologos xml para facilitar el trabajo de
   aquellas personas que traducen secciones de la web y (cosa poco
   sorprendente) no conozcan de memoria todos los secretos de xml.

     --------------------------------------------------------------

3. Como formar parte del FPD-es

   Casi cualquier persona puede formar parte del FDP-es. Igual que
   sucede en el FDP no hay cuota mensual que haya que pagar ni una
   cantidad mensual o anual de material que haya que traducir de
   forma obligatoria. Basta con suscribirse a la lista de correo
   sobre la documentacion de FreeBSD en castellano. Puede aportar sus
   conocimientos de ingles para ayudar con las dudas de quienes estan
   traduciendo o quizas pueda dedicar un poco de su tiempo a
   traducir.

     --------------------------------------------------------------

  3.1. Asignacion de trabajos

   Al depender del esfuerzo voluntario es logico que cada cual pueda
   elegir que parte de la web o de la documentacion desea traducir.
   Dentro de poco esperamos disponer de una pagina web publica en la
   que poder consultar que textos estan asignados y desde cuando. De
   momento el procedimiento es el siguiente:

     * la persona interesada en traducir elige un texto que desea
       traducir y dos alternativas por si su primera eleccion ya esta
       asignada

     * el coordinador de traducciones le asigna el texto

     * el texto traducido es revisado e incluido en el repositorio
       del FDP-es primero y en el del FDP despues.

     --------------------------------------------------------------

  3.2. Si puede dedicar un poco de tiempo

   Puede traducir una seccion de la web, un capitulo del handbook o
   un articulo y entregarlo en formato ASCII (texto plano). Tenga en
   cuenta que alguien tendra que darle formato (DocBook o xml en el
   caso de la web). Sera de grandisima ayuda si entrega su trabajo
   con los acentos, enes y demas signos caracteristicos de nuestro
   idioma corregidos al formato adecuado. Consulte la tabla que
   encontrara en
   http://www.theorem.ca/~mvcorks/code/charsets/latin1.html o utilice
   el "script" perl accent2sgml.pl ubicado en
   doc/share/examples/vim/. La parte mas dificil del trabajo es sin
   duda alguna la traduccion pero si pudiera avanzar trabajo
   adaptando en lo posible la sintaxis del texto a sgml o xml (o
   maquetandolo usted, pruebelo: no es dificil) aligerara
   notablemente la carga de trabajo de unos cuantos (y mortales)
   voluntarios y voluntarias. Tenga en cuenta que no sobra
   precisamente el personal para estas tareas y enfrentarse a
   convertir un texto ASCII de 5.000 lineas a DocBook puede hacer
   flaquear al voluntario mas comprometido.

     --------------------------------------------------------------

  3.3. Con un poco mas de tiempo

   La forma ideal de entrega de trabajos al FDP-es es enviarlos
   listos para incluir en el arbol cvs de FreeBSD. Si tiene un
   especial interes en un texto en concreto puede encargarse de su
   mantenimiento (es lo que llamamos "apadrinar" ese texto). En poco
   tiempo se convertira en su mejor conocedor y no le resultara
   dificil ir anadiendo los cambios a medida que se vayan produciendo
   en el original. De este modo al menos una fraccion de la
   documentacion tendra mas posibilidades de estar al dia;-)

     --------------------------------------------------------------

  3.4. Colaboracion esporadica

   En la lista de correo sobre la documentacion de FreeBSD en
   castellano hay personas que colaboran resolviendo dudas que surgen
   a los traductores. Si por el motivo que fuera no quiere o no puede
   traducir textos no deberia subestimar la importancia de la ayuda
   que puede prestarse de este modo. Gracias a estas personas los
   traductores encuentran mas argumentos a favor o en contra de
   traducir ciertos terminos, con lo que la documentacion resulta mas
   util; y nuestro trabajo consiste en hacer algo util.

     --------------------------------------------------------------

  3.5. ?Todo el mundo puede traducir?

   En principio si, pero no necesariamente. Le recomendamos que si
   quiere traducir documentacion se familiarice con otros textos ya
   traducidos y comience por colaborar con las dudas de los
   traductores en la lista de correo sobre la documentacion de
   FreeBSD en castellano.

   La documentacion de FreeBSD goza de una merecida fama de calidad,
   lo que hace que el trabajo de un proyecto de traduccion como el
   nuestro implique una gran responsabilidad. Es imposible mantener
   una fidelidad absoluta al original, pero dentro de lo posible lo
   intentamos. Al tratarse de textos tecnicos hay que tener muy
   presente al traducirlos que sin duda alguna van a ser utilizados
   como guia. Se suele exigir a los recien llegados a FreeBSD que
   lean la documentacion relacionada con sus dudas antes de preguntar
   dudas, asi que, al menos en teoria, lo que usted traduzca tendra
   avidos lectores. Tenga esto muy presente al traducir: mejor
   preguntar una duda de mas en la lista de correo sobre la
   documentacion de FreeBSD en castellano que incluir informacion
   erronea en un texto.

   Se estara preguntando ?cual es el perfil necesario para traducir?
   La verdad es que no hay un acuerdo sobre esto. Es obvio que
   necesita comprender el ingles tecnico (americano) en el que esta
   escrita la documentacion de FreeBSD, [1] y por supuesto solidos
   conocimientos de castellano. Dicho de otro modo, no es
   imprescindible hablar ingles, basta con comprenderlo lo mejor
   posible, pero es imprescindible la expresion escrita en
   castellano. La calidad de una traduccion es algo totalmente
   subjetivo, pero suele haber acuerdo entre los miembros de la lista
   entre lo que es asumible [2] y lo que no lo es. El trabajo de
   arreglar una mala traduccion puede ser igual de largo que traducir
   desde cero un texto y es varios ordenes de magnitud mas penoso.
   Encontrar un buen traductor de textos tecnicos es tanto o mas
   dificil que encontrar un buen programador, como sabe cualquiera
   que haya abierto mas de una docena de libros tecnicos traducidos a
   nuestro idioma [3] Cuando envie un texto traducido para su
   revision es posible que, aunque ponga mucho cuidado para evitarlo,
   aparezcan errores en el codigo SGML o en el propio texto. El
   trabajo de revision consiste precisamente en eso asi que no se
   preocupe, dentro de la ayuda esporadica que algunas personas
   ofrecen al FDP-es esta la de revisar textos de otros. Un
   voluntario depurara el texto en caso de que haga falta y lo dejara
   listo para subir al cvs [4].

     --------------------------------------------------------------

4. Guia de estilo

   Esta seccion estan basada en la seccion "writing style" del libro
   "fdp-primer" que puede consultarse en
   (http://www.es.FreeBSD.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style.html).

   Es necesario intentar mantener la consistencia entre la multitud
   de autores que trabajan en la Documentacion de FreeBSD, razon por
   la cual se han creado unas lineas generales. A esta busqueda de la
   consistencia se opone tambien la variedad de origenes de los
   traductores de la Documentacion, por lo que se listan aqui unas
   cuantas normas que pueden ser de ayuda. Dado que la Documentacion
   que va a traducir ya ha pasado por mas de una mano experta puede
   usarla como plantilla para su traduccion.

   Idioma

     * El idioma oficial del FDP-es es el castellano (o espanol de
       Espana), es_ES; la decision de tener lengua oficial no es una
       idea exclusiva nuestra puesto que en el el Proyecto de
       Documentacion de FreeBSD el idioma oficial es el ingles de los
       Estados Unidos de America (en_US). Se intenta evitar el uso de
       palabras "agresivas" con otros castellanoparlantes como
       ordenador (computador, computadora, sistema, maquina o incluso
       host) pero al iniciar los trabajos necesitaban una norma y
       logicamente usaron la que la que mas cerca tenian.

     * Evite frases redundantes

       Intente evitar usar frases redundantes. Por ejemplo "el
       comando", "el fichero" y "man comando" probablemente son
       redundantes.

       He aqui dos ejemplos en el caso de los comandos. El segundo
       ejemplo mostrado es el recomendable.

     * Utilice el comando cvsup para actualizar sus fuentes

     * Utilice cvsup para actualizar sus fuentes

   Veamos dos ejemplos para nombres de ficheros. Recomendamos el uso
   del segundo ejemplo.

   ... en el fichero llamado /etc/rc.local...

   ... en /etc/rc.local...

   Veamos un ejemplo sobre paginas man. Recomendamos el uso del
   segundo caso, que usa <citerefentry>.

   Para mas informacion consulte man csh.

   Consulte csh(1)

   Dos espacios al final de cada frase

           Deje siempre dos espacios al final de cada frase. El texto
           sera mas legible y se facilita el uso de herramientas como
           Emacs.

           Puede pensarse que una mayuscula tras un punto indica
           nueva frase pero no siempre es asi, sobre todo si se trata
           del nombre de algunas personas. "Jordan K. Hubbard" es un
           buen ejemplo de ello. Tiene una H mayuscula tras un punto
           y un espacio y es evidente que no es una nueva frase.

     --------------------------------------------------------------

5. Guia de sintaxis

   Por favor, siga estas sencillas reglas para facilitar el trabajo
   de toda la gente que mantiene el codigo fuente de la
   documentacion.

     --------------------------------------------------------------

  5.1. Minusculas

   Las etiquetas van siempre en minusculas: <para>, no <PARA>.

   El texto SGML normalmente se escribe en mayusculas: <!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
   linea con una tabulacion. No use espacios antes de una tabulacion
   y no anada espacios al final de una linea. El contenido que este
   entre elementos debe sangrarse en dos espacios si el contenido
   ocupa mas de una linea.

   Por ejemplo, el codigo fuente de esta seccion es algo parecido a
   esto:

 +--- Esta 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
   Documentacion se cargara automaticamente el sgml-mode y las
   variables locales que Emacs encontrara al principio de cada
   fichero podran utilizarse.

   Si usa Vim puede serle muy util incluir lo siguiente en la
   configuracion de su editor:

 augroup sgmledit
   autocmd FileType sgml set formatoptions=cq2l " Opciones especiales de formato
   autocmd FileType sgml set textwidth=70       " Corta las l`ineas a 70 espacios
   autocmd FileType sgml set shiftwidth=2       " Sangra automaticamente
   autocmd FileType sgml set softtabstop=2      " Tabulacion = 2 espacios
   autocmd FileType sgml set tabstop=8          " Reemplaza 8 espacios con Tab
   autocmd FileType sgml set autoindent         " Sangrado automatico
 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 linea en blanco, y las
   que no estan al mismo nivel de sangrado que la anterior no:

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

     --------------------------------------------------------------

6. Trato al lector o lectora

   Cuando hay que dirigirse al lector o lectora siempre usamos el
   usted, habitual en muchos paises en cualquier ambito y respetuoso
   en cualquiera de los demas. Como puede verse en el titulo existe
   tambien el problema del genero de quien lee el texto; casi siempre
   hay una manera de evitar usarlo (buscando bien) pero puede
   alternarse el uso del genero. Evitamos el uso de la forma
   lector/a, programador/a, etcetera, que a costa de una pretendida
   correccion politica convierte a los textos en algo bastante mas
   dificil de leer.

     --------------------------------------------------------------

7. Lexico

   Es muy importante intentar evitar argot, giros, dichos o bromas
   exclusivos de un solo pais, region, ciudad o grupo social. La
   Documentacion sera leida por gentes muy diversas en cualquier
   lugar del mundo y puede ser muy frustrante que lo que uno quiere
   hacer este documentado pero no lo podamos entender "por no haber
   viajado suficiente".

     --------------------------------------------------------------

8. Ayuda

  8.1. Lista doc@es.FreeBSD.org

   La lista de correo sobre la documentacion de FreeBSD en castellano
   es el lugar ideal para enviar:

   dudas de traduccion

   ideas, sugerencias, criticas sobre la documentacion (en castellano
   o relacionadas con la Documentacion en ingles)

   errores en la generacion de documentacion

     --------------------------------------------------------------

  8.2. Diccionarios en Internet

   Existen muchos diccionarios en Internet y en bastantes de ellos
   podemos consultar terminos gratuitamente. Las palabras mas
   tecnicas y muchas exclusivas de FreeBSD no apareceran en ninguno
   de estos diccionarios y en pocos de los editados en papel, por lo
   que tendra que recurrir a otros documentos ya traducidos o a la
   lista de correo sobre la documentacion de FreeBSD en castellano.

     --------------------------------------------------------------

9. Envio de traducciones

    1. Por correo electronico al coordinador, o bien

    2. si lo considera conveniente, enviarlo a la lista de correo
       sobre la documentacion de FreeBSD en castellano para su
       revision.

    3. send-pr(1)

     --------------------------------------------------------------

10. Voluntarios del FDP-es

   Estos son los colaboradores habituales del FDP-es. Si cree que su
   nombre debe (o no debe) aparecer en esta lista puede escribir al
   autor.

   (en orden alfabetico por apellido):

     * Jose Ramon Baz <jr_baz@hartu.net>

     * Jose Vicente Carrasco Vaya <carvay@es.FreeBSD.org>

     * Luis Lopez <cronopiolopez@terra.es>

     * Jesus R. Camou <jcamou@FreeBSD.org>

     * Jesus Rodriguez <jesusr@FreeBSD.org>

     * Juan F. Rodriguez <jrh@it.uc3m.es>

     * Enrique Matias Sanchez <cronopios@gmail.com>

     --------------------------------------------------------------

11. Agradecimientos

   A la lista de correo sobre la documentacion de FreeBSD en
   castellano por su infinita paciencia durante las revisiones de
   este documento (y desde mucho antes) y a Jesus Rodriguez
   <jesusr@FreeBSD.org> por lo mismo y ademas por animarme. Que tiene
   delito.

  Notas

   [1] Tambien puede traducir desde alguno de los idiomas en los que  
       hay documentacion de FreeBSD. Puede echar un vistazo a los     
       textos traducidos a distintas lenguas en                       
       http://www.es.FreeBSD.org/doc/.                                
   [2] es decir, lo que podemos subir al cvs para que cualquiera      
       pueda verlo repartido por los sitios web de FreeBSD del mundo  
       entero                                                         
   [3] Si es su caso, ya sabe a ciencia cierta que tener una o mas    
       carreras, tecnicas o no, no evita que alguien sea capaz de     
       perpetrar "traducciones" abominables y ademas cobrar por ello. 
       Nosotros no pagamos, pero somos mucho mas estrictos.           
   [4] es posible que el revisor le devuelva el texto si las          
       modificaciones que hay que hacer son muchas y usted mismo      
       puede hacerlas)                                                

     --------------------------------------------------------------

          Puede descargar este y muchos otros documentos desde
                ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

Si tiene dudas sobre FreeBSD consulte la documentacion antes de escribir
                  a la lista <questions@FreeBSD.org>.
    Envie sus preguntas sobre la documentacion a <doc@FreeBSD.org>.
