This page (revision-18) was last changed on 01-May-2024 14:14 by Juan Pablo 

This page was created on 08-Dec-2017 22:03 by Juan Pablo

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Version Date Modified Size Author Changes ... Change note
18 01-May-2024 14:14 2 KB Juan Pablo to previous as of 2.12.2, we deliver markdown sets of wikipages
17 06-Apr-2024 13:54 3 KB Juan Pablo to previous | to last No default set of WikiPages for markdown, they must be derived from default ones
16 03-Jan-2023 11:10 2 KB Juan Pablo to previous | to last Remove outdated documentation
15 03-Jan-2023 11:10 3 KB Juan Pablo to previous | to last Remove outdated documentation
14 30-Jul-2022 12:46 3 KB Juan Pablo to previous | to last markdown is usable now
13 30-Jul-2022 12:42 3 KB Juan Pablo to previous | to last list jspwiki -> markdown conversion tool
12 22-Mar-2022 12:08 3 KB Juan Pablo to previous | to last Update Markdown support as of 2.11.3-git-04
11 22-Mar-2022 12:07 3 KB Juan Pablo to previous | to last Update Markdown support as of 2.11.3-git-04
10 11-Mar-2022 13:58 3 KB Juan Pablo to previous | to last simplify configuration as per 2.11.3-git-02
9 11-Jan-2022 22:43 3 KB Juan Pablo to previous | to last Update Markdown support as of 2.11.1-git-02
8 11-Jan-2022 22:42 3 KB Juan Pablo to previous | to last Update Markdown support as of 2.11.1-git-02
7 11-Jan-2022 14:29 2 KB Juan Pablo to previous | to last
6 11-Jan-2022 14:28 3 KB Juan Pablo to previous | to last Update Markdown support as of 2.11.1-git-02
5 16-Dec-2017 23:46 2 KB Juan Pablo to previous | to last
4 09-Dec-2017 00:39 3 KB Juan Pablo to previous | to last
3 09-Dec-2017 00:33 2 KB Juan Pablo to previous | to last
2 09-Dec-2017 00:31 2 KB Juan Pablo to previous | to last
1 08-Dec-2017 22:03 2 KB Juan Pablo to last
Incoming links Outgoing links
Markdown Support
Markdown Support

Difference between version and

At line 7 changed one line
! Markdown parser / renderer
! Markdown parser / renderer / editors
At line 9 changed one line
Beginning with JSPWiki 2.10.3-git-44 there is also (some) support for using Markdown instead of normal JSPWiki syntax.
As of JSPWiki 2.11, there is built in support for using Markdown instead of normal JSPWiki syntax.
At line 11 changed one line
This markdown support is __not__ directly built in yet though, as it requires at least Java 7 to run, whereas JSPWiki 2.10 requires at least Java 6, so the {{jspwiki-markdown}} jar must be manually included inside the main JSPWiki war (f.ex., through a Maven depependency). Once that is done, the following lines should be added to your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file:
The following line should be added to your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file:
At line 14 added 6 lines
jspwiki.syntax=markdown
}}}
which is equivalent to adding the following lines to your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file:
{{{
At line 23 added 2 lines
jspwiki.syntax.decorator=org.apache.wiki.htmltowiki.syntax.markdown.MarkdownSyntaxDecorator
jspwiki.syntax.plain=plain/wiki-snips-markdown.js
At line 19 removed 6 lines
%%info
A complete example showing the integration of the markdown parser/renderer can be found at this github [repo|https://github.com/juanpablo-santos/jspwiki-markdown/tree/master/jspwiki-markdown-war]
%%
JSPWiki 2.11 will most probably require Java 8, so this markdown support will be built in.
At line 26 changed 10 lines
The Parser/Renderer is based on [Flexmark|https://github.com/vsch/flexmark-java] + a custom JSPWiki extension. Currently it supports:
* CommonMark flavour of Markdown
* Wiki links (internal, external, interwiki, edit, etc.)
* Variables
* Almost all plugins (more on this below)
* Inline images
* Footnotes
* ACLs
* Metadata
* WYSIWYG edition
The Parser/Renderer is based on [Flexmark|https://github.com/vsch/flexmark-java] (CommonMark 0.28 flavour of Markdown) with
* [Attributes|https://github.com/vsch/flexmark-java/wiki/Extensions#attributes] extension
* [Definition|https://github.com/vsch/flexmark-java/wiki/Extensions#definition-lists] extension
* [Tables|https://github.com/vsch/flexmark-java/wiki/Extensions#tables] and [TOC extension|https://github.com/vsch/flexmark-java/wiki/Extensions#table-of-contents] extensions
* A custom JSPWiki extension, that currently supports:
** Wiki links (internal, external, interwiki, edit, etc.)
** Variables
** Almost all plugins (more on this below)
** Inline images
** Footnotes
** ACLs
** Metadata
** WYSIWYG edition
* As of 2.12.2, initial set of markdown-flavoured wiki pages
* {{[org.apache.wiki.markdown.migration.WikiSyntaxConverter|https://github.com/apache/jspwiki/blob/master/jspwiki-markdown/src/test/java/org/apache/wiki/markdown/migration/WikiSyntaxConverter.java]}} to convert from JSPWiki syntax to markdown
At line 37 changed 6 lines
! Gotchas / Current shortcomings
* Plain editor toolbar support
* Initial set of WikiPages for markdown / markup migration tool?
* {{~%%css}} constructs. A new extension for this should be made, there is no support for this.
* Plugins implementing HeadingListener (that is, TableOfContents) are not supported
** this interface is fired by {{JSPWikiMarkupParser}} every time it finds a header (more precisely, for every heading, JSPWikiMarkupParser generates a "#" link with the section reference and then registers a HeadingListener).
! Gotchas
* {{HeadingListener}} support is not available for plugins implementing it (f.ex., [TableOfContents|TableOfContentsPlugin]).
** {{HeadingListener}} is fired by {{JSPWikiMarkupParser}} every time it finds a header (more precisely, for every heading, {{JSPWikiMarkupParser}} generates a {{#}} link with the section reference, and then registers a {{HeadingListener}}).
At line 44 changed 5 lines
** Right now, TableOfContents plugin is translated to flexmark's own TOC extension, surrounded with some divs.
** There are two proper ways of adding support for this:
*** add enough css so that both html render more or less the same. Parameters parsing should be implemented anyways.
*** add a new Flexmark extension for TOC, probably forking+adapting the existing TOC extension.
* Thorough end-to-end testing
** To overcome this situation, in the case of [TableOfContents|TableOfContentsPlugin] plugin, it is translated to flexmark's own [TOC extension|https://github.com/vsch/flexmark-java/wiki/Extensions#table-of-contents], surrounded with some divs.
[Category.Documentation]
[{PageViewPlugin}]
[{ALLOW edit Admin}]
[{ALLOW view All}]
This page (revision-18) was last changed on 01-May-2024 14:14 by Juan Pablo  Top