localize: Difference between revisions

Revision as of 13:59, 2 September 2018

1.00

Hover & click on the images for description

Description

Description:: Used to internationalise text messages. A string is returned from Stringtable.csv (or Stringtable.xml) which corresponds to the stringName.
If the key couldn't be found, an empty string ("") is returned.
Groups:: Uncategorised

Syntax

Syntax:: localize stringName
Parameters:: stringName: String
Return Value:: String - text found in corresponding entry in stringtable file

Examples

Example 1:: hint localize "STR_WEST"; // -> "BLUFOR" (in Arma2)
Example 2:: hint format ["Go %1", localize "STR_Q_NORTH"]; // -> "Go North"
Example 3:: // STR_ACTION_DROP_WEAPON contains "Drop %1" // STR_SN_RIFLE contains "Rifle" hint format [localize "STR_ACTION_DROP_WEAPON", localize "STR_SN_RIFLE"]; // -> "Drop Rifle"

Additional Information

See also:: isLocalized BIS_fnc_localize WFSideText parseText Stringtable.csv Stringtable.xml

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

Posted on September 12, 2014 - 11:55 (UTC)

Killzone Kid

The command localize will strip all HTML tags from your stringtable.xml entries, however there is a way to trick it by substituting tags with HTML code instead:

<?xml version="1.0" encoding="utf-8"?>
<Key ID="STR_TEST_KK">
	<Original><![CDATA[<t color='#ff0000'>This doesn't work</t>]]></Original>
</Key>
<Key ID="STR_TEST_KK2">
	<Original>&lt;t color='#ff0000'&gt;This works&lt;/t&gt;</Original>
</Key>

hint parseText localize "str_test_kk"; // no change of colour hint parseText localize "str_test_kk2"; // hint content is in red

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{Command|Comments=
 ____________________________________________________________________________________________
-| ofp |= Game name
+| ofp |Game name=
-|1.00|= Game version
+|1.00|Game version=
-|eff= local |= Effects in MP
 ____________________________________________________________________________________________
-| Used to internationalise text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''. |= Description
+| Used to internationalise text messages. A string is returned from [[Stringtable.csv]] (or [[Stringtable.xml]]) which corresponds to the ''stringName''.<br />
+If the key couldn't be found, an empty string ({{Inline code|""}}) is returned. |Description=
 ____________________________________________________________________________________________
-| '''localize''' stringName |= Syntax
+| [[localize]] stringName |Syntax=
-|p1= stringName: [[String]] |= Parameter 1
+|p1= stringName: [[String]] |Parameter 1=
-| [[String]] - text found in corresponding entry in stringtable file |= Return value
+| [[String]] - text found in corresponding entry in stringtable file |Return value=
 ____________________________________________________________________________________________
-|x1= <code>[[hint]] [[localize]] "STR_WEST"; // -> "BLUFOR" (in Arma2)</code> |= Example 1
+|x1= <code>[[hint]] [[localize]] "STR_WEST"; {{codecomment|// -> "BLUFOR" (in Arma2)}}</code> |Example 1=
-|x2= <code>[[hint]] [[format]] ["Go %1", [[localize]] "STR_Q_NORTH"]; // -> "Go North"</code> |= Example 2
+|x2= <code>[[hint]] [[format]] ["Go %1", [[localize]] "STR_Q_NORTH"]; {{codecomment|// -> "Go North"}}</code> |Example 2=
-|x3= <code>[[hint]] [[format]] <nowiki>[</nowiki>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; // -> "Drop Rifle"
+|x3= <code>{{codecomment|// STR_ACTION_DROP_WEAPON contains "Drop %1"
-// STR_ACTION_DROP_WEAPON contains "Drop %1", STR_SN_RIFLE contains "Rifle"</code> |= Example 3
+// STR_SN_RIFLE contains "Rifle"}}
+[[hint]] [[format]] <nowiki>[</nowiki>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code> |Example 3=
 ____________________________________________________________________________________________
-| [[isLocalized]], [[BIS_fnc_localize]], [[WFSideText]], [[parseText]], [[Stringtable.csv]], [[Stringtable.xml]] |= See also
+| [[isLocalized]], [[BIS_fnc_localize]], [[WFSideText]], [[parseText]], [[Stringtable.csv]], [[Stringtable.xml]] |See also=
 }}
@@ Line 39: / Line 38: @@
 <h3 style="display:none">Bottom Section</h3>
-[[Category:Scripting Commands|LOCALIZE]]
+[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
+[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 [[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands OFP 1.96|LOCALIZE]]
+[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands OFP 1.46|LOCALIZE]]
-[[Category:Scripting Commands ArmA|LOCALIZE]]
 [[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
 [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
@@ Line 62: / Line 61: @@
 	<Original>&lt;t color='#ff0000'&gt;This works&lt;/t&gt;</Original>
 </Key></syntaxhighlight>
-<code>[[hint]] [[parseText]] [[localize]] "str_test_kk"; //no change of colour</code>
+<code>[[hint]] [[parseText]] [[localize]] "str_test_kk";  {{codecomment|// no change of colour}}</code>
-<code>[[hint]] [[parseText]] [[localize]] "str_test_kk2"; //hint content is in red</code>
+<code>[[hint]] [[parseText]] [[localize]] "str_test_kk2"; {{codecomment|// hint content is in red}}</code>
 </dd>
 </dl>
 <!-- DISCONTINUE Notes -->