Ada Wiki is a small library that provides a Wiki engine supporting several Wiki syntaxes.
The library allows to:
- Parse a wiki text such as Markdown, 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.
You can play with the Wiki engine by using Wi2wic on https://wi2wic.vacs.fr/wi2wic/index.html
- Feature #12: Improvement of HTML renderer
- Feature #10: Text renderer improvement
- Fix #11: Newline in link titles should be ignored and replaced by space
- Feature #7: Add a style on HTML table
- Feature #8: Add support for strikeout in markdown
If you are using Alire in your project, run the following command within your Alire project to use the library:
alr with wikiada
If you don't have Alire or want to build and install the library
on a specific place, run a setup command to configure the build as well as installation
directory (note: you must have built and installed Ada Utility Library):
make setup BUILD=debug PREFIX=/build/install HAVE_ALIRE=no
Then build, run the unit tests and install by using:
make build
make test
make install
To use the installed libraries, make sure your ADA_PROJECT_PATH contains the directory
where you installed the libraries (configured by the PREFIX=<path> option in the setup phase).
The installed GNAT projects are the same as those used when using Alire.
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:
cd samples
alr build
or use:
make samples
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 and can be tried online with Atlas