SQF Highlighter – Extension

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add options documentation)
m (Some wiki formatting)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{| class="wikitable" style="float: right; margin: 0 0 0.5em 1.5em"
{| class="wikitable float-right"
! colspan="2" style="padding: 1.5em" | SQF Highlighter
! colspan="2" style="padding: 1.5em" | SQF Highlighter
|-
|-
Line 8: Line 8:
| {{User|Lou Montana}}
| {{User|Lou Montana}}
|-
|-
! Version
! Project Start
| 0.85b
| 2022-03-08: Project start
|-
|-
! Release Date
! Release Date
Line 15: Line 15:
* 2022-03-12: "v1" (0.50b), first upload
* 2022-03-12: "v1" (0.50b), first upload
* 2022-07-11: "v2" (0.85b), new parser
* 2022-07-11: "v2" (0.85b), new parser
* 2023-11-02: 0.9b, allow some wiki formatting in comments
|-
|-
! Project Start
! Version
| 2022-03-08: Project start
| 0.9b
|}
|}
This extension highlights and automatically links [[SQF Syntax|SQF]] commands and functions. It also covers [[SQS Syntax|SQS]] (free of charge).
This extension highlights and automatically links [[SQF Syntax|SQF]] commands and functions. It also covers [[SQS Syntax|SQS]] (free of charge).




{{TOC}}
{{Clear}}
== Features ==
== Features ==


Line 27: Line 32:
* [[SQS Syntax]] support
* [[SQS Syntax]] support
* "Copy code to clipboard" button on hover
* "Copy code to clipboard" button on hover
* Partial wiki formatting in comments: {{hl|<nowiki>''italic''</nowiki>}}, {{hl|<nowiki>'''bold'''</nowiki>}}, {{hl|<nowiki><s>striked</s></nowiki>}}, {{hl|<nowiki><u>underlined</u></nowiki>}}, {{hl|<nowiki>[[links|even styled ones]]</nowiki>}}, {{hl|<nowiki>{{templates}}</nowiki>}}
* {{hl|#define}}d constant value on mouse hover
* {{hl|#define}}d constant value on mouse hover
* SQF tag button in the wiki edit toolbar (next to '''B''' and '''''I''''')
* Options:
* Options:
** {{hl|inline}} for inline code
** {{hl|inline}} for inline code
** {{hl|notrim}} to remove the auto trim (lines themselves will always be rtrimmed)
** {{hl|notrim}} to remove the auto trim (lines themselves will always be rtrimmed)
* Categorises wrong code pages in [[:Category:Pages with SQF errors]] and [[:Category:Pages with SQS errors]]




Line 37: Line 45:
* Unzip the directory to {{hl|wiki/extensions/SQFHighlighter}}
* Unzip the directory to {{hl|wiki/extensions/SQFHighlighter}}
* Add <syntaxhighlight lang="php" inline>wfLoadExtension( 'SQFHighlighter' );</syntaxhighlight> to {{hl|LocalSettings.php}}
* Add <syntaxhighlight lang="php" inline>wfLoadExtension( 'SQFHighlighter' );</syntaxhighlight> to {{hl|LocalSettings.php}}
* There are no settings - the extension creates full path links unless the host is one of the following (then relative links are created):
* there is a {{hl|case-sensitive}} setting in {{hl|extension.json}} (default true). Set to false to highlight improperly-cased commands and functions (e.g [[setDammage|setDaMMage]] instead of [[setDammage]], etc)
* The extension creates full path links unless the host is one of the following (then relative links are created):
** {{hl|community.bistudio.com}}
** {{hl|community.bistudio.com}}
** {{hl|community.bohemia.net}}
** {{hl|community.bohemia.net}}
Line 44: Line 53:
== Usage ==
== Usage ==


Using <nowiki><sqf></nowiki> tags will auto-generate syntax highlighting '''and''' links to the pages.
Using <syntaxhighlight lang="html" inline><sqf></syntaxhighlight> tags will auto-generate syntax highlighting '''and''' links to the pages.


{| class="wikitable valign-top" style="min-width: 50em"
{| class="wikitable valign-top" style="min-width: 50em"
Line 104: Line 113:


/*
/*
wait for resurrection
wait for resurrection - see {{Link|Arma 3: Respawn}}
*/
*/
waitUntil { alive player && { preloadCamera getPosATL player } };
waitUntil { alive player && { preloadCamera getPosATL player } };
Line 127: Line 136:


/*
/*
wait for resurrection
wait for resurrection - see {{Link|Arma 3: Respawn}}
*/
*/
waitUntil { alive player && { preloadCamera getPosATL player } };
waitUntil { alive player && { preloadCamera getPosATL player } };
Line 175: Line 184:
#loop
#loop
@ alive player
@ alive player
; you ok
; you ok - see [[getDammage]] too
hint "OK"
hint "OK"
~1
~1
Line 187: Line 196:
#loop
#loop
@ alive player
@ alive player
; you ok
; you ok - see [[getDammage]] too
hint "OK"
hint "OK"
~1
~1
Line 201: Line 210:
== CSS Classes ==
== CSS Classes ==


All elements are {{hl|'''<nowiki><span></nowiki>'''}} but the parent block that is a {{hl|'''<nowiki><div></nowiki>'''}}.
All elements are <syntaxhighlight lang="html" inline><span></syntaxhighlight> except for some exceptions:
* unless using <syntaxhighlight lang="html" inline><sqf inline></syntaxhighlight>, the parent block is a <syntaxhighlight lang="html" inline><div></syntaxhighlight> holding another one for scrolling purpose; otherwise, is is a <syntaxhighlight lang="html" inline><span></syntaxhighlight> as well.
 
{| class="wikitable"
{| class="wikitable"
! Element
! Element
Line 208: Line 219:
|-
|-
| parent block
| parent block
| sqfhighlighter-'''block'''
| sqfhighlighter-'''block'''<br>contains sqfhighlighter-'''scroller''' for blocks
| <sqf>&nbsp;</sqf>
| <sqf>;</sqf>
|-
|-
| error message
| error message
| sqfhighlighter-'''error'''
| sqfhighlighter-'''error'''
| <sqf></sqf><br><sqs></sqs>
| <sqf></sqf><br><sqs></sqs>
|-
| wild character / bad variable / unclosed string
| bv, bvl
| <sqf>
@
private _var = 3RndMag;
hint "hello
</sqf>
|-
|-
| comment
| comment
| sqfhighlighter-'''comment'''
| cc
| <sqf>// comment
| <sqf>
// comment


/*
/*
Line 223: Line 244:
a multiline
a multiline
comment
comment
*/</sqf>
*/
</sqf>
|-
| comment bold
| b
| <sqf>
// '''bold''' comment
</sqf>
|-
|-
| string
| string
| sqfhighlighter-'''string'''
| s
| <sqf>"string"</sqf>
| <sqf>"string"</sqf>
|-
| stringtable string
| ss
| <sqf>
"STR_entry"
"str_entry"
"sTr_entry"
"STRD_entry"
"STRM_entry"
"$STR_entry"
</sqf>
|-
|-
| number
| number
| sqfhighlighter-'''number'''
| n
| <sqf>42
| <sqf>
42
-6.9
-6.9
10e10</sqf>
10e10
</sqf>
|-
|-
| operator
| operator
| sqfhighlighter-'''operator'''
| o
| <sqf>a + b</sqf>
| <sqf>a + b</sqf>
|-
|-
| keyword ({{hl|if}}, {{hl|then}}, {{hl|waitUntil}}, etc)
| keyword ({{hl|if}}, {{hl|then}}, {{hl|waitUntil}}, etc)
| sqfhighlighter-'''keyword'''
| k
| <sqf>if</sqf>
| <sqf>if</sqf>
|-
|-
| command
| command
| sqfhighlighter-'''command'''
| c
| <sqf>setDir</sqf>
| <sqf>setDir</sqf>
|-
|-
| function
| function
| sqfhighlighter-'''function'''
| f
| <sqf>BIS_fnc_spawnGroup</sqf>
| <sqf>BIS_fnc_spawnGroup</sqf>
|-
|-
| external function
| function (external)
| sqfhighlighter-'''function-ext'''
| fe
| <sqf>// not just considering BIS_ or BIN_
| <sqf>// not just considering BIS_ or BIN_
BIS_fnc_unknownFunction
BIS_fnc_unknownFunction
Line 258: Line 299:
|-
|-
| local variable
| local variable
| sqfhighlighter-'''localvar'''
| lv
| <sqf>_localVar</sqf>
| <sqf>_localVar</sqf>
|-
|-
| global variable
| global variable
| sqfhighlighter-'''globalvar'''
| gv
| <sqf>// anything will go but UNDERSCORED_ALL_CAPS
| <sqf>
GlobalVar = 1;</sqf>
// anything will go but UNDERSCORED_ALL_CAPS
GlobalVar = 1;
</sqf>
|-
|-
| macro
| macro
| sqfhighlighter-'''macro'''
| m
| <sqf>#define myVar 1
| <sqf>
#define myVar 1
#if
#if
#endif</sqf>
#endif
</sqf>
|-
|-
| constant ({{hl|#define}}d value)
| constant ({{hl|#define}}d value)
| sqfhighlighter-'''const'''
| c
| <sqf>// anything #defined only
| <sqf>
// anything #defined only
#define testVar 1
#define testVar 1


testVar;
testVar;
otherVar;
otherVar;
MY_CONSTANT;</sqf>
MY_CONSTANT;
</sqf>
|-
|-
| array start ({{hl|[}})
| array start ({{hl|[}})
| sqfhighlighter-'''arraystart'''
| as
| <sqf>[...</sqf>
| <sqf>[ /* ... */</sqf>
|-
|-
| array end ({{hl|]}})
| array end ({{hl|]}})
| sqfhighlighter-'''arrayend'''
| ae
| <sqf>...]</sqf>
| <sqf>/* ... */ ]</sqf>
|-
|-
| code start ({{hl|{<nowiki/>}})
| code start ({{hl|{<nowiki/>}})
| sqfhighlighter-'''codestart'''
| cs
| <sqf>{...</sqf>
| <sqf>{ /* ... */</sqf>
|-
|-
| code end ({{hl|}<nowiki/>}})
| code end ({{hl|}<nowiki/>}})
| sqfhighlighter-'''codeend'''
| ce
| <sqf>...}</sqf>
| <sqf>/* ... */ }</sqf>
|-
|-
| parenthese start ({{hl|{<nowiki/>}})
| parenthese start ({{hl|{<nowiki/>}})
| sqfhighlighter-'''parenthesestart'''
| ps
| <sqf>(...</sqf>
| <sqf>( /* ... */</sqf>
|-
|-
| parenthese end ({{hl|}<nowiki/>}})
| parenthese end ({{hl|}<nowiki/>}})
| sqfhighlighter-'''parentheseend'''
| pe
| <sqf>...)</sqf>
| <sqf>/* ... */ )</sqf>
|}
|}


Line 342: Line 389:
|}
|}


{{Feature|informative|Report issues on [https://discord.gg/arma Discord], in the {{hl|#community_wiki}} channel!}}
{{Feature|informative|Report issues on {{Link|https://discord.gg/arma|Discord}}, in the {{hl|#community_wiki}} channel!}}
 
 
[[Category: MediaWiki Extension]]

Latest revision as of 15:47, 23 April 2024

SQF Highlighter
Description Highlights and links SQF commands and functions
Author Lou Montana
Project Start 2022-03-08: Project start
Release Date
  • 2022-03-12: "v1" (0.50b), first upload
  • 2022-07-11: "v2" (0.85b), new parser
  • 2023-11-02: 0.9b, allow some wiki formatting in comments
Version 0.9b

This extension highlights and automatically links SQF commands and functions. It also covers SQS (free of charge).



Features

  • SQF Syntax support
  • SQS Syntax support
  • "Copy code to clipboard" button on hover
  • Partial wiki formatting in comments: ''italic'', '''bold''', <s>striked</s>, <u>underlined</u>, [[links|even styled ones]], {{templates}}
  • #defined constant value on mouse hover
  • SQF tag button in the wiki edit toolbar (next to B and I)
  • Options:
    • inline for inline code
    • notrim to remove the auto trim (lines themselves will always be rtrimmed)
  • Categorises wrong code pages in Category:Pages with SQF errors and Category:Pages with SQS errors


Installation

  • Unzip the directory to wiki/extensions/SQFHighlighter
  • Add wfLoadExtension( 'SQFHighlighter' ); to LocalSettings.php
  • there is a case-sensitive setting in extension.json (default true). Set to false to highlight improperly-cased commands and functions (e.g setDaMMage instead of setDammage, etc)
  • The extension creates full path links unless the host is one of the following (then relative links are created):
    • community.bistudio.com
    • community.bohemia.net


Usage

Using <sqf> tags will auto-generate syntax highlighting and links to the pages.

Examples
SQF Syntax
Code Result 
<sqf/>
-no SQF code provided-
<sqf></sqf>
-no SQF code provided-
<sqf> </sqf>
-no SQF code provided-
<sqf>hint "It Works!";</sqf>
hint "It Works!";
This is <sqf inline>hint "It Works!";</sqf> absolutely inline.
This is hint "It Works!"; absolutely inline. 
<sqf notrim>

	hint "It Works!";


</sqf>
hint "It Works!"; 
<sqf>
// your code here
hint "good!";
</sqf>
// your code here hint "good!";
<sqf>
#define fadeInDuration 3

waitUntil { not alive player };
hint DEATH_MESSAGE;
cutText ["", "Black", playerRespawnTime];

private _deathTime = time;
Deaths = Deaths + 1;

/*
	wait for resurrection - see {{Link|Arma 3: Respawn}}
*/
waitUntil { alive player && { preloadCamera getPosATL player } };

sleep 3;
cutText ["Welcome!", "Black in", fadeInDuration];

// after 10s, end the mission
sleep 10;
[] call BIS_fnc_endMission;
</sqf>
#define fadeInDuration 3 waitUntil { not alive player }; hint DEATH_MESSAGE; cutText ["", "Black", playerRespawnTime]; private _deathTime = time; Deaths = Deaths + 1; /* wait for resurrection - see Arma 3: Respawn */ waitUntil { alive player && { preloadCamera getPosATL player } }; sleep 3; cutText ["Welcome!", "Black in", fadeInDuration]; // after 10s, end the mission sleep 10; [] call BIS_fnc_endMission;
SQS Syntax
Code Result 
<sqs/>
-no SQS code provided-
<sqs></sqs>
-no SQS code provided-
<sqs> </sqs>
-no SQS code provided-
<sqs>hint "It Works!"</sqs>
hint "It Works!";
This is <sqs inline>hint "It Works!"</sqs> absolutely inline.
This is hint "It Works!" absolutely inline. 
<sqs notrim>

	hint "It Works!";


</sqs>
hint "It Works!"; 
<sqs>
#loop
@ alive player
; you ok - see [[getDammage]] too
hint "OK"
~1
@ not alive player
~1
hint "you ded"
; you not ok
goto "loop"
</sqs>
#loop @ alive player ; you ok - see getDammage too hint "OK" ~1 @ not alive player ~1 hint "you ded" ; you not ok goto "loop"


CSS Classes

All elements are <span> except for some exceptions:

  • unless using <sqf inline>, the parent block is a <div> holding another one for scrolling purpose; otherwise, is is a <span> as well.
Element CSS class Overview
parent block sqfhighlighter-block
contains sqfhighlighter-scroller for blocks
;
error message sqfhighlighter-error
-no SQF code provided-

-no SQS code provided-
wild character / bad variable / unclosed string bv, bvl
@ private _var = 3RndMag; hint "hello
comment cc
// comment /* this is a multiline comment */
comment bold b
// bold comment
string s
"string"
stringtable string ss
"STR_entry" "str_entry" "sTr_entry" "STRD_entry" "STRM_entry" "$STR_entry"
number n
42 -6.9 10e10
operator o
a + b
keyword (if, then, waitUntil, etc) k
if
command c
setDir
function f
BIS_fnc_spawnGroup
function (external) fe
// not just considering BIS_ or BIN_ BIS_fnc_unknownFunction TAG_fnc_spawnGroup
local variable lv
_localVar
global variable gv
// anything will go but UNDERSCORED_ALL_CAPS GlobalVar = 1;
macro m
#define myVar 1 #if #endif
constant (#defined value) c
// anything #defined only #define testVar 1 testVar; otherVar; MY_CONSTANT;
array start ([) as
[ /* ... */
array end (]) ae
/* ... */ ]
code start ({) cs
{ /* ... */
code end (}) ce
/* ... */ }
parenthese start ({) ps
( /* ... */
parenthese end (}) pe
/* ... */ )


Known Issues

Version Issue Report Date Fix Date
v1 comment blocks still highlight words as global variables for now 2022-03-15 2022-03-17
#if are considered as keywords 2022-03-15 2022-03-17
single-quote strings have issues with other formatting between quotes 2022-03-15 w/ v2
negative numbers should see the minus sign coloured as well
in the end, they should not 		2022-03-15 2022-03-17
numbers in variables are highlighted as numbers (e.g unit1) 2022-03-22 w/ v2
v2 preprocessor instructions are not considered if not at the very beginning of the line (and the parsing of the whole line may be wrong) 2022-07-11 2022-07-12
ⓘ
Report issues on Discord, in the #community_wiki channel!
Retrieved from "https://community.bistudio.com/wiki?title=Extension:SQF_Highlighter&oldid=363826"