The Caboteria / TWiki Web / TWikiRenderDotPm (29 May 2010, TWikiContributor)

Package TWiki::Render

This module provides most of the actual HTML rendering code in TWiki.

On this page:

ClassMethod new ($session)

Creates a new renderer

ObjectMethod finish ()

Break circular references.

ObjectMethod renderParent ($web,$topic,$meta,$params) -> $text

Render parent meta-data

ObjectMethod renderMoved ($web,$topic,$meta,$params) -> $text

Render moved meta-data

ObjectMethod makeAnchorName ($anchorName,$compatibilityMode) -> $anchorName

Build a valid HTML anchor name

ObjectMethod makeUniqueAnchorName ($web,$topic,$anchorName,$compatibility) -> $anchorName

Build a valid HTML anchor name (unique w.r.t. the list stored in %anchornames)

ObjectMethod internalLink ($theWeb,$theTopic,$theLinkText,$theAnchor,$doLink,$doKeepWeb,$hasExplicitLinkLabel) -> $html

Generate a link.

Note: Topic names may be spaced out. Spaced out names are converted to WikWords, for example, "spaced topic name" points to "SpacedTopicName".

Called by _handleWikiWord and _handleSquareBracketedLink and by Func::internalLink

Calls _renderWikiWord, which in turn will use Plurals.pm to match fold plurals to equivalency with their singular form

SMELL: why is this available to Func?

ObjectMethod renderFORMFIELD (%params,$topic,$web) -> $html

Returns the fully rendered expansion of a tag.

ObjectMethod getRenderedVersion ($text,$theWeb,$theTopic) -> $html

The main rendering function.

StaticMethod verbatimCallBack

Callback for use with putBackBlocks that replaces < and > by their HTML entities &lt; and &gt;

ObjectMethod TML2PlainText ($text,$web,$topic,$opts) -> $plainText

Clean up TWiki text for display as plain text without pushing it through the full rendering pipeline. Intended for generation of topic and change summaries. Adds nop tags to prevent TWiki subsequent rendering; nops get removed at the very end.

Defuses TML.

$opts:

ObjectMethod protectPlainText ($text) -> $tml

Protect plain text from expansions that would normally be done duing rendering, such as wikiwords. Topic summaries, for example, have to be protected this way.

ObjectMethod makeTopicSummary ($theText,$theTopic,$theWeb,$theFlags) -> $tml

Makes a plain text summary of the given topic by simply trimming a bit off the top. Truncates to $TMTRUNC chars or, if a number is specified in $theFlags, to that length.

ObjectMethod takeOutBlocks (\$text,$tag,\%map) -> $text

Return value: $text with blocks removed

Searches through $text and extracts blocks delimited by a tag, appending each onto the end of the @buffer and replacing with a token string which is not affected by TWiki rendering. The text after these substitutions is returned.

Parameters to the open tag are recorded.

This is different to takeOutProtected, because it requires tags to be on their own line. it also supports a callback for post- processing the data before re-insertion.

ObjectMethod putBackBlocks (\$text,\%map,$tag,$newtag,$callBack) -> $text

Return value: $text with blocks added back

Reverses the actions of takeOutBlocks.

Each replaced block is processed by the callback (if there is one) before re-insertion.

Parameters to the outermost cut block are replaced into the open tag, even if that tag is changed. This allows things like <verbatim class=''> to be mapped to <pre class=''>

Cool, eh what? Jolly good show.

And if you set $newtag to '', we replace the taken out block with the valuse itself

Edit | Attach | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | Raw edit | More topic actions
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding The Caboteria? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiRenderDotPm.