BIS fnc exportFunctionsToWiki: Difference between revisions

Latest revision as of 00:25, 2 February 2024

1.00

Hover & click on the images for description

Description

Description:: Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.
Wiki Admins can import them using Special:Import.
If the page already exists, it will be replaced only when timestamp is newer.
⚠
This function should no longer be used to mass-import functions since the template for function pages has changed drastically!
Execution:: spawn
Groups:: Diagnostic

Syntax

Syntax:

[filter, timestamp] spawn BIS_fnc_exportFunctionsToWiki

Parameters:

filter: Array - (Optional, default []) functions filter in format [tags, categories, functions]:

tags: String or Array of Strings - CfgFunctions tags (e.g., "A3_Oldman"). Use empty string for all of them
categories: String or Array of Strings - categories (e.g., "Debug"). Use empty string for all of them
functions: String or Array of Strings - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them

timestamp: String - (Optional, default "2006-04-03T17:42:00Z") in format "2013-09-12T16:00:00Z"

Return Value:

String - exported text

Examples

Example 1:: [] spawn BIS_fnc_exportFunctionsToWiki; // export all functions
Example 2:: [["", "Arrays"]] spawn BIS_fnc_exportFunctionsToWiki; // export all Array functions
Example 3:: [["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] spawn BIS_fnc_exportFunctionsToWiki; // export specific functions

Additional Information

See also:: BIS_fnc_diagWiki

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
-{{Function
+{{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
 |gr1= Diagnostic
-| Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.<br>
+|descr= Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.<br>
 '''Wiki Admins''' can import them using '''[[Special:Import]]'''.<br>
 If the page already exists, it will be replaced only when ''timestamp'' is newer.
+{{Feature|warning|<div style{{=}}"font-weight: bold; padding: 2em; text-align: center">This function should no longer be used to mass-import functions since the template for function pages has changed drastically!</div>}}
-| [filter, timestamp] spawn [[BIS_fnc_exportFunctionsToWiki]]
+|s1= [filter, timestamp] spawn [[BIS_fnc_exportFunctionsToWiki]]
-|p1= filter: [[Array]] - (Optional, default []) functions filter in format [tags, categories, functions]:
+|p1= filter: [[Array]] - (Optional, default <sqf inline>[]</sqf>) functions filter in format [tags, categories, functions]:
-* tags: [[String]] or [[Array]] of [[String]]s - CfgFunctions tags (e.g., "A3_Oldman"). Use empty string for all of them.
+* tags: [[String]] or [[Array]] of [[String]]s - CfgFunctions tags (e.g., "A3_Oldman"). Use empty string for all of them
-* categories: [[String]] or [[Array]] of [[String]]s - categories (e.g., "Debug"). Use empty string for all of them.
+* categories: [[String]] or [[Array]] of [[String]]s - categories (e.g., "Debug"). Use empty string for all of them
-* functions: [[String]] or [[Array]] of [[String]]s - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them.
+* functions: [[String]] or [[Array]] of [[String]]s - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them
 |p2= timestamp: [[String]] - (Optional, default "2006-04-03T17:42:00Z") in format "2013-09-12T16:00:00Z"
-| [[String]] - exported text
+|r1= [[String]] - exported text
-|x1= <code>[] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export all functions}}</code>
+|x1= <sqf>[] spawn BIS_fnc_exportFunctionsToWiki; // export all functions</sqf>
-|x2= <code>[<nowiki/>["", "Arrays"]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export all Array functions}}</code>
+|x2= <sqf>[["", "Arrays"]] spawn BIS_fnc_exportFunctionsToWiki; // export all Array functions</sqf>
-|x3= <code>[<nowiki/>["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{cc|export specific functions}}</code>
+|x3= <sqf>[["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] spawn BIS_fnc_exportFunctionsToWiki; // export specific functions</sqf>
-|exec= spawn |Execution=
+|exec= spawn
-| [[BIS_fnc_diagWiki]]
+|seealso= [[BIS_fnc_diagWiki]]
 }}