wikimedia/mediawiki-extensions-Scribunto
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Scribunto synced 2024-11-27 17:50:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

ScribuntoContentHandler: Remove redundant Title::getPageViewLanguage use

Browse source 
When OutputPage/Skin call ParserOutput->getText(), this already takes
care of the appropriate attributes. This redundancy is non-obvious
however, because in this code $parserOutput is re-purposed in an odd
way that makes it seem like it has to mark its own language, so as to
separate it from the appended portions for validation error and
syntax highlighted code.

However, at least the way the code has been in recent years, this
has always been a redundant wrapper since OutputPage/Skin already
set the same attributes on the resulting container. With T341244
closed, this is more obvious now that it is located in
ParserOutput::getText, but even before I worked on T341244, the Skin
will have already been doing the same thing as this code was doing,
setting the same redundant attributes.

Bug: T350806
Change-Id: Idb8471eec5d5ac39b7a347c70f3a618eba18a57b
This commit is contained in:
Timo Tijhof 2023-11-14 22:24:03 +00:00 committed by jenkins-bot
parent 61874ca30e
commit 09f92105ed
1 changed files with 27 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
includes/ScribuntoContentHandler.php
View file

@ -132,41 +132,36 @@ class ScribuntoContentHandler extends CodeContentHandler {
// - docs (if any)
// - validation error (if any)
// - highlighted source code
$parserOutput = new ParserOutput();
$html = '';
if ( $docMsg ) {
if ( !$docMsg->isDisabled() ) {
// In order to allow the doc page to categorize the Module page,
// we need access to the ParserOutput of the doc page.
// This is why we can't simply use $docMsg->parse().
$docViewLang = $docTitle->getPageViewLanguage();
$dir = $docViewLang->getDir();
// Code is forced to be ltr, but the documentation can be rtl.
// Correct direction class is needed for correct formatting.
// The possible classes are
// mw-content-ltr or mw-content-rtl
$dirClass = "mw-content-$dir";
$docWikitext = Html::rawElement(
'div',
[
'lang' => $docViewLang->getHtmlCode(),
'dir' => $dir,
'class' => $dirClass,
],
// Line breaks are needed so that wikitext would be
// appropriately isolated for correct parsing. See Bug 60664.
"\n" . $docMsg->plain() . "\n"
);
if ( $parserOptions->getTargetLanguage() === null ) {
$parserOptions->setTargetLanguage( $docTitle->getPageLanguage() );
}
$parserOutput = $parser->parse( $docWikitext, $page, $parserOptions, true, true, $revId );
$html .= $parserOutput->getRawText();
if ( $docMsg && !$docMsg->isDisabled() ) {
// In order to allow the doc page to categorize the Module page,
// we need access to the ParserOutput of the doc page.
// This is why we can't simply use $docMsg->parse().
//
// We also can't use use ParserOutput::getText and ParserOutput::collectMetadata
// to merge the result into $parserOutput, because doing so would remove the
// ability for Skin/OutputPage to (post-cache) decide on the ParserOutput::getText
// parameters edit section links, TOC, and user language etc.
//
// So instead, this uses the doc page's ParserOutput as the actual ParserOutput
// we return, and add the other stuff to it. This is the only way to leave
// skin-decisions undecided and in-tact.
if ( $parserOptions->getTargetLanguage() === null ) {
$parserOptions->setTargetLanguage( $docTitle->getPageLanguage() );
}
$parserOutput = $parser->parse( $docMsg->plain(), $page, $parserOptions, true, true, $revId );
// Code is displayed and syntax highlighted as LTR, but the
// documentation can be RTL on RTL-language wikis.
//
// As long as we leave the $parserOutput in-tact, it will preserve the appropiate
// lang, dir, and class attributes (mw-content-ltr or mw-content-rtl) as needed
// for correct styling and accessiblity of the documentation page content.
// These will be applied when OutputPage eventually calls ParserOutput::getText()
$html .= $parserOutput->getRawText();
} else {
$parserOutput = new ParserOutput();
}
if ( $docTitle ) {