Template:Syntax highlight/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(the note being the whole width seems off)
No edit summary
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}


This template applies CSS to text to signify it is a certain category, such as a comment, type, string, etc. the CSS here is taken from how <nowiki><source></nowiki> renders code, with the exception of functions, to contrast against a dark background more. If the {{param|code}} parameter is set to 1, it will be embedded into a {{tl|link=code}} template.
This template applies CSS to text to signify it is a certain category, such as a comment, type, string, etc. the CSS here is taken from how <nowiki><syntaxhighlight></nowiki> renders code.




Line 7: Line 7:
{{Code|<nowiki>{{Syntax highlight|category|text}}</nowiki>}}
{{Code|<nowiki>{{Syntax highlight|category|text}}</nowiki>}}


{{Code|<nowiki>{{Syntax highlight|category|text|code=1}}</nowiki>}}


 
{| class="standard-table" style="margin-bottom:0px;"
<div style="width:fit-content;">
|+ <!--Currently -->Supported Categories
{| class="standard-table"
|+ Currently Supported Categories
! Uses
! Uses
! Example
! Example
Line 39: Line 36:
|-  
|-  
|}
|}
{{note|{{tl|stx}} accepts the {{param|code}} parameter as well.}}
</div>

Latest revision as of 13:41, 23 June 2024

Edit-copy.png
This is a documentation subpage for Template:Syntax highlight.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

This template applies CSS to text to signify it is a certain category, such as a comment, type, string, etc. the CSS here is taken from how <syntaxhighlight> renders code.


Usage

{{Syntax highlight|category|text}}


Supported Categories
Uses Example Shortcuts Preview
Character/String {{syntax highlight|character|'x'}}
{{syntax highlight|string|"Hello, World!"}}
{{stx|char|'x'}}
{{stx|str|"Hello, World!"}}
'x'
Comment {{syntax highlight|comment|//comment}} {{stx|comm|//comment}} //comment
Control {{syntax highlight|control|if}} {{stx|ctrl|if}} if
Function {{syntax highlight|function|main}} {{stx|func|main}} main
Label {{syntax highlight|label|final}} {{stx|lbl|final}} final
Macro {{syntax highlight|macro|#define}} {{stx|mac|#define}} #define
Number/Operator {{syntax highlight|number|3.0f}}
{{syntax highlight|operator|+}}
{{stx|no|3.0f}}
{{stx|op|+}}
3.0f
Register {{syntax highlight|register|%rax}} {{stx|reg|%rax}} %rax
Regular Expression {{syntax highlight|regular expression|/a*b+/}} {{stx|regex|/a*b+/}} /a*b+/
Type {{syntax highlight|type|unsigned int}} {{stx|type|unsigned int}} unsigned int