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.4.1
=============================


    * the 'AddHeader' header parameter can now be used repeatedly to declare 
    several strings that must be inserted in the preamble. 



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) and 'Flex' (version 2.5 or greater). If 'Bison'
version 2.4 or greater is not available, then the tracing options will be
disabled.


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 the file 'configure.ac'). 

    3. generate a 'src/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 version number 
(currently 1.4.1).
The default for ${prefix} is usually /usr/local.



Executing the tests suite
=========================

The ''Aida'' test suite is maintained in a different module in the 
Subversion repository. It can be retrieved from the repository with the
following command:

    svn checkout http://svn.code.sf.net/p/aidadoc/svn/tests


In order to be able to execute it, you must run the configure script
with the '--with-tests' option. The value of this option is the path
to the 'tests' directory you retrieved from the Subversion directory
relative to the 'configure' script. For instance, if the working copy
is at the same level as the directory containing the sources (and the
'configure.ac' file), the path is '../tests' and the configure 
instruction would be:

    ./configure --with-tests=../tests


This will create a 'Makefile' in the 'tests' directory.
See the instructions contained in the 'README' file inside this
directory to learn how to use the test suite.



Help
====
The distribution comes with a help file called 'aida.html' 
located in the 'help' directory.

Download
========


[[1]]
The Aida project is an Open Source project hosted by SourceForge at 
this address. [http://sourceforge.net/projects/aidadoc]

The current version is 1.4.1.

The latest releases can be obtained in the 
File Releases area. [http://sourceforge.net/projects/aidadoc/files/]

The latest state of the source code can be obtained from the Subversion 
repository with the following command :

svn checkout http://svn.code.sf.net/p/aidadoc/svn/trunk Aida





Links
=====

In order to report bugs or make requests about the project, please use the 
issue tracking system. [http://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. [http://sourceforge.net/p/aidadoc/mailman/]


The web page for users of the mailing list to subscribe or 
unsubscribe is: 
aidadoc-users [http://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-2016

All rights reserved.

Last updated: 2016-01-04