Difference between revisions of "localize"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
(not found strings are logged in .rpt)
(18 intermediate revisions by 10 users not shown)
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''.<br />
 +
If the key couldn't be found, an empty string ({{Inline code|""}}) is returned and an entry is added to .rpt file, for example <tt>String STR_DN_SNAKE not found</tt>. |Description=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Used to internationalise text messages.
+
| [[localize]] stringName |Syntax=
 
 
A string is returned from [[Stringtable.csv]] which corresponds to the STR_Token. |= Description
 
____________________________________________________________________________________________
 
  
| [[String]] <nowiki>=</nowiki> '''localize''' stringName |= Syntax
+
|p1= stringName: [[String]] |Parameter 1=
  
p1| stringName: [[String]] found in corresponding entry in stringtable.csv |= Parameter 1
+
| [[String]] - text found in corresponding entry in stringtable file |Return value=
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <pre>_ThisLanguage = localize "STR_DN_FROG"</pre> |= 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"]; {{codecomment|// -> "Go North"}}</code> |Example 2=
 +
|x3= <code>{{codecomment|// STR_ACTION_DROP_WEAPON contains "Drop %1"
 +
// STR_SN_RIFLE contains "Rifle"}}
 +
[[hint]] [[format]] <nowiki>[</nowiki>[[localize]] "STR_ACTION_DROP_WEAPON", [[localize]] "STR_SN_RIFLE"]; {{codecomment|// -> "Drop Rifle"}}</code> |Example 3=
 +
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Stringtable.csv File Format]] |= See also
+
| [[isLocalized]], [[BIS_fnc_localize]], [[WFSideText]], [[parseText]], [[Stringtable.csv]], [[Stringtable.xml]] |See also=
 
 
 
}}
 
}}
  
Line 35: Line 38:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|LOCALIZE]]
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|LOCALIZE]]
+
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|LOCALIZE]]
+
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|LOCALIZE]]
+
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
 +
<!-- CONTINUE Notes -->
 +
<dl class="command_description">
 +
<dd class="notedate">Posted on September 12, 2014 - 11:55 (UTC)</dd>
 +
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 +
<dd class="note">
 +
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:
 +
<syntaxhighlight lang="xml"><?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></syntaxhighlight>
 +
<code>[[hint]] [[parseText]] [[localize]] "str_test_kk";  {{codecomment|// no change of colour}}</code>
 +
<code>[[hint]] [[parseText]] [[localize]] "str_test_kk2"; {{codecomment|// hint content is in red}}</code>
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->

Revision as of 15:31, 2 September 2018

Template:Command

Notes

Bottom Section

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