Template:Hbc-hl: Difference between revisions

From KDE Community Wiki
(Replace display title after template renaming)
(Keep examples simple, change their order, fix hbc template name)
Line 4: Line 4:
Block code with header. With highlighted syntax.
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:bc]] for block code without header.
* Use [[Template:ic]] for inline code.
* Use [[Template:ic]] for inline code.
Line 15: Line 15:


== Usage examples ==
== Usage examples ==
Without naming parameters:
<nowiki>Some text
{{hbc-hl|python|script.py|
def quick_sort(arr):
less = []}}
text continues.</nowiki>


With full parameter names:
With full parameter names:
  <nowiki>Some text
  <nowiki>
 
{{hbc-hl|lang=python|head=script.py|code=
{{hbc-hl|lang=python|head=script.py|code=
def quick_sort(arr):
def quick_sort(arr):
less = []}}
less = []}}</nowiki>


text continues.</nowiki>
Without naming parameters:
<nowiki>
{{hbc-hl|python|script.py|
def quick_sort(arr):
less = []}}</nowiki>


== Result ==
== Result ==
Some text


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


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

Revision as of 11:15, 29 September 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.

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 = []

See also

ToDo

Waiting for TemplateStyles extension to be installed: https://bugs.kde.org/show_bug.cgi?id=474964 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.