https://github.com/stcarrez/ada-wiki
Ada Wiki Engine - Wiki parser and renderer with several Wiki syntaxes
https://github.com/stcarrez/ada-wiki
ada dotclear html markdown mediawiki wiki-engine
Last synced: 3 months ago
JSON representation
Ada Wiki Engine - Wiki parser and renderer with several Wiki syntaxes
- Host: GitHub
- URL: https://github.com/stcarrez/ada-wiki
- Owner: stcarrez
- License: apache-2.0
- Created: 2015-10-26T20:58:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T22:26:19.000Z (4 months ago)
- Last Synced: 2025-01-30T18:02:22.470Z (3 months ago)
- Topics: ada, dotclear, html, markdown, mediawiki, wiki-engine
- Language: Ada
- Homepage:
- Size: 2.89 MB
- Stars: 19
- Watchers: 8
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE.txt
- Support: support/alire.toml
Awesome Lists containing this project
- awesome-ada - ada-wiki - Ada Wiki is a small library that provides a Wiki engine. (Frameworks / Web)
README
# Ada Wiki
[](https://alire.ada.dev/crates/wikiada)
[](https://porion.vacs.fr/porion/projects/view/ada-wiki/summary)
[](https://porion.vacs.fr/porion/projects/view/ada-wiki/xunits)
[](https://porion.vacs.fr/porion/projects/view/ada-wiki/summary)
[](http://download.vacs.fr/ada-wiki/ada-wiki-1.4.2.tar.gz)
[](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](https://gitlab.com/stcarrez/ada-awa)
for the implementation of the blog and wiki online plugins.
You can play with the Wiki engine by using [Wi2wic](https://gitlab.com/stcarrez/wi2wic) on https://wi2wic.vacs.fr/wi2wic/index.html
## Version 1.5.0 - Under development
- Feature #12: Improvement of HTML renderer
- Feature #10: Text renderer improvement
- Fix #11: Newline in link titles should be ignored and replaced by space
## Version 1.4.3 - Nov 2024
- Feature #7: Add a style on HTML table
- Feature #8: Add support for strikeout in markdown
[List all versions](https://gitlab.com/stcarrez/ada-wiki/blob/master/NEWS.md)
## Using with Alire
If you are using [Alire](https://alire.ada.dev/) in your project, run the following command
within your [Alire](https://alire.ada.dev/) project to use the library:
```
alr with wikiada
```
## Using without Alire
If you don't have [Alire](https://alire.ada.dev/) 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](https://gitlab.com/stcarrez/ada-util/)):
```
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=` option in the setup phase).
The installed GNAT projects are the same as those used when using [Alire](https://alire.ada.dev/).
# 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:
```
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](https://gitlab.com/stcarrez/ada-awa)
and can be tried online with [Atlas](https://demo.vacs.fr/atlas/index.html)
# Documentation
* [Ada Wiki Programmer's Guide](https://ada-wiki.readthedocs.io/en/latest/) [PDF](https://gitlab.com/stcarrez/ada-wiki/blob/master/docs/wiki-book.pdf)
* [Using the Ada Wiki Engine](https://blog.vacs.fr/vacs/blogs/post.html?post=2016/04/30/Using-the-Ada-Wiki-Engine)
# Sites Using Ada Wiki
* [Java 2 Ada](https://blog.vacs.fr/)
* [Ada France](https://www.ada-france.org/adafr/index.html)
* [Atlas](https://demo.vacs.fr/atlas/index.html)
* [Wi2wic](https://wi2wic.vacs.fr/wi2wic/index.html)
* [Jason Project Manager](https://vdo.vacs.fr/vdo/index.html)