NAME

Wiki::JSON - Parse wiki-like articles to a data-structure transformable to JSON.

SYNOPSIS

use Wiki::JSON;

my $structure = Wiki::JSON->new->parse(<<'EOF');
= This is a wiki title =
'''This is bold'''
''This is italic''
'''''This is bold and italic'''''
== This is a smaller title, the user can use no more than 6 equal signs ==
<nowiki>''This is printed without expanding the special characters</nowiki>
* This
* Is
* A
* Bullet
* Point
* List
{{foo|Templates are generated|with their arguments}}
{{stub|This is under heavy development}}
The parser has some quirks == This will generate a title ==
''' == '' Unterminated syntaxes will still be parsed until the end of file
This is a link to a wiki article: [[Cool Article]]
This is a link to a wiki article with an alias: [[Cool Article|cool article]]
This is a link to a URL with an alias: [[https://example.com/cool-source.html|cool article]]
This is a link to a Image [[File:https:/example.com/img.png|50x50px|frame|This is a caption]]
EOF

DESCRIPTION

A parser for a subset of a mediawiki-like syntax, quirks include some supposedly inline elements are parsed multi-line like headers, templates*, italic and bolds.

DESCRIPTION

A parser for a subset of a mediawiki-like syntax, quirks include some supposedly inline elements are parsed multi-line like headers, templates*, italic and bolds.

Lists are only one level and not everything in mediawiki is supported by the moment.

INSTALLING

cpanm https://github.com/sergiotarxz/Perl-Wiki-JSON.git

USING AS A COMMAND

wiki2json file.wiki > output.json

INSTANCE_METHODS

new

my $wiki_parser = Wiki::JSON->new;

METHODS

parse

my $structure = $wiki_parser->parse($wiki_string);

Parses the wiki format into a serializable to JSON or YAML Perl data structure.

Return from parse

The return is an ArrayRef in which each element is either a string or a HashRef.

HashRefs can be classified by the key type which can be one of these:

hx

A header to be printed as h1..h6 in HTML, has the following fields:

hx_level

A number from 1 to 6 defining the header level.

output

An ArrayRef defined by the return from parse.

template

A template thought for developer defined expansions of how some data shoudl be represented.

template_name

The name of the template.

output

An ArrayRef defined by the return from parse.

bold

A set of elements that must be represented as bold text.

output

An ArrayRef defined by the return from parse.

italic

A set of elements that must be represented as italic text.

output

An ArrayRef defined by the return from parse.

bold_and_italic

A set of elements that must be represented as bold and italic text.

output

An ArrayRef defined by the return from parse.

unordered_list

A bullet point list.

output

A ArrayRef of HashRefs from the type list_element.

list_element

An element in a list, this element must not appear outside of the output element of a list.

output

An ArrayRef defined by the return from parse.

link

An URL or a link to other Wiki Article.

link

The String containing the URL or link to other Wiki Article.

title

The text that should be used while showing this URL to point the user where it is going to be directed.

image

An Image, PDF, or Video.

link

Where to find the File.

caption

What to show the user if the image is requested to explain to the user what he is seeing.

options

Undocumented by the moment.

BUGS

The author thinks it is possible the parser hanging forever, use it in a subprocess the program can kill if it takes too long.

The developer can use fork, waitpid, pipe, and non-blocking IO for that.

LEGAL

Copyright ©Sergiotarxz (2025)

You can use this software under the terms of the GPLv3 license or a new later version provided by the FSF or the GNU project.

SEE ALSO

Look what is supported and how in the tests: https://github.com/sergiotarxz/Perl-Wiki-JSON/tree/main/t

cpanm Wiki::JSON

perl -MCPAN -e shell
install Wiki::JSON