Re: Documentacion en Debian (sugerencia a debatir)
--- Santi Béjar <tiarda@SPAMNOyahoo.es> wrote: >
first last <prelude_2_murder@yahoo.co.uk> writes:
>
> > La idea no es ser capaz de buscar toda la
> documentacion desde un
> > navegador, sino que toda ella tenga el mismo
> formato, html que es
> > facil de desarrollar, ofrece ventajas sobre
> man/info como la
> > posibilidad de incluir graficos si se ve la pagina
> en X y, sobretodo,
> > incluir toda la documentacion con referencias a
> otras paginas
> > relacionadas (por paquete/tema, etc).
>
> Estaria bien tener todo en un mismo formato. Pero no
> puedes pedir a todo
> el mundo que lo haga así. Como solución menos mala
> lo que se puede hacer
> es traducior de uno al otro (info2html,..), o
> escribirlo en xml,sgml y
> pasarlo a info, man, html, lo que quieras.
Pues si. Se me habia pasado lo de XML (sera porque no
se
oye hablar de el :P).
La idea de usar HTML es porque permite las mismas
funcionalidades (o mas) que los otros dos y ademas
puede separarse presentacion de contenido. Aparte es
facil de escribir. Desde luego XML con un DTD definido
es aun mejor.
> > Ademas no creo que molestara el que fuera
> auto-contenido y no tuviese
> > grandes dependencias tipo apache (prueba a poner
> apache en un
> > ordenador con poca memoria... el pobre se arrastra
> como el solo).
>
> dhelp no necesita ningun servidor web.
OK. No lo he usado pero en otro post se mencionaba
algo
que si que usaba Apache. Igual deberia haber puesto
algo
del otro mensaje tambien. Perdon por el lio.
> > Es mas un tema de estructura interna que de
> > funcionalidad, ya que no se annade mucha en un
> > principio, sino que facilita el desarrollo de la
> > documentacion.
>
> Puede que si, pero también le pones barreras, tienes
> que escribir html
> en vez de lo que siempre has hecho. Si lo que
> escribes es una página del
> man no creo que html2man quede muy bien ({x,sg}ml a
> man si que queda
> bien).
Completamente de acuerdo. De hecho lo primero seria
crear un sistema de conversion y hacer esa conversion
de manera progresiva hasta finalmente incluirlo como
parte de la politica de desarrollo de Debian, asi todo
el mundo tendria tiempo de familiarizarse con el
sistema.
> Vamos a ver. Lo que dices es escribirlo todo en html
> porque te da mas
> funcionalidades que man/info,... Supongamos que se
> hace (caso
> hipotético). Llega un punto que nos damos cuenta que
> xml nos da más
> funcionalidades que html. Tenemos que cambiar toda
> la documentación a
> xml. En unos años vemos que hay tal tecnologia que
> nos da mas
> funcionalidades.... No vamos a acabar.
Cierto. Vuelvo a darte la razon con el XML.
> Lo que creo que sí es factible es que haya una forma
> uniforme de acceder
> a esa documentación, esté en el formato que esté.
> Tienes una aplicación
> que le dices: Quiero documentación de la aplicación
> gqview. Y te salga
> la página del manual, la página del info, la
> documentación de
> /usr/share/doc/gqview. La ayuda on-line, los
> ejemplos,...
Para eso haria falta algun tipo de nexo comun. Igual
tan solo haria falta un sistema con el que, al incluir
ciertos datos en el paquete, se annadiera toda la
posible documentacion de los paquetes y se
relacionaran
(por ejemplo annadiendo un apartado funcion en la
descripcion, tipo "www-browser").
> Para los que escriben la documentación. Estaría bien
> que yo desde la doc
> de gqview pudiera poner un enlace a un apartado de
> la documentación de
> ee (electronic eyes). Ya que los dos hablan de cosas
> parecidas.
?No es eso (con otros matices) lo que aparece al final
de las paginas man? Lo mas importante seria definir la
politica para que fuera coherente. Como ejemplo, hay
paquetes que no tienen documentacion (tipo Samba) pero
tienen un paquete especial paquete-doc. Cuando
intentas
leer la documentacion te lias porque no hay ninguna
referencia (suelen estar casi vacios, solo con
README.Debian y poco mas). Ahi deberia haber un enlace
o referencia a la existencia de la documentacion, ?no
crees?
> O si
> hago un manual de usuario de debian pudiera
> *incluir* (no un enlace)
> apartados del manual de usuario de linux, ya que hay
> muchas cosa en
> común. Pero todas estas relaciones requieren otro
> tipo de mantenimiento
> (tienes que comprobar que lo que incluyes sea
> coherente en el
> tiempo,...). No digo que sea mayor esfuerzo ni
> menor, solo diferente.
Eso ya es mucho mas complejo. Mi idea es que la
documentacion sobre temas diferentes este en sitios
diferentes y que exista una forma estandar de acceder
a toda la que este relacionada.
> Y
> a la gente le cuesta cambiar. Pero siempre puedes
> presentar tus ideas
> concretas y que los que escriben decidan si las
> siguen o no.
Por supuesto. No pretendo que la gente acepte esto
porque yo lo digo (ademas que no lo harian), sino
abrir
un debate. La documentacion es de lo mas importante y
de lo mas molesto para hacer. Todas las facilidades
que
se den para quitar trabajo favorecen que la gente
pueda
contribuir mas facilmente.
> He escrito más de lo que queria, y tampoco estoy
> seguro que se me vaya a
> entender, pero ahí está.
Se te entiende perfectamente.
Gracias por las ideas.
Gabriel
__________________________________________________
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: