Parsoid
A bidirectional parser between wikitext and HTML5
Loading...
Searching...
No Matches
Wikimedia\Parsoid\Ext\Pre\Pre Class Reference

The <pre> extension tag shadows the html pre tag, but has different semantics. More...

+ Inheritance diagram for Wikimedia\Parsoid\Ext\Pre\Pre:
+ Collaboration diagram for Wikimedia\Parsoid\Ext\Pre\Pre:

Public Member Functions

 getConfig ()
 Return information about this extension module.FIXME: Add more expected fields or create a class for this FIXME: The 'name' is expected to be the same as the name defined at the top level of extension.json.

Returns
array{name:string}

 
 sourceToDom (ParsoidExtensionAPI $extApi, string $txt, array $extArgs)
 Convert an extension tag's content to DOM.
Parameters
ParsoidExtensionAPI$extApi
string$srcExtension tag content
array$extArgsExtension tag arguments The extension tag arguments should be treated as opaque objects and any necessary inspection should be handled through the API.
Returns
DocumentFragment|false|null DocumentFragment if returning some parsed content false to fallback to the default handler for the content null to drop the instance completely

 
- Public Member Functions inherited from Wikimedia\Parsoid\Ext\ExtensionTagHandler
 processAttributeEmbeddedHTML (ParsoidExtensionAPI $extApi, Element $elt, Closure $proc)
 Extensions might embed HTML in attributes in their own custom representation (whether in data-mw or elsewhere).
 
 lintHandler (ParsoidExtensionAPI $extApi, Element $rootNode, callable $defaultHandler)
 Lint handler for this extension.
 
 domToWikitext (ParsoidExtensionAPI $extApi, Element $node, bool $wrapperUnmodified)
 Serialize a DOM node created by this extension to wikitext.
 
 diffHandler (ParsoidExtensionAPI $extApi, callable $domDiff, Element $origNode, Element $editedNode)
 XXX: Experimental.
 

Detailed Description

The <pre> extension tag shadows the html pre tag, but has different semantics.

It treats anything inside it as plaintext.

Member Function Documentation

◆ getConfig()

Wikimedia\Parsoid\Ext\Pre\Pre::getConfig ( )

Return information about this extension module.FIXME: Add more expected fields or create a class for this FIXME: The 'name' is expected to be the same as the name defined at the top level of extension.json.

Returns
array{name:string}

Implements Wikimedia\Parsoid\Ext\ExtensionModule.

◆ sourceToDom()

Wikimedia\Parsoid\Ext\Pre\Pre::sourceToDom ( ParsoidExtensionAPI $extApi,
string $txt,
array $extArgs )

Convert an extension tag's content to DOM.

Parameters
ParsoidExtensionAPI$extApi
string$srcExtension tag content
array$extArgsExtension tag arguments The extension tag arguments should be treated as opaque objects and any necessary inspection should be handled through the API.
Returns
DocumentFragment|false|null DocumentFragment if returning some parsed content false to fallback to the default handler for the content null to drop the instance completely

Reimplemented from Wikimedia\Parsoid\Ext\ExtensionTagHandler.


The documentation for this class was generated from the following file: