Package com.jalios.jcms.wiki
Class WikiRenderer
java.lang.Object
com.jalios.jcms.wiki.WikiRenderer
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
- Direct Known Subclasses:
WikiRenderer
This class contains a set of utility static methods to process
wiki text.
- Since:
- jcms-5.5.0
- Author:
- Olivier Dedieu, Olivier Jaquemet
-
Field Summary
FieldsFields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringencodeSection(Data data, String field, String update) static Set<Publication> extractPubSetFromUrl(String text) Returns the set of publication referenced through URL in the given text.static Set<Publication> extractPubSetFromWiki(String text) Returns the set of publication referenced through wiki link in the given text.static StringextractSection(String text, String section) static StringupdateSection(String text, String section, String update) static Stringwiki2html(String text, Locale userLocale, WikiRenderingHints hints) Transform a given string formatted according the wiki text formatting rules in an HTML string.static Stringwiki2RawText(String wiki, Locale userLocale, WikiRenderingHints hints) Transform the specified string formatted according the wiki text formatting rules in a raw text string without any format.
-
Field Details
-
LINK_TARGET_ATTRIBUTE
- See Also:
-
-
Constructor Details
-
WikiRenderer
public WikiRenderer()
-
-
Method Details
-
wiki2html
Transform a given string formatted according the wiki text formatting rules in an HTML string. The wiki formatting rules used follows the twiki.org text formatting rules:formatting rules Wiki format HTML output *bold* <b>bold</b> _italic_ <i>italic</i> __bold italic__ <b><i>bold italic</i></b> =fixed font= <code>fixed font</code> ==bold fixed font== <code><b>bold fixed font</b></code> Paragraphe
A blank line<p> Heading
At least three dashes at the beginning of a line, followed by plus sign and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading ; the maximum is 6.---++ 1. A title
---+++ 1.1 A subtitle<h1>A title</h1>
<h2>A subtitle</h2>Separator
At least 3 dashes at the beginning of a line---------
<hr> List item
A multiple of three spaces and an asterisk* A list item
* A nested list item<ul>
<li>A list item</li>
<ul>
<li>A nested list item</li>
</ul>
</ul>Ordered list
A multiple of three spaces and a number1 A first item
2 A second item<ol>
<li>A first item</li>
<li>A second item</li>
</ol>Definition list
Three spaces, the term, a colon, followed by the definitionNote: Terms with spaces are not supported. In case you do have a term with more than one word, separate the words with dashes or with the non-breaking-space entity.
USB: Universal Serial Bus
Firewire (IEEE 1394): High Performance Serial Bus<dl>
<dt>USB</dt><dd>Universal Serial Bus</dd>
<dt>Firewire&nbsp;(IEEE&nbsp;1394)</dt><dd>High Performance Serial Bus</dd>
</dl>Publication Links
A publication's title or id enclosed in double square brackets.[[The title of a publication]]
[[c_1234]]<a href="link to the publication">Title of the publication</a> Images insertion
A valid image file name (ending with .jpg, .jpeg, .gif or .png)upload/gallery/image.jpg
<img src="upload/gallery/image.jpg"> File Links
A valid image file name enclosed in double square brackets.[[upload/pdf/overview.pdf]]
<a href="upload/pdf/overview.pdf">overview.pdf</a> - Parameters:
text- the wiki text to format. if null or empty, an empty string is immediately returned.userLocale- an optional (though highly recommended)Localeof the user for which the text will be generated. if null, the channel default locale will be used.hints- the rendering options to use, if null, the default options will be used.- Returns:
- an HTML formatted text.
- Since:
- jcms-5.7.0
-
wiki2RawText
Transform the specified string formatted according the wiki text formatting rules in a raw text string without any format.The returned text is NOT suitable for presentation to the end user, it is meant only to extract text without wiki tags.
- Parameters:
wiki- the wiki text to format. if null or empty, an empty string is immediately returned.userLocale- an optional (though highly recommended)Localeof the user for which the text will be generated. if null, the channel default locale will be used.hints- the rendering options to use, if null, the default options will be used.- Returns:
- a raw text (without wiki or HTML tags).
- Since:
- jcms-9.0.4 - JCMS-5429
-
extractSection
-
updateSection
-
encodeSection
-
extractPubSetFromWiki
Returns the set of publication referenced through wiki link in the given text.- Parameters:
text- the text- Returns:
- the set of publication referenced through wiki link in the given text.
- Since:
- jcms-5.5.0
-
extractPubSetFromUrl
Returns the set of publication referenced through URL in the given text.- Parameters:
text- the text- Returns:
- the set of publication referenced through URL in the given text.
- Since:
- jcms-5.5.0
-