Escribiendo el manual de AjGenesis

Published on Author lopezLeave a comment

Estoy trabajando en la nueva versión de AjGenesis que será la 0.4.3. Además de algunas mejoras menores en el lenguaje AjBasic, tendrá ejemplos más completos, que producen artefactos de textos y sistemas casi armados, en distintas tecnologías. Pero una de las críticas recibidas de la anterior versión, la 0.4.2, es la falta de documentación. Hoy escribí las primeras páginas de un manual (un “quick start”), y para eso escribí un pequeño programa el AjManual:



Se basa en archivo XML que describe el manual


<?xml version=”1.0″ encoding=”utf-8″ ?>
<Manual HeaderFile=”header.txt” FooterFile
=”footer.txt”>
   <File Name
=”style.css”/>
   <Item Name
=”index”/>
   <Item Name
=”intro”/>
   <Item Name
=”install”/>
   <Item Name
=”firstexample”>
      <Item Name
=”firstexample2″/>
      <Item Name
=”firstexamplenant”/>
      <Item Name
=”firstexamplesln”/>
   </Item
>
   <Item Name
=”ajbasic”>
      <Item Name
=”ajbasicvars”/>
      <Item Name
=”ajbasiccmds”/>
   </Item
>
</
Manual
>


y luego, cada página es un archivo de texto, con notaciones similares a un wiki (sí, también se viene en cualquier momento el AjWiki). Al procesarlo con el AjManual, se transforma en archivos HTML, con un encabezamiento, pie que se pueden especificar. También genera una tabla de contenidos en la página que se especifique.


Nos leemos!


Angel “Java” Lopez
http://www.ajlopez.com/


 

Leave a Reply

Your email address will not be published. Required fields are marked *