Proyecto de Documentación de FreeBSD: Proyectos Actuales
Estos son los proyectos en curso (o sobre los que se está trabajando en la lista freebsd-doc).
Si piensa que puede ayudar en cualquier de ellos, por favor, no dude en hacerlo. Hable con la persona responsable, que le pondrá al día con la marcha del proyecto. Si tiene ideas sobre un nuevo proyecto, por favor, envíelas a [email protected].
- Lista TODO (tareas pendientes) de documentación
- Informes de problemas abiertos sobre la documentació
- Enviar presentaciones
- FreeBSD para usuarios de Linux
- Escribir una sección del Handbook y/o las FAQ
- Escribir nuevos documentos
- Scripts CGI
- Web scripts multilíngües
- Traducciones de la documentación de FreeBSD
- Mejoras en el motor de búsquedas
Lista TODO de documentación
La lista TODO de documentación es una lista actualizada de los problemas de la documentación que están por solucionarse. Dicha lista se envía cada mes a la lista de correo [email protected]. Si quiere ayudarnos a mejorar la documentación de FreeBSD puede elegir por dónde empezar por la lista TODO.
Informes de problemas abiertos de la documentación
Los informes de problemas que hay abiertos están en la base de datos GNATS.
Responsable: Annelise Anderson <[email protected]> Aquí puede verlos.
Mejoras en el índice del Handbook
Responsable: FreeBSD-doc <[email protected]>
Sinopsis: Muchas nuevas secciones se añadieron al Handbook de FreeBSD sin la correspondiente entrada en el índice, otras se añadieron con etiquetas indexterm primarias o secundarias que no se adaptan al esquema actual. Algunos términos se añadieron dentro de listas u otras áreas, cosa que no permite nuestra hoja de estilo, con lo que en el índice aparece ??? en vez del número de la página.
El trabajo en el índice requiere experiencia previa; quien quiera hacer modificaciones en él debería leer atentamente el índice existente (print-output) y el Chicago Manual of Style u otro libro que trate sobre índices. Por favor, consulte en el histórico del CVS sobre los errores ya corregidos de los ficheros chapter.xml y el índice. Es imprescindible revisar la versión PostScript del Handbook después de hacer cualquier cambio en "indexterm"; palabras demasiado largas o "indexterms" demasiado anidados pueden destruir la salida en dos columnas o hacer aparecer el número de página como ???.
Puede usar el "script" doc/share/misc/indexreport.pl para encontrar las ocasiones en las que <indexterms> está en un sitio incorrecto en un fichero SGML.
Enviar presentaciones
Responsable: FreeBSD-doc <[email protected]>, Murray Stokely <[email protected]>
Sinopsis: Las presentaciones hechas mediante la DTD DocBook-slides se han añadido recientemente a la documentación; están en doc/en_US.ISO8859-1/slides. Hace falta más material para usar en charlas y conferencias. También es necesario trabajar más en hojas de estilo para integrar contenidos de las noticias de releases así como otros contenidos XML a nuestra documentación. De este modo será más fácil generar presentaciones totalmente actualizadas con un simple 'make'. Un ejemplo simple de presentación con algunas de estas características ya está en el CVS pero hay que hacer más. Además de esto, las hojas de estilo de la salida print/PDF (mediante procesadores XSLT basados en Java, PassiveTeX se queda corto para hacer presentaciones de calidad) se deberían mejorar también ya que las hojas de estilo XSL-FO generan presentaciones muy espartanas.
FreeBSD para usuarios de Linux
Responsable: FreeBSD-doc <[email protected]>
Sinopsis: Los usuarios de FreeBSD provenientes de Linux pueden confundirse gracias a algunas de las diferencias que hay entre los dos sistemas (diferente shell por omisión, el funcionamiento de la configuración del arranque, etc).
Escribir una sección en las FAQ y/o Handbook
Responsable: Ninguno
Sinopsis: Hay algunas partes de las FAQ y del Handbook que están incompletas y esperando su aportación. Si ha usado alguna parte de la documentación y cree que es complicada o insuficiente, por favor, complétela con sus experiencias.
Si tuvo que hacer algo que no existe en las FAQ y/o el Handbook puede escribir una nueva sección del documento. Envíelo como se explica más arriba.
Escribir nuevos documentos
Escribir nuevos Tutoriales
El nuevo SCSI de FreeBSD (CAM)
Responsable: <[email protected]>, <[email protected]>
Sinopsis: Lea The Design and Implementation of the FreeBSD SCSI Subsystem como introducción.
Scripts CGI
Responsable: <[email protected], Wolfram Schneider <[email protected]>
Sinopsis: Los scripts CGI url.cgi, ports.cgi, pds.cgi y el script de portindex deben modificarse para que usen los módulos FreeBSD::Ports de Perl. Estos módulos necesitan que se les hagan pruebas exhaustivas.
xfig-3.2.2|/usr/ports/graphics/xfig|/usr/X11R6|A drawing program for X11|/usr/ports/graphics/xfig/pkg/DESCR|[email protected]|graphics x11|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b xpm-3.4k|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b netpbm-94.3.1 tiff-3.4 transfig-3.2 xpm-3.4k
Scripts web multilíngues
Responsable: <[email protected]>
Sinopsis: Nuestras páginas web están escritas en inglés (americano). Los Proyectos de Traducción de FreeBSD traducen el sitio web, el Handbook y las FAQ a otras lenguas.
Hay que traducir los scripts cgi del web y las herramientas de creación del web. Los scripts deberín admitir el uso de distintos idiomas, no sólo uno. Muchos de estos scripts están escritos en Perl.
- Unificar los scripts www/en/ports/portindex y www/ja/ports/portindex en un sólo script. Añadir una opción para la salida en inglés o japonés.
Traducciones de la documentación de FreeBSD
Responsable: <[email protected]>
Traducir la documentación de FreeBSD (Web, FAQ, Handbook, páginas man) a otros idiomas. Consulte los detalles en el proyecto de traducciones.
Mejoras en el motor de búsquedas
Responsable: <[email protected]>
Cuando realizamos una búsqueda en el web el resultado que obtenemos es el nombre del fichero en el que se ha encontrado el resultado, algo como FAQ34.html.
Sería mucho más útil si los resultados incluyesen el texto en cuestión, permitiendo al usuario ver la relevancia del resultado obtenido.