xHarbour: Su documentación

Desde hace unos días estoy trabajando en un nuevo editor de ficheros DBF para Xailer para realizar las operaciones de creación y mantenimiento de tablas tanto de su estructura, índices asociados, como de su contenido. He considerado conveniente incluir todas las nuevas características que aporta xHarbour al formato clásico DBF en el proyecto, que son muchas, y aquí es donde me he encontrado con el gran problema de la falta de documentación de xHarbour, y he tenido prácticamente que ponerme la capa y lupa de Sherlock Holmes para intentar encontrar algo al respecto.

Desgraciadamente con la aparición de una nueva documentación de pago por parte de xHarbour.com ha dejado de estar accesible la escueta documentación en línea que ofrecía xHarbour.com en sus páginas Web, que espero sea de forma temporal, y la documentación incluida en xHarbour.org es mínima y casi siempre obsoleta, y tampoco tiene visos de cambiar en el futuro ya que todos los esfuerzos se los lleva la versión comercial de xHarbour.

Después de mucho tiempo buceando por los fuentes y el changelog del CVS me he decidido a comprar la documentación de xHarbour.com, y aunque lógicamente no he podido examinarla por completo, tengo que decir que en las primeras funciones que he consultado, la documentación encontrada ha sido realmente buena, por lo que recomiendo enormemente su compra. No obstante, ya adelanto, que la documentación sólo está disponible en Inglés y dudo que alguna vez vaya a estar en Español.

Realizar la completa documentación de xHarbour en castellano es un trabajo ímprobo y a mi modo de ver incluso inútil. Lo importante, en mi opinión, es centrarse únicamente en las diferencias y mejoras respecto a CA-Clipper, ya que la documentación de CA-Clipper es conocida por casi todos los usuarios de xBase. Si nos limitamos en estos dos puntos el trabajo a realizar se reduce considerablemente e incluso puede llegar a ser más útil que la propia documentación completa de xHarbour, aunque lógicamente, el que se lo pueda permitir y conozca la lengua de Shakespeare haría bien en conseguir la documentación oficial de xHarbour.com. Rafa Carmona inicio un proyecto en la red a través de una Wikipedia que desgraciadamente no ha tenido mucho éxito y creo que ha sido precisamente porque apuntaba demasiado alto al intentar cubrir la completa documentación.

Si lo veis interesante os propongo la creación de una Wikipedia libre, soportada técnicamente por nosotros con el único ánimo de cubrir las diferencias y mejoras de xHarbour con respecto a CA-Clipper, y que en vez de cubrir, función por función, comando por comando, trate dichas diferencias o mejoras como artículos independientes, más fáciles de leer y entretenidos de escribir. A modo de ejemplo, se me ocurren los siguientes artículos:

  • Uso de Advantage Database server con xHarbour
  • Parámetros adicionales en funciones clásicas de CA-Clipper
  • Soporte de XML en xHarbour
  • Uso de Hashes en xHarbour
  • Extensiones de los RDDs

Estoy convencido de que muchos de nosotros nos hemos peleado con cualquiera de estos cinco ejemplos y hemos tenido que sumergirnos en los propios fuentes de xHarbour para conseguir sacar nuestros proyectos adelante. La idea es que todo ese conocimiento pueda ser compartido por el resto de usuarios y todos saquemos
provecho de ello.

Creo que es importante que se realice a través de una Wikipedia, mejor que con un Blog, ya que de esta forma cualquier usuario puede mejorar y actualizar la información de cualquier artículo.

Bueno, ahí esta mi propuesta, espero vuestros comentarios.

Un saludo

2 comentarios en “xHarbour: Su documentación

  1. Rafa Carmona

    Ignacio, hace tiempo que empecé a hacer precisamente eso.

    Puedes darte una vuelta por :
    http://xharbour.wiki.mailxmail.com/PaginaInicial

    De todas maneras, cuenta conmigo, y creo que si lo
    pones en marcha , al estilo Wikipedia, será todo un
    éxito.

    Hay varios temas que ya estan, y otros por terminar y empezar, todo es cuestión de ponerse.

    Yo creo , que la base de que un lenguaje no deje de usarse es tener UNA NUEVA DOCUMENTACION.

    Quizás, más adelante si que se podria poner TODAS las funciones, etc…, pero opino como tu, las extensiones son más necesarias.

    De todas maneras, como todo el mundo de xbase conoce las funciones/comandos, tambien la gente puede documentarlas, porque no se requieren conocimientos avanzados.

    Saludos
    Rafa Carmona

  2. Fredy

    Hola,

    Excelente!!

    Y de la mano del equipo de xailer es un exito asegurado!!

    Contad conmigo. En navegandoconxailer tengo algo sobre xharbour y xml, que con gusto pasaré y ampliaré.

    En cuanto al wiki propiamente dicho, recomiendo dokuwiki, que se basa en ficheros de texto y permite establecer restricciones de acceso para evitar que algún pringao se dedique a meter spam dentro.

    Si quieres, me llamas y lo hablamos.

    Un saludico,

    Fredy

Los comentarios están cerrados.