Help:Contributing/code - Revision history

SeedBot: Document code-snippet items (Special:AddCodeSnippet) — semantic snippets reserved for reusable code (known-algorithm implementations); in-page code stays the default (via update-page on MediaWiki MCP Server)

2026-09-04T15:28:46Z

Document code-snippet items (Special:AddCodeSnippet) — semantic snippets reserved for reusable code (known-algorithm implementations); in-page code stays the default (via update-page on MediaWiki MCP Server)

@@ Line 1: / Line 1: @@
-Code appears on this wikibase in two places: as content on wiki pages and as data ([[Special:AddCodeSnippet|code-snippet items]]). This page covers the former.
+Code appears on this wikibase in two forms; this page covers both:
 == Code blocks on wiki pages ==
@@ Line 95: / Line 98: @@
 * '''Every block-mode snippet include <code>copy</code>''': Use <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight>, so readers get a copy button.
 * Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.
 == Editing code-snippet items ==
@@ Line 102: / Line 133: @@
 == See also ==
 * [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki syntax 101] (official)
 * [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight SyntaxHighlight extension] (official)
 * [https://pygments.org/docs/lexers/ Pygments lexers] — full language list
 * [[Help:Contributing]] — contributing to this wiki

SeedBot: Document editing code-snippet items (Special:UpdateCodeSnippet) — AI-assisted (opencode) (via update-page on MediaWiki MCP Server)

2026-09-03T16:33:03Z

Document editing code-snippet items (Special:UpdateCodeSnippet) — AI-assisted (opencode) (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 16:33, 3 September 2026
Line 92:		Line 92:

	* No fenced blocks — <syntaxhighlight lang="text" inline>```</syntaxhighlight> does nothing here. Use <syntaxhighlight lang="text" inline><pre></syntaxhighlight> or <syntaxhighlight lang="text" inline><syntaxhighlight></syntaxhighlight>.		* No fenced blocks — <syntaxhighlight lang="text" inline>```</syntaxhighlight> does nothing here. Use <syntaxhighlight lang="text" inline><pre></syntaxhighlight> or <syntaxhighlight lang="text" inline><syntaxhighlight></syntaxhighlight>.

	~~== Convention for RonzzWikibase ==~~

	* '''Every block-mode snippet include <code>copy</code>''': Use <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight>, so readers get a copy button.		* '''Every block-mode snippet include <code>copy</code>''': Use <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight>, so readers get a copy button.
	* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.		* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.

			== Editing code-snippet items ==

			A stored code-snippet item (created via [[Special:AddCodeSnippet]]) is edited from its item page: click '''Edit content''' under the title, or go to [[Special:UpdateCodeSnippet]] with the item's id (e.g. <code>Special:UpdateCodeSnippet/Q100</code>). The code field shows the stored text exactly as entered (real line breaks); the programming-language picker carries the current value. Fields you leave blank keep their existing values.

	== See also ==		== See also ==

Rongzhou: /* Excellent options for syntaxhighlight */

2026-08-23T10:08:19Z

Excellent options for syntaxhighlight

← Older revision		Revision as of 10:08, 23 August 2026
Line 84:		Line 84:

	<blockquote>		<blockquote>
	* Blocks larger than 100 kB are not highlighted by default.		Blocks larger than 100 kB are not highlighted by default.
	</blockquote>		</blockquote>

Rongzhou: /* Excellent options for syntaxhighlight */

2026-08-23T10:08:01Z

Excellent options for syntaxhighlight

← Older revision		Revision as of 10:08, 23 August 2026
Line 82:		Line 82:

	<blockquote><code>inline</code> and <code>copy</code> are mutually exclusive — <code>copy</code> is for blocks, <code>inline</code> is for inline code.</blockquote>		<blockquote><code>inline</code> and <code>copy</code> are mutually exclusive — <code>copy</code> is for blocks, <code>inline</code> is for inline code.</blockquote>

			<blockquote>
			* Blocks larger than 100 kB are not highlighted by default.
			</blockquote>

	Full parameter reference: [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight#Parameters SyntaxHighlight extension parameters] (official).		Full parameter reference: [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight#Parameters SyntaxHighlight extension parameters] (official).

Rongzhou: /* House rules */

2026-08-23T10:07:16Z

House rules

← Older revision		Revision as of 10:07, 23 August 2026
Line 89:		Line 89:
	* No fenced blocks — <syntaxhighlight lang="text" inline>```</syntaxhighlight> does nothing here. Use <syntaxhighlight lang="text" inline><pre></syntaxhighlight> or <syntaxhighlight lang="text" inline><syntaxhighlight></syntaxhighlight>.		* No fenced blocks — <syntaxhighlight lang="text" inline>```</syntaxhighlight> does nothing here. Use <syntaxhighlight lang="text" inline><pre></syntaxhighlight> or <syntaxhighlight lang="text" inline><syntaxhighlight></syntaxhighlight>.

	== ~~House rules~~ ==		== Convention for RonzzWikibase ==

	* '''Every block-mode snippet ~~must~~ include <code>copy</code>''' ~~— write~~ <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight>, so readers get a copy button~~. Exceptions: <code>inline</code> blocks (<code>copy</code> is ignored there) and literal examples of the tag itself~~.		* '''Every block-mode snippet include <code>copy</code>''': Use <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight>, so readers get a copy button.
	* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.		* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.
	* Blocks larger than 100 kB lose highlighting automatically (a safety guard).
	* Enforcement: <code>tools/add-copy-to-syntaxhighlight.py --audit</code> in the <code>ronzz-wikibase</code> repo flags any block-mode snippet missing <code>copy</code> (exit 0 = conform).

	== See also ==		== See also ==

SeedBot: Standard: every block-mode syntaxhighlight must include copy (house rule); align typed examples (via update-page on MediaWiki MCP Server)

2026-08-23T09:51:07Z

Standard: every block-mode syntaxhighlight must include copy (house rule); align typed examples (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 09:51, 23 August 2026
Line 11:		Line 11:
	\|-		\|-
	\| Highlighted block — Pygments colours and a copy button.		\| Highlighted block — Pygments colours and a copy button.
	\| <pre><syntaxhighlight lang="sparql">SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5</syntaxhighlight></pre>		\| <pre><syntaxhighlight lang="sparql" copy>SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5</syntaxhighlight></pre>
	\| <syntaxhighlight lang="sparql" copy>SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5</syntaxhighlight>		\| <syntaxhighlight lang="sparql" copy>SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5</syntaxhighlight>
	\|-		\|-
Line 42:		Line 42:

	== Excellent options for <code>syntaxhighlight</code> ==		== Excellent options for <code>syntaxhighlight</code> ==

			Every block-mode snippet carries <code>copy</code> (see the [[#House rules\|house rules]]); the options below combine with it.

	{\| class="wikitable" style="width:100%"		{\| class="wikitable" style="width:100%"
Line 47:		Line 49:
	\|-		\|-
	\| <code>line</code> — show line numbers		\| <code>line</code> — show line numbers
	\| <pre><syntaxhighlight lang="sparql" line>SELECT ?item WHERE {		\| <pre><syntaxhighlight lang="sparql" line copy>SELECT ?item WHERE {
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight></pre>		}</syntaxhighlight></pre>
Line 55:		Line 57:
	\|-		\|-
	\| <code>start="5"</code> — first line number (with <code>line</code>)		\| <code>start="5"</code> — first line number (with <code>line</code>)
	\| <pre><syntaxhighlight lang="sparql" line start="5">SELECT ?item WHERE {		\| <pre><syntaxhighlight lang="sparql" line start="5" copy>SELECT ?item WHERE {
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight></pre>		}</syntaxhighlight></pre>
Line 63:		Line 65:
	\|-		\|-
	\| <code>highlight="1,3"</code> — highlight specific lines (comma-separated)		\| <code>highlight="1,3"</code> — highlight specific lines (comma-separated)
	\| <pre><syntaxhighlight lang="sparql" highlight="1,3">SELECT ?item WHERE {		\| <pre><syntaxhighlight lang="sparql" highlight="1,3" copy>SELECT ?item WHERE {
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight></pre>		}</syntaxhighlight></pre>
Line 79:		Line 81:
	\|}		\|}

	<blockquote><code>inline</code> and <code>copy</code> are mutually exclusive.</blockquote>		<blockquote><code>inline</code> and <code>copy</code> are mutually exclusive — <code>copy</code> is for blocks, <code>inline</code> is for inline code.</blockquote>

	Full parameter reference: [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight#Parameters SyntaxHighlight extension parameters] (official).		Full parameter reference: [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight#Parameters SyntaxHighlight extension parameters] (official).
Line 89:		Line 91:
	== House rules ==		== House rules ==

	* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" ~~copy~~></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.		* '''Every block-mode snippet must include <code>copy</code>''' — write <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight>, so readers get a copy button. Exceptions: <code>inline</code> blocks (<code>copy</code> is ignored there) and literal examples of the tag itself.
			* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.
	* Blocks larger than 100 kB lose highlighting automatically (a safety guard).		* Blocks larger than 100 kB lose highlighting automatically (a safety guard).
			* Enforcement: <code>tools/add-copy-to-syntaxhighlight.py --audit</code> in the <code>ronzz-wikibase</code> repo flags any block-mode snippet missing <code>copy</code> (exit 0 = conform).

	== See also ==		== See also ==

SeedBot: Standardize: add copy button to block code snippets

2026-08-23T09:46:16Z

Standardize: add copy button to block code snippets

← Older revision		Revision as of 09:46, 23 August 2026
Line 7:		Line 7:
	\|-		\|-
	\| Plain block — exactly as typed, no wiki markup, HTML escaped. Safe for logs and config pastes.		\| Plain block — exactly as typed, no wiki markup, HTML escaped. Safe for logs and config pastes.
	\| <syntaxhighlight lang="wikitext"><pre>[2026-08-19 14:32:01] wikibase.updater: entity Q42 updated</pre></syntaxhighlight>		\| <syntaxhighlight lang="wikitext" copy><pre>[2026-08-19 14:32:01] wikibase.updater: entity Q42 updated</pre></syntaxhighlight>
	\| <pre>[2026-08-19 14:32:01] wikibase.updater: entity Q42 updated</pre>		\| <pre>[2026-08-19 14:32:01] wikibase.updater: entity Q42 updated</pre>
	\|-		\|-
Line 50:		Line 50:
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight></pre>		}</syntaxhighlight></pre>
	\| <syntaxhighlight lang="sparql" line>SELECT ?item WHERE {		\| <syntaxhighlight lang="sparql" line copy>SELECT ?item WHERE {
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight>		}</syntaxhighlight>
Line 58:		Line 58:
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight></pre>		}</syntaxhighlight></pre>
	\| <syntaxhighlight lang="sparql" line start="5">SELECT ?item WHERE {		\| <syntaxhighlight lang="sparql" line start="5" copy>SELECT ?item WHERE {
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight>		}</syntaxhighlight>
Line 66:		Line 66:
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight></pre>		}</syntaxhighlight></pre>
	\| <syntaxhighlight lang="sparql" highlight="1,3">SELECT ?item WHERE {		\| <syntaxhighlight lang="sparql" highlight="1,3" copy>SELECT ?item WHERE {
	?item wdt:P1 wd:Q6 .		?item wdt:P1 wd:Q6 .
	}</syntaxhighlight>		}</syntaxhighlight>
Line 89:		Line 89:
	== House rules ==		== House rules ==

	* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…"></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.		* Prefer <syntaxhighlight lang="text" inline><syntaxhighlight lang="…" copy></syntaxhighlight> for anything syntax-highlightable; <syntaxhighlight lang="text" inline><pre></syntaxhighlight> for config dumps and logs where colours add noise.
	* Blocks larger than 100 kB lose highlighting automatically (a safety guard).		* Blocks larger than 100 kB lose highlighting automatically (a safety guard).

Rongzhou: /* Excellent options for highlighted blocks */

2026-08-19T17:21:42Z

Excellent options for highlighted blocks

← Older revision		Revision as of 17:21, 19 August 2026
Line 41:		Line 41:
	* Full list: [https://pygments.org/docs/lexers/ Pygments lexers] (use the alias column)		* Full list: [https://pygments.org/docs/lexers/ Pygments lexers] (use the alias column)

	== Excellent options for ~~highlighted blocks~~ ==		== Excellent options for <code>syntaxhighlight</code> ==

	{\| class="wikitable" style="width:100%"		{\| class="wikitable" style="width:100%"

Rongzhou: /* Options for highlighted blocks */

2026-08-19T17:20:28Z

Options for highlighted blocks

← Older revision		Revision as of 17:20, 19 August 2026
Line 41:		Line 41:
	* Full list: [https://pygments.org/docs/lexers/ Pygments lexers] (use the alias column)		* Full list: [https://pygments.org/docs/lexers/ Pygments lexers] (use the alias column)

	== ~~Options~~ for highlighted blocks ==		== Excellent options for highlighted blocks ==

	{\| class="wikitable" style="width:100%"		{\| class="wikitable" style="width:100%"

Rongzhou: /* Which languages can be highlighted */

2026-08-19T17:20:04Z

Which languages can be highlighted

← Older revision		Revision as of 17:20, 19 August 2026
Line 33:		Line 33:
	</blockquote>		</blockquote>

	== ~~Which~~ languages can be highlighted ==		== Most languages can be highlighted ==

	Any Pygments lexer alias works as the <code>lang</code> attribute — use the lowercase canonical name:		Any Pygments lexer alias works as the <code>lang</code> attribute — use the lowercase canonical name: