Documentacion en Debian (sugerencia a debatir)
Hola. He pensado una cosa para mejorar Debian en
eneral. Aun no esta
totalmente definida, pero creo que es una buena idea y
antes de
publicarla en otros sitios prefiero decirlo aqui a ver
que os parece.
La documentacion en Debian esta dividida en man, info
y /usr/share/doc
(aunque algunos paquetes no tienen la segunda o tienen
un directorio
vacio para la tercera).
Yo pienso que seria una buena idea convertir toda esa
documentacion a
html (comprimido o no), almacenada de alguna manera
mas o menos logica
(esta es una de las partes que no estoy seguro de
tener una solucion
correcta), como por ejemplo todo en
/usr/share/doc/paquete con
/usr/share/doc/paquete/man para los manuales,
/usr/share/doc/paquete/info para las paginas info y
/usr/share/doc/paquete/doc para el resto de la
informacion, con un
index.html en el directorio raiz del paquete
/usr/share/doc/paquete/index.html.
Se crean enlaces desde los directorios man e info a
las paginas
correspondientes (de todo esto se ocupa dpkg) para que
las busquedas no
tengan que pasar por todas las paginas (especialmente
apropos).
Si se hace "man comando" pues se mira la pagina
correspondiente al
comando, pero en desde un navegador (posiblemente un
mini-navegador por defecto al menos que se defina
otro). Al final de la pagina, junto con las
referencias a los
comandos relacionados (que en este caso son enlaces a
otras paginas,
haciendolo desde html es mas facil y no es necesario
usar info) se pone
una referencia a la documentacion del paquete. Esta
documentacion podria
estar estructurada en secciones, una para man, otra
para info (si
existe) y otra para la documentacion del paquete al
que pertenece el
comando.
Una de las ventajas de este sistema es que toda la
documentacion
relacionada es accesible desde un solo punto (la
pagina inicial del
paquete, que podria ser llamada con un comando
especial tipo "help
paquete") y esta enlazada entre si, no hay que salir
de la actual, se
puede ir hacia alante y atras y todo lo demas. Ya se
que info hace esto
actualmente, pero si se hace de esta manera solo hace
falta un formato y
ademas esta bastante extendido.
Otra ventaja es que si se esta en X se puede usar un
navegador grafico.
En este caso incluso se pueden incluir diagramas y
graficos que se
ignorarian en modo texto.
Si la cosa se hiciera correctamente nadie deberia de
notar el cambio, ya
que man e info funcionarian exactamente igual (quizas
habria que cambiar
las teclas que se usan, aunque eso podria ser
definible) si no se quisieran usar los annadidos.
Incluso (pensando ya en locuras) se podria hacer de
forma que el
navegador actualizara la documentacion conectando a un
servidor (tipo
apt-get), aunque eso ya traeria problemas de falta de
sincronia con los
paquetes.
No se que dice la LSB sobre el tema de la
documentacion, si define como
tiene que funcionar de cara al usuario o el
funcionamiento interno del
sistema o si esto esta totalmente en contra, pero creo
que Debian seria
el sitio adecuado para hacer este cambio, ya que con
incluirlo como
parte de la politica oficial se conseguiria un cambio
inmediato (habria
que desarrollar los paquetes base primero y despues
creo que hay filtros
man->html e info->html).
Aun no se como se solucionaria el tema de perldoc,
pero no creo que
fuera demasiado dificil usando los filtros. Tampoco se
que formato daria
para imprimir, aunque creo que si se usan CSS2
correctamente se puede
conseguir un formato casi WYSIWYG (lo que ves es lo
que obtienes). Solo
seria necesaria una hoja de estilo para toda la
documentacion, con lo
que no supone un gran esfuerzo.
Creo que el uso de html y un navegador supone ventajas
a nivel de
dificultad para desarrollar la documentacion (que baja
mucho) y
aprovecha el navegador (que ya casi todo el mundo
instala por defecto y sabe usar)
y, sobretodo, unifica el formato.
Como vereis esto es una sugerencia, la idea esta
abierta a todas las
opiniones. Si veo que hay apoyo lo propondre en la
Espiral,
debian-developer y de paso en debianplanet para que
opine la gente.
?Que os parece a vosotros?
Nos vemos
Gabriel
PD. Si las lineas son mas largas de la cuenta es que
mi querido Netscape 6 no me deja comprobarlo, mis excusas.
__________________________________________________
Do You Yahoo!?
Everything you'll ever need on one web page
from News and Sport to Email and Music Charts
http://uk.my.yahoo.com
Reply to: