BIS fnc exportFunctionsToWiki: Difference between revisions

Latest revision as of 01: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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Diagnostic
-|1.00|= Game version
+|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>}}
-| Export function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.<br />
+|s1= [filter, timestamp] spawn [[BIS_fnc_exportFunctionsToWiki]]
-'''Wiki Admins''' can import them using '''[[Special:Import]]'''.<br />
-If the page already exists, it will be replaced only when timestamp is newer. |= Description
-____________________________________________________________________________________________
-| [filter, timestamp] call [[BIS_fnc_exportFunctionsToWiki]] |= Syntax
+|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
+* 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
-|p1= filter: [[Array]] - (Optional) functions filter in format [tags,categories,functions]:
+|p2= timestamp: [[String]] - (Optional, default "2006-04-03T17:42:00Z") in format "2013-09-12T16:00:00Z"
-* tags: [[String]] or [[Array]] of [[String]] - CfgFunctions tags (e.g., "BIS"). Use empty string for all of them.
-* categories: [[String]] or [[Array]] of [[String]] - categories (e.g., "Debug"). Use empty string for all of them.
-* functions: [[String]] or [[Array]] of [[String]] - specific function names (e.g., "BIS_fnc_log"). Use empty string for all of them. |= Parameter 1
-|p2= timestamp: [[String]] - (Optional) in format "2013-09-12T16:00:00Z" |= Parameter 2
+|r1= [[String]] - exported text
-| [[String]] - exported text |= Return value
+|x1= <sqf>[] spawn BIS_fnc_exportFunctionsToWiki; // export all functions</sqf>
-____________________________________________________________________________________________
-|x1= <code>[] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export all functions}}</code> |= Example 1
+|x2= <sqf>[["", "Arrays"]] spawn BIS_fnc_exportFunctionsToWiki; // export all Array functions</sqf>
-|x2= <code><nowiki>[</nowiki>["","Arrays"]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export all Array functions}}</code> |= Example 2
+|x3= <sqf>[["", "", ["BIS_fnc_log", "BIS_fnc_param"]]] spawn BIS_fnc_exportFunctionsToWiki; // export specific functions</sqf>
-|x3= <code><nowiki>[</nowiki>["","",["BIS_fnc_log","BIS_fnc_param"]]] [[spawn]] [[BIS_fnc_exportFunctionsToWiki]]; {{codecomment|// export specific functions}}</code> |= Example 3
+|exec= spawn
-____________________________________________________________________________________________
-|exec= spawn |= Execution
-| [[BIS_fnc_diagWiki]] |= See also
+|seealso= [[BIS_fnc_diagWiki]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Diagnostic|{{uc:exportFunctionsToWiki}}]]
-[[Category:Functions|{{uc:exportFunctionsToWiki}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:exportFunctionsToWiki}}]]