This page (revision-9) was last changed on 03-Jan-2023 11:22 by Juan Pablo 

This page was created on 12-Apr-2016 11:28 by Harry Metske

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Version Date Modified Size Author Changes ... Change note
9 03-Jan-2023 11:22 5 KB Juan Pablo to previous document existing wiki syntaxes and how to provide support for custom ones
8 03-Jan-2023 11:16 4 KB Juan Pablo to previous | to last document existing wiki syntaxes and how to provide support for custom ones
7 03-Jan-2023 11:01 4 KB Juan Pablo to previous | to last document existing wiki syntaxes and how to provide support for custom ones
6 03-Jan-2023 10:59 4 KB Juan Pablo to previous | to last document existing wiki syntaxes and how to provide support for custom ones
5 03-Jan-2023 10:53 3 KB Juan Pablo to previous | to last document existing wiki syntaxes and how to provide support for custom ones
4 03-Jan-2023 10:52 3 KB Juan Pablo to previous | to last document existing wiki syntaxes and how to provide support for custom ones
3 22-Apr-2016 11:28 304 bytes Harry Metske to previous | to last
2 12-Apr-2016 19:35 284 bytes Juan Pablo to previous | to last added ALLOW edit admin
1 12-Apr-2016 11:28 260 bytes Harry Metske to last
Incoming links Outgoing links
Wiki Syntax
Wiki Syntax

Difference between version and

At line 21 changed one line
* __Wiki syntax markup parser__: needed to parse the custom wiki syntax. This is provided by extending {{org.apache.wiki.parser.MarkupParser}} (f.ex. {{org.apache.wiki.parser.markdown.MarkdownParser}}). This class should be referenced by the {{jspwiki.renderingManager.markupParser}} property on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file.
* __Wiki syntax markup parser__: needed to parse the custom wiki syntax. This is provided by extending {{org.apache.wiki.parser.MarkupParser}} (f.ex. {{[org.apache.wiki.parser.markdown.MarkdownParser|https://github.com/apache/jspwiki/blob/master/jspwiki-markdown/src/main/java/org/apache/wiki/parser/markdown/MarkdownParser.java]}}). This class should be referenced by the {{jspwiki.renderingManager.markupParser}} property on the [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file.
At line 23 changed one line
* __Wiki syntax renderer__: needed to output HTML from your custom wiki syntax. This is provided by extending {{org.apache.wiki.render.WikiRenderer}} (f.ex. {{org.apache.wiki.render.markdown.MarkdownRenderer}}). This class should be referenced by the {{jspwiki.renderingManager.renderer}} property on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file.
* __Wiki syntax renderer__: needed to output HTML from your custom wiki syntax. This is provided by extending {{org.apache.wiki.render.WikiRenderer}} (f.ex. {{[org.apache.wiki.render.markdown.MarkdownRenderer|https://github.com/apache/jspwiki/blob/master/jspwiki-markdown/src/main/java/org/apache/wiki/render/markdown/MarkdownRenderer.java]}}). This class should be referenced by the {{jspwiki.renderingManager.renderer}} property on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file.
At line 25 changed one line
* __Wiki syntax renderer fo WYSIWYG editor__: needed if you need to display the resulting HTML somewhat different on the WYSIWYG editor, i.e, to add/remove some css classes. Usually you don't need to provide a custom class for this, and it will be fine to use the normal wiki syntax renderer. In any case, you must specify the renderer on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file using the property {{jspwiki.renderingManager.renderer.wysiwyg}}.
* __Wiki syntax renderer fo WYSIWYG editor__: needed if you need to display the resulting HTML somewhat different on the WYSIWYG editor, i.e, to add/remove some css classes. Usually you don't need to provide a custom class for this, and it will be fine to use the normal wiki syntax renderer. In any case, you __must__ specify this renderer on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file using the property {{jspwiki.renderingManager.renderer.wysiwyg}}.
At line 27 changed one line
* __Support for translating HTML to the custom wiki syntax on the WYSIWYG renderer__: by extending {{extending org.apache.wiki.htmltowiki.syntax.WikiSyntaxDecorator}}, (f.ex. {{org.apache.wiki.htmltowiki.syntax.markdown.MarkdownSyntaxDecorator}}). This class should be referenced by the {{jspwiki.syntax.decorator}} property on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file.
* __Support for translating HTML to the custom wiki syntax on the WYSIWYG renderer__: by extending {{extending org.apache.wiki.htmltowiki.syntax.WikiSyntaxDecorator}}, (f.ex. {{[org.apache.wiki.htmltowiki.syntax.markdown.MarkdownSyntaxDecorator|https://github.com/apache/jspwiki/blob/master/jspwiki-markdown/src/main/java/org/apache/wiki/htmltowiki/syntax/markdown/MarkdownSyntaxDecorator.java]}}). This class should be referenced by the {{jspwiki.syntax.decorator}} property on your [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration] file.
At line 33 added 6 lines
* Not really necessary, but you can also provide an __[EngineLifecycleExtension|HowToWriteAnEngineLifecycleExtension]__ to enable the custom wiki syntax with one property (ideally {{jspwiki.syntax}}), instead of setting 5 low level properties. This will ease the installation and adoption of the custom wiki syntax. See for instance the {{[org.apache.wiki.markdown.MarkdownSetupEngineLifecycleExtension|https://github.com/apache/jspwiki/blob/master/jspwiki-markdown/src/main/java/org/apache/wiki/markdown/MarkdownSetupEngineLifecycleExtension.java]}} class, which does this for the markdown module.
* Last, but not least, you can also optionally provide a __mechanism to migrate existing wiki pages__ to the new wiki syntax. In the markdown case, this is accomplished through the {{[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]}} test file.
[Category.Documentation]
[{PageViewPlugin}]
This page (revision-9) was last changed on 03-Jan-2023 11:22 by Juan Pablo  Top