mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
synced 2024-11-23 14:07:01 +00:00
006e6c6f0f
Make the wrapper div for code block create a block formatting context. This changes how floated content is laid out: previously the wrapper was taking 100% width and tried to wrap text around the floated content, now its width is limited by the width of floated content. This way absolutely positioned elements inside the code block (like the copy buttons) won't overlap the floated content. We've had this problem before when adding line numbers (T272853), and the workaround we used there won't work for the copy buttons. It also lets us remove the background-color override, previously needed to avoid it leaking outside the code block (T126010). Bug: T40932 Change-Id: I7f51ea78d7fcf07358c6ee45275b2bae2e1cbeb8 |
||
|---|---|---|
| .phan | ||
| i18n | ||
| includes | ||
| maintenance | ||
| modules | ||
| pygments | ||
| tests | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitreview | ||
| .phpcs.xml | ||
| .stylelintrc.json | ||
| CODE_OF_CONDUCT.md | ||
| composer.json | ||
| COPYING | ||
| extension.json | ||
| Gruntfile.js | ||
| package-lock.json | ||
| package.json | ||
| README | ||
| SyntaxHighlight.lexers.php | ||
This extension allows source code to be syntax highlighted on the wiki pages.
This README file might be out of date, have a look at the extension page
for updated information:
https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi
== Requirements ==
This version of the extension has been tested with Pygments 2.11.2 and
MediaWiki 1.36. To get releases of this extension compatible
with earlier versions of MediaWiki, visit:
https://www.mediawiki.org/wiki/Special:ExtensionDistributor/SyntaxHighlight_GeSHi
== Installation ==
Add this line to your LocalSettings.php:
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
By default, this extension will use a bundled copy of Pygments 2.11.2. If you
would like to use a different copy of the library, you can set
$wgPygmentizePath to point to the path to the 'pygmentize' binary.
== Usage ==
On the wiki page, you can now use "source" elements:
<source lang="php">
<?php
v = "string"; // sample initialization
?>
html text
<?php
echo v; // end of php code
?>
</source>
== Parameters ==
For details information of these parameters, see the documentation of Pygments'
HtmlFormatter at <https://pygments.org/docs/formatters/#HtmlFormatter>.
* lang; Defines the language.
* line; Corresponds to linenos="inline" option.
* start; Corresponds to linenostart option.
* enclose; If set to "none", corresponds to the nowrap=1 option.
* inline; Corresponds to the nowrap=1 option.
* highlight; Corresponds to hl_lines option (comma separated).
* linelinks; Lines will have links and anchors with a prefix of the value.
Similar to the lineanchors+linespans features in Pygments
== Note ==
Pygments is generous about creating HTML elements: highlighting large blocks of
code can easily generate enough of them to crash a browser. As a guard, syntax
highlighting is turned off for code fragments larger than 100 kB.