avtonom/creole-bundle

A bundle for Symfony 2 PHP Framework with support for Creole 1.0 Wiki markup language.

v1.0.0 2015-06-01 22:32 UTC

Requires

• php: >=5.3.3
• symfony/twig-bridge: ~2.3

GNU GPL v3

• Christian Hoffmeister, Avtonom

• parser
• markup
• wiki
• creole
• wikitext

README

Not maintained anymore

I do not maintain this library anymore. If some wants to fork and proceed, no problem.

What is WikiBundle?

This is a bundle for Symfony2. It provides a parser and two renders for Wiki markup (Creole v1.0). The parser and the lexer transfer the markup into an class oriented tree structure. This structure is used by the XhtmlRenderer and LatexRenderer to create an formatted output. Its easy to write your very own renderer.

Performance

The parsing is quiet fast (benchmarks will follow). Additional its is easy to cache the parsed result. Each class representing the tree structure implements the Serializable interface. So each time the markup changes, you can parse it once and then store the serialized form of the tree (for example with Doctrine 2 in a column of type Object). Once you need to render the markup you can just deserialize the tree (which is way faster) and then render it directly without a need to reparse it.

Reliability

This bundle is unit tested with 100% code coverage. The Parser is tested with lots of special testcase to ensure the correct Wiki markup interpretation. In addition their is random markup generated and tests check if their occur any errors. This random markup is parse, rendered to latex code and then passed to pdflatex to avoid PDF build errors.

To do

Following markup is missing by now:

• Images: Will follow soon
• Placeholder: Not sure if I want to implement it

The LatexRenderer has deactivated features:

• Tables (their is still some issue with pdflatex - so deactivated by now)
• Italic, Bold (pdflatex does not allow italic or bold span over two paragraphs - so deactivated by now)