feat: add initial Parsoid support for the tabber tag

This commit is contained in:
alistair3149 2022-04-20 17:21:49 -04:00 committed by GitHub
parent 558581c893
commit 3220bb8ef4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 106 additions and 1 deletions

View file

@ -87,5 +87,6 @@
"class": "TabberNeue\\Hooks"
}
},
"ParsoidModules": [ "TabberNeue\\Hooks" ],
"manifest_version": 2
}

View file

@ -6,8 +6,9 @@ namespace TabberNeue;
use MediaWiki\Hook\ParserFirstCallInitHook;
use Parser;
use Wikimedia\Parsoid\Ext\ExtensionModule;
class Hooks implements ParserFirstCallInitHook {
class Hooks implements ExtensionModule, ParserFirstCallInitHook {
/**
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ParserFirstCallInit
*
@ -17,4 +18,21 @@ class Hooks implements ParserFirstCallInitHook {
$parser->setHook( 'tabber', Tabber::class . '::parserHook' );
$parser->setHook( 'tabbertransclude', TabberTransclude::class . '::parserHook' );
}
/**
* Return information about this Parsoid extension module
*
* @return array
*/
public function getConfig(): array {
return [
'name' => 'TabberNeue',
'tags' => [
[
'name' => 'tabber',
'handler' => TabberParsoid::class
]
]
];
}
}

View file

@ -0,0 +1,86 @@
<?php
/**
* TabberNeue
* TabberParsoid Class
* Implement <tabber> tag in Parsoid
*
* @package TabberNeue
* @author alistair3149, Eric Fortin, Alexia E. Smith, Ciencia Al Poder
* @license GPL-3.0-or-later
* @link https://www.mediawiki.org/wiki/Extension:TabberNeue
*/
declare( strict_types=1 );
namespace TabberNeue;
use Wikimedia\Parsoid\Ext\ExtensionTagHandler;
use Wikimedia\Parsoid\Ext\ParsoidExtensionAPI;
class TabberParsoid extends ExtensionTagHandler {
/** @inheritDoc */
public function sourceToDom( ParsoidExtensionAPI $extApi, string $src, array $extArgs ) {
$extApi->addModuleStyles( [ 'ext.tabberNeue' ] );
$html = self::render( $extApi, $src );
return $extApi->htmlToDom( $html );
}
/**
* Renders the necessary HTML for a <tabber> tag.
*
* @param PParsoidExtensionAPI $extApi
* @param string $src The input URL between the beginning and ending tags.
*
* @return string HTML
*/
public static function render( ParsoidExtensionAPI $extApi, string $src ) {
$arr = explode( "|-|", $src );
$htmlTabs = '';
foreach ( $arr as $tab ) {
$htmlTabs .= self::buildTab( $extApi, $tab );
}
$html = '<div class="tabber">' .
'<section class="tabber__section">' . $htmlTabs . "</section></div>";
return $html;
}
/**
* Build individual tab.
*
* @param PParsoidExtensionAPI $extApi
* @param string $tab Tab information
*
* @return string HTML
*/
private static function buildTab( ParsoidExtensionAPI $extApi, string $tab ) {
$tab = trim( $tab );
if ( empty( $tab ) ) {
return $tab;
}
// Use array_pad to make sure at least 2 array values are always returned
list( $tabName, $tabBody ) = array_pad( array_map( 'trim', explode( '=', $tab, 2 ) ), 2, '' );
// $tabBody = $extApi->wikitextToDOM( $tabBody );
$tabBody = $extApi->domToHTML(
$extApi->wikitextToDOM(
$tabBody,
[
'parseOpts' => [
'extTag' => 'tabber',
'context' => 'inline',
]
],
true // sol
)
);
$tab = '<article class="tabber__panel" title="' . htmlspecialchars( $tabName ) .
'">' . $tabBody . '</article>';
return $tab;
}
}