Resource WikiRenderContext is used to instruct the Wiki service on
how to render a WikiPage in xhtml or creole markup.
There are four different modes for rendering a WikiPage:
FULL mode: The WikiPage is rendered in its entirety. This includes the resolution
of any page links, and both static and dynamic plugins.
STATIC_ONLY mode: Only the static components of the page are rendered. This includes text
with formatting, absolute links and static plugins, but does not include dynamic links and dynamic plugins.
EDIT_XHTML mode: Renders the WikiPage and all its content in xhtml, in a form appropriate for
editing within a Rich Text Editor. In this render mode, all links are updated to the latest
link paths in case the link target has been moved. Furthermore, inline images are resolved to
DAV urls so they can be displayed inline in the editor. Page plugins are not executed, and are
instead replaced with placeholder elements.
EDIT_CREOLE mode: Renders the WikiPage and all its content in creole markup syntax. All links
are updated to the latest link paths and page plugins, if any, are not executed.
Part of the process of producing xhtml from a Wiki page is rendering links in
the WikiPage to XHTML Hrefs.
That transformation is performed in the following steps:
From the Creole link, get the corresponding Bond.
From the Bond, get the current path to the target Entity (if one exists) and its CollabId.
Check the target Entity type to build an HRef object and produce the rendered link xhtml
Then depending on the artifact type, an Html HRef will be produced
from the artifact path using the appropriate HREFContext information.
For example with a HREFContext like (prefix: "/wiki",
implicit path for the Workspace path: "/Oracle", an implicit base path: "/Wiki/")
a reference to a wiki page with full path /Oracle/MyTeamWorkspace1/Wiki/APage will
produce an HTML link like: /wiki/MyTeamWorkspace1:APage
The CSS class for the generated HTML tags will be fully qualified using the CSS
classes named: 'bki-[tag]'.
The mode in which to render the WikiPage,
either FULL, STATIC_ONLY, EDIT_CREOLE or EDIT_XHTML
Hierarchy
Examples
Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.
