Skip to content

stcarrez/ada-wiki

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Ada Wiki

Alire Build Status Test Status codecov Download License Commits

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

Version 1.4.0 - Aug 2022

  • Add support for Textile markup language
  • Rewrote the Markdown parser to better follow the Common Mark Specification

List all versions

Build

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

Build without configure

Since the integration with Alire, you can build without running configure. However, there are a number of checks and dependencies which are not verified. The following assumes that you have installed the Ada Utility Library.

For a simple build, use:

gprbuild -aP.alire -Pwikiada -p

You can then use gprinstall for the installation:

gprinstall -aP.alire -Pwikiada -p

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) and can be tried online with Atlas

Documentation

Sites Using Ada Wiki

About

Ada Wiki Engine - Wiki parser and renderer with several Wiki syntaxes

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages