Ada Wiki Engine
Ada Makefile Shell Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
distrib
regtests
samples
src
.gitignore
LICENSE.txt
Makefile.in
NEWS
NOTICE.txt
README.md
aclocal.m4
config.gpr
config.guess
config.sub
configure
configure.ac
install-sh
samples.gpr.in
wiki.gpr.in
wiki_tests.gpr.in

README.md

Ada Wiki

Build Status Test Status Download License Commits

Ada Wiki is a small library that provides and focuses only on the Wiki engine.

The library allows to:

  • Parse a wiki text such as Mediawiki, Creole, PhpBB, Dotclear and Google Code
  • Parse HTML content in embedded wiki text,
  • Filter out the wiki, HTML or text through customizable filters,
  • Render the wiki text in HTML, text or another wiki format

The Ada Wiki library is used by Ada Web Application for the implementation of the blog and wiki online plugins.

To use Ada Wiki library, configure as follows:

   ./configure
   make

By default the configure is setup to use the Ada Utility Library. You can disable that by using the 'with-ada-util=no' configure option. When disabled, the build will use some locally imported files (in src/util) but the unit tests will not be compiled.

   ./configure --with-ada-util=no
   make

The unit tests are built and executed with:

   make test

For the installation, use the following command:

   make install

Samples

A first example shows how to render a Wiki text into HTML or text. Another one takes some HTML content and render a Wiki text in one of the supported Wiki format. To build the samples, use the following command:

   gnatmake -Psamples

To import a HTML content and produce a Wiki text, use the following:

   bin/import -M https://en.wikibooks.org/wiki/Ada_Programming > content.wiki

And to render the Wiki text into HTML use:

   bin/render -M content.wiki

The 'words' samples illustrates the use of filters to collect information stored in the documents. It collects words and links and report their usage in the document. The next command reports the links used in the document:

   bin/words -l -M content.wiki

A complete online Wiki application is part of AWA (https://github.com/stcarrez/ada-awa).

Documentation

The Ada Wiki sources as well as a wiki documentation is provided on:

https://github.com/stcarrez/ada-wiki/wiki