Help:Contributing/code: Difference between revisions

From Wikibase
Jump to navigation Jump to search
← Older editNewer edit →

Rongzhou (talk | contribs)

4 user groups
1,058 edits
Standard: every block-mode syntaxhighlight must include copy (house rule); align typed examples (via update-page on MediaWiki MCP Server)
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 ==

Revision as of 10:07, 23 August 2026

Languages: English · français · Esperanto

Code appears on this wikibase in two places: as content on wiki pages and as data (code-snippet items). This page covers the former.

Code blocks on wiki pages

What you want What you type What you get
Plain block — exactly as typed, no wiki markup, HTML escaped. Safe for logs and config pastes. 
<pre>[2026-08-19 14:32:01] wikibase.updater: entity Q42 updated</pre>

[2026-08-19 14:32:01] wikibase.updater: entity Q42 updated
Highlighted block — Pygments colours and a copy button. 
<syntaxhighlight lang="sparql" copy>SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5</syntaxhighlight>
 
SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5
Plain inline code — monospace in a sentence, no colours. For short tokens with no markup-significant characters. <code>latestId</code> latestId
For highlighted inline code — monospace in a sentence, with colours. 
<syntaxhighlight lang="python" inline>print("hello")</syntaxhighlight>
 print("hello")

Anything inside <syntaxhighlight> or <pre> is rendered literally — wiki markup and HTML are not interpreted.

Don't wrap Wikimarkup content inside code tags — it will not be parsed. A link or template in a code tag renders as plain text: [[Special:AddCodeSnippet]] shows [[Special:AddCodeSnippet]], not a link. Write it as normal wikitext to get the link: code-snippet items.

Be careful with <code>: it does not escape HTML — text such as <, > or & inside it is read as markup. Use it for short plain tokens without those characters (#, quarto render, latestId); it is lighter to render. Use <syntaxhighlight lang="…" inline> when the snippet contains <, > or & (it escapes content) or when you want colours. Never use <code> for blocks — <pre> or <syntaxhighlight> instead.

Most languages can be highlighted

Any Pygments lexer alias works as the lang attribute — use the lowercase canonical name:

  • sparql — SPARQL queries (this wiki's query service)
  • python, javascript, bash, sql, json, wikitext — commonly used
  • Full list: Pygments lexers (use the alias column)

Excellent options for syntaxhighlight

Every block-mode snippet carries copy (see the house rules); the options below combine with it.

Option You type You get
line — show line numbers 
<syntaxhighlight lang="sparql" line copy>SELECT ?item WHERE {
?item wdt:P1 wd:Q6 .
}</syntaxhighlight>
 
SELECT ?item WHERE {
?item wdt:P1 wd:Q6 .
}
start="5" — first line number (with line) 
<syntaxhighlight lang="sparql" line start="5" copy>SELECT ?item WHERE {
?item wdt:P1 wd:Q6 .
}</syntaxhighlight>
 
SELECT ?item WHERE {
?item wdt:P1 wd:Q6 .
}
highlight="1,3" — highlight specific lines (comma-separated) 
<syntaxhighlight lang="sparql" highlight="1,3" copy>SELECT ?item WHERE {
?item wdt:P1 wd:Q6 .
}</syntaxhighlight>
 
SELECT ?item WHERE {
?item wdt:P1 wd:Q6 .
}
inline — render as inline code instead of a block 
<syntaxhighlight lang="sparql" inline>LIMIT</syntaxhighlight>
 LIMIT
copy — add a button that copies the block 
<syntaxhighlight lang="sparql" copy>SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5</syntaxhighlight>
 
SELECT ?item WHERE { ?item wdt:P1 wd:Q6 } LIMIT 5

inline and copy are mutually exclusive — copy is for blocks, inline is for inline code.

Full parameter reference: SyntaxHighlight extension parameters (official).

Differences from Markdown

  • No fenced blocks — ``` does nothing here. Use <pre> or <syntaxhighlight>.

Convention for RonzzWikibase

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

See also

Retrieved from "https://wikibase.ronzz.org/index.php?title=Help:Contributing/code&oldid=1551"