Template:Hbc-hl: Difference between revisions

Latest revision as of 21:40, 21 October 2023

This page is a template, editing it will affect all the pages that make use of it, so users should be especially careful when editing it. For more details on how to use templates see "A Quick Guide to Templates"

Block code with header. With highlighted syntax.

Use Template:hbc for block code with header without highlighted syntax.
Use Template:bc for block code without header.
Use Template:ic for inline code.

Parameters

1 or lang: the language of code block
2 or head: the code in the top pane
3 or code: the code in the bottom pane

Usage examples

With full parameter names:

{{hbc-hl|lang=python|head=script.py|code=
def quick_sort(arr):
	less = []}}

Without naming parameters:

{{hbc-hl|python|script.py|
def quick_sort(arr):
	less = []}}

Result

script.py

def quick_sort(arr):
	less = []

@@ Line 1: / Line 1: @@
-<!--templatestyles src="Template:Hc-hl/styles.css" /--><noinclude>{{DISPLAYTITLE:Template:hc-hl}}
+<templatestyles src="Template:Hbc-hl/styles.css" /><noinclude>{{DISPLAYTITLE:Template:hbc-hl}}
 {{Template}}
 Block code with header. With highlighted syntax.
-* Use [[Template:hc]] for block code with header without highlighted syntax.
+* Use [[Template:hbc]] for block code with header without highlighted syntax.
 * Use [[Template:bc]] for block code without header.
 * Use [[Template:ic]] for inline code.
-== Usage ==
+== Parameters ==
-* {{ic|1}} or {{ic|lang}}: the language of code block, to apply highlighting
+* {{ic|1}} or {{ic|lang}}: the language of code block
 * {{ic|2}} or {{ic|head}}: the code in the top pane
-* {{ic|3}} or {{ic|output}}: the code in the bottom pane
+* {{ic|3}} or {{ic|code}}: the code in the bottom pane
-  <nowiki>{{hc-hl|lang=python|script.py|
+== Usage examples ==
+With full parameter names:
+  <nowiki>
+{{hbc-hl|lang=python|head=script.py|code=
 def quick_sort(arr):
 	less = []}}</nowiki>
-  <nowiki>{{hc-hl|python|head=script.py|output=output=
+Without naming parameters:
+  <nowiki>
+{{hbc-hl|python|script.py|
 def quick_sort(arr):
 	less = []}}</nowiki>
-See [https://pygments.org/languages/ here] for supported values for {{ic|lang}}.
+== Result ==
-== Example ==
-{{hc-hl|lang=python|head=script.py|output=def quick_sort(arr):
+{{hbc-hl|lang=python|head=script.py|code=def quick_sort(arr):
 	less = []}}
-== ToDo ==
+== See also ==
-Waiting for TemplateStyles extension to be installed: https://bugs.kde.org/show_bug.cgi?id=474964
+* [https://pygments.org/languages/ List of supported values for {{ic|lang}} parameter].
-After that, switch the content model of [[Template:Hc-hl/styles.css]] to ''Sanitized CSS''.
-Uncomment templatestyles tag. (It was commented, so it is not shown literally until the extension setup is done).
-After that, template should work normally.
-</noinclude><includeonly>{{#tag:pre|{{{head|{{{2|{{META Error}}}}}}}}|style="margin-bottom: 0; border-bottom:none; padding-bottom:0.8em;"}}<!-- The line break is needed, otherwise the wiki will generate extraneous paragraphs inside the 2nd pre block -->
+</noinclude><includeonly>{{#tag:pre|{{{head|{{{2|{{META Error}}}}}}}}|style="margin-bottom: 0; border-bottom:none; padding-bottom:0.8em;"}}
 {{#tag:syntaxhighlight|
-{{{output|{{{3|{{META Error}}}}}}}}
+{{{code|{{{3|{{META Error}}}}}}}}
 |lang="{{{lang|{{{1|{{META Error}}}}}}}}"|style="margin-bottom: 0; border-bottom:none; padding-bottom:0.8em;"}}</includeonly>