AidaDoc Files

The Aida project is twofold: it defines a simple common markup language
designed to describe structured text, and provides a command line tool
which translates the Aida syntax into various target formats (Html, Latex,
Trac, Mediawiki, Text, Markdown,...).

New features in version 1.2
===========================

The main new features are:

    * new option -collapse in the aida convert and aida split commands 

    * new option extensions for the 'aida info' command 

    * new header parameters :Output: and :Extension: 

    * better support of the 'format' attribute for the '((table' tag of the text 
    and man targets 

    * new global variable 'aida_temp' containing the name of the temporary 
    directory 

    * new global variable 'aida_output' containing the value of the -output 
    option 

    * empty lines are now eliminated from files written by the man target 



Compiling Aida
==============

Compiling the aida command from the sources should not be a problem
on a Unix-like system, provided a C compiler is present on the
machine, as well as a recent version of Bison (version 2.4 or
greater is required) and Flex (version 2.5 or greater).


The compiling process is driven by a Makefile. It is quite standard 
and can be performed by the following steps:

    1. retrieve the most recent aida sources (see the Download section [[1]]).

    2. go to the top directory containing the sources (i-e the directory 
    containing in particular the file configure.ac).

    3. generate a config.h.in file with the command:
        autoheader

    4. generate the configure script with the command:
        autoconf
     
    5. execute the configure script with the command:
        ./configure
     
    6. compile the sources with the command:
        make
     
    7. install the binary and the library with the following command 
    (you must have administrator privileges):
        sudo make install
     

By default, the binary is installed in ${prefix}/bin and the library in
${prefix}/share/aida/VERS where VERS designates the current version number.
The default for ${prefix} is usually /usr/local.



Links
=====

The official home page of the project is at SourceForge:

<http://sourceforge.net/p/aidadoc/home/>


The distribution comes with a help file called AidaHelp.html 
located in the help directory.


In order to report bugs or make requests about the project, please use the 
issue tracking system. [https://sourceforge.net/p/aidadoc/tickets/]


In order to discuss the usage of the Aida system or the Aida Markup
Language, there is a
mailing list. [https://sourceforge.net/p/aidadoc/mailman/]


The web page for users of the mailing list to subscribe or 
unsubscribe is: 
aidadoc-users [https://lists.sourceforge.net/lists/listinfo/aidadoc-users]


To post a message to all the list members, 
send an e-mail here. [mailto:aidadoc-users@lists.sourceforge.net] 


You can get info about using the list by sending a 
request message [mailto:aidadoc-users-request@lists.sourceforge.net]
with just the word help as subject or in the body.


License
=======

Aida is a free software developped under a BSD License: see
<http://www.opensource.org/licenses/bsd-license.php>.

(c) Copyright: Bernard Desgraupes, 2010-2012

All rights reserved.

Last updated: 2012-09-14