Structured Text: Difference between revisions
Killzone Kid (talk | contribs) (→Vertical Alignment: typo) |
Lou Montana (talk | contribs) m (Text replacement - "\[https?\:\/\/en\.wikipedia\.org\/wiki\/([^ ]+) (.+)\]" to "{{Wikipedia|$1|$2}}") |
||
(33 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{TOC|side}} | ||
Structured Text is just another RV Engine [[typeName | type]] TEXT. It is a rich text, which is able to include images and formatting. It can be created using XML like syntax, as seen in [[parseText]]. However using XML like syntax alone is not going to magically turn given string into structured text, it should be converted to TEXT first. Introduced with Armed Assault, does not refer to Cold War Crisis or Resistance. | |||
{{Feature|Informative|See [[:Category:Command Group: Structured Text|Command Group: Structured Text]] for all related commands.}} | |||
{{Feature|important|This type is not meant to be used with remote execution. Executing | |||
<code>[[parseText]] "test" [[remoteExec]] ["[[hint]]", 0];</code> | |||
will result in the following rpt message:<br> | |||
Performance warning: SimpleSerialization::Write 'params' is using type of ',TEXT' which is not optimized by simple serialization, falling back to generic serialization, use generic type or ask for optimizations for these types<br> | |||
Parse the text on the receiving client instead.}} | |||
== Markups == | |||
== | === Syntax === | ||
All attribute values should be encapsulated in double <tt>"..."</tt> or single <tt>'...'</tt> quotes. Both of the following are correct: | |||
<syntaxhighlight lang="html"> | |||
<t size=""2.0"">Large text</t> | |||
<t size='2.0'>Large text</t> | |||
</syntaxhighlight> | |||
{{Feature|warning|The following will log an ''.rpt'' error <tt>Unknown attribute .0</tt> and only number 2 would be taken into account: | |||
<syntaxhighlight lang="html"> | |||
<t size=2.0>Large text</t> | |||
</syntaxhighlight> | |||
}} | |||
=== Text === | === Text === | ||
Texts could be created with the following markup: | Texts could be created with the following markup: | ||
<syntaxhighlight lang="html"> | |||
Or could also be inserted via the [[composeText]] and [[text]] commands. | <t>Hello World!</t> | ||
</syntaxhighlight> | |||
Or could also be inserted via the [[composeText]] / [[formatText]] and [[text]] commands. | |||
==== Non-breaking space ==== | ==== Non-breaking space ==== | ||
A non-breaking space, commonly known as '''&nbsp;''' shows as '''?''' in structured text control. Use '''&#160;''' as an alternative. | A non-breaking space, commonly known as '''&nbsp;''' shows as '''?''' in structured text control. Use '''&#160;''' as an alternative. | ||
<syntaxhighlight lang="html"> | |||
<t>FIVE     SPACES</t> | |||
</syntaxhighlight> | |||
=== Line break === | === Line break === | ||
Line breaks could be created with either of the following markups: | Line breaks could be created with either of the following markups: | ||
<syntaxhighlight lang="html"> | |||
<br/> | |||
Or could also be inserted via the [[composeText]] and [[lineBreak]] commands. | <br /> | ||
<br></br> | |||
</syntaxhighlight> | |||
Or could also be inserted via the [[composeText]] / [[formatText]] and [[lineBreak]] commands. | |||
=== Image === | === Image === | ||
Images could be created with either of the following markups: | Images could be created with either of the following markups: | ||
<syntaxhighlight lang="html"> | |||
<img image='\a3\Data_f\Flags\flag_Altis_co.paa'/> | |||
Or could also be inserted via the [[composeText]] and [[image]] commands. | <img image='\a3\Data_f\Flags\flag_Altis_co.paa' /> | ||
<img image='\a3\Data_f\Flags\flag_Altis_co.paa'></img> | |||
</syntaxhighlight> | |||
Or could also be inserted via the [[composeText]] / [[formatText]] and [[image]] commands. | |||
{{ArgTitle|Hyperlink|3|{{GVI|arma3}}}} | |||
Clickable links, similar to HTML hyperlinks, could be created with the following markup: | Clickable links, similar to HTML hyperlinks, could be created with the following markup: | ||
<syntaxhighlight lang="html"> | |||
By default the links are not underlined or have a different color to stand out. These attributes should be added separately. | <a href='http://arma3.com'>Arma 3</a> | ||
</syntaxhighlight> | |||
By default the links are not underlined or have a different color to stand out. These attributes should be added separately.<br> | |||
Note: ''&'' should be escaped by ''&amp;''. | |||
<syntaxhighlight lang="html"> | |||
<a href='https://arma3.com/?foo&bar'>Example URL A</a> <!-- will not work --> | |||
<a href='https://arma3.com/?foo&amp;bar'>Example URL B</a> <!-- will work --> | |||
</syntaxhighlight> | |||
== Attributes == | == Attributes == | ||
The following inline | |||
The following inline attributes are supported: | |||
* <tt>size</tt> | * <tt>size</tt> | ||
* <tt>color</tt> | * <tt>color</tt> | ||
Line 42: | Line 83: | ||
* <tt>valign</tt> | * <tt>valign</tt> | ||
* <tt>underline</tt> | * <tt>underline</tt> | ||
* <tt>shadow</tt> | * <tt>shadow</tt> | ||
* <tt>shadowColor</tt> | |||
* <tt>shadowOffset</tt> | * <tt>shadowOffset</tt> | ||
* <tt> | * <tt>colorLink</tt> | ||
* <tt>href</tt> | * <tt>href</tt> | ||
* <tt> | * <tt>image</tt> | ||
=== Size === | === Size === | ||
The structured text <tt>size</tt> attribute is a multiplier for the value of control config property <tt>size</tt>. Default is 1, meaning that the height of letters will be equal to the value set in config. Setting this to 2 will make letters 2 times the size, 0.5 will make them half the size, etc. If the control is defined as follows: | The structured text <tt>size</tt> attribute is a multiplier for the value of control config property <tt>size</tt>. Default is 1, meaning that the height of letters will be equal to the value set in config. Setting this to 2 will make letters 2 times the size, 0.5 will make them half the size, etc. If the control is defined as follows: | ||
<syntaxhighlight lang="cpp">class MyStructuredText : RscStructuredText | <syntaxhighlight lang="cpp"> | ||
class MyStructuredText : RscStructuredText | |||
{ | { | ||
... | ... | ||
Line 58: | Line 101: | ||
size = 0.04; | size = 0.04; | ||
... | ... | ||
};</syntaxhighlight> | }; | ||
</syntaxhighlight> | |||
Then the structured text: | Then the structured text: | ||
Line 65: | Line 109: | ||
=== Color === | === Color === | ||
The <tt>color</tt> attribute is similar to HTML hex color and could either have format | |||
The <tt>color</tt> attribute is similar to HTML hex color and could either have format {{Wikipedia|RGB|#RRGGBB}} or {{Wikipedia|ARGB|#AARRGGBB}}. | |||
<syntaxhighlight lang="html"> | |||
<t color='#ff0000'>Red text</t> | |||
<t color='#99ffffff'>Semi-transparent white text</t> | |||
</syntaxhighlight> | |||
=== Font === | === Font === | ||
The value for the <tt>font</tt> attribute could be found in <tt>CfgFontFamilies</tt> config. Some of the Arma 3 fonts: | The value for the <tt>font</tt> attribute could be found in <tt>CfgFontFamilies</tt> config. Some of the Arma 3 fonts: | ||
* <tt>EtelkaMonospacePro</tt> | * <tt>EtelkaMonospacePro</tt> | ||
Line 84: | Line 132: | ||
* <tt>RobotoCondensedLight</tt> | * <tt>RobotoCondensedLight</tt> | ||
* <tt>TahomaB</tt> | * <tt>TahomaB</tt> | ||
<syntaxhighlight lang="html"> | |||
<t font='PuristaBold'>Bold Text</t> | |||
<t font='LCD14'>Wicked looking text</t> | |||
</syntaxhighlight> | |||
=== Horizontal Alignment === | === Horizontal Alignment === | ||
The <tt>align</tt> attribute controls horizontal text alignment and could be one of the following: | The <tt>align</tt> attribute controls horizontal text alignment and could be one of the following: | ||
* <tt>left</tt> | * <tt>left</tt> | ||
* <tt>center</tt> | * <tt>center</tt> | ||
* <tt>right</tt> | * <tt>right</tt> | ||
<syntaxhighlight lang="html"> | |||
<t align='right'>Text displayed to the right</t> | |||
</syntaxhighlight> | |||
=== Vertical Alignment === | === Vertical Alignment === | ||
The <tt>valign</tt> attribute controls vertical text alignment and could be one of the following: | The <tt>valign</tt> attribute controls vertical text alignment and could be one of the following: | ||
* <tt>top</tt> | * <tt>top</tt> | ||
* <tt>middle</tt> | * <tt>middle</tt> | ||
* <tt>bottom</tt> | * <tt>bottom</tt> | ||
<syntaxhighlight lang="html"> | |||
<t valign='bottom'>Text displayed at the bottom</t> | |||
</syntaxhighlight> | |||
=== Underline === | === Underline === | ||
The <tt>underline</tt> attribute underlines each individual word in text. The normal spaces are not underlined. | The <tt>underline</tt> attribute underlines each individual word in text. The normal spaces are not underlined. | ||
<syntaxhighlight lang="html"> | |||
{{Informative | If you would like to | <t underline='1'>Underlined Text</t> | ||
* Insertion from keyboard: | </syntaxhighlight> | ||
{{Feature | Informative | If you would like to have a continuous underline between words, use non-breaking spaces. This could be achieved in several ways: | |||
* Insertion from keyboard: {{Wikipedia|Non-breaking_space#Keyboard_entry_methods|Alt+255}} | |||
* Scripted method: | * Scripted method: | ||
<code>[[hint]] [[parseText]] [[format]] ["<t underline | <code>[[hint]] [[parseText]] [[format]] ["<t underline{{=}}'1'>%1</t>", "Underlined Text" [[splitString]] " " [[joinString]] [[toString]] [160]]</code> | ||
* Using HTML code: | * Using HTML code: | ||
<code>[[hint]] [[parseText]] "<t underline | <code>[[hint]] [[parseText]] "<t underline{{=}}'1'>Underlined&#160;Text</t>";</code>}} | ||
=== Shadow === | === Shadow === | ||
=== | The <tt>shadow</tt> attribute controls the appearance of shadow/outline around text and could be one of the following: | ||
* <tt>0</tt> - normal text | |||
* <tt>1</tt> - classic shadow (text ghosting below and to the right) | |||
* <tt>2</tt> - outline (slight, always black, outline around characters) | |||
<syntaxhighlight lang="html"> | |||
<t shadow='0'>Text with no shadow</t> | |||
<t shadow='1'>Text with default black shadow</t> | |||
<t shadow='2'>Text with default black outline</t> | |||
</syntaxhighlight> | |||
=== Shadow Color === | |||
The <tt>shadowColor</tt> attribute controls the color of the shadow (not the outline, which is always black for some reason) | |||
<syntaxhighlight lang="html"> | |||
<t shadow='1' shadowColor='#ff0000'>Text with red shadow</t> | |||
</syntaxhighlight> | |||
=== Shadow Offset === | |||
The <tt>shadowOffset</tt> attribute controls how far is the shadow offset from the text source (has no effect on the outline) | |||
<syntaxhighlight lang="html"> | |||
<t shadow='1' shadowColor='#ff0000' shadowOffset='0.5'>Text with red shadow, which is offset by half character size</t> | |||
</syntaxhighlight> | |||
=== Link Color === | === Link Color === | ||
Will change the color of the text if the text is a link, otherwise the text color is unaffected. | Will change the color of the text if the text is a link, otherwise the text color is unaffected. | ||
<syntaxhighlight lang="html"> | |||
<t colorLink='#0000ff'><a href='http://www.arma3.com/'>Blue text</a></t> | |||
<a colorLink='#0000ff' href='http://www.arma3.com/'>Blue text too</a> | |||
<t colorLink='#0000ff'>Normal text color</t> | |||
</syntaxhighlight> | |||
=== Hyperlink Reference === | |||
The <tt>href</tt> attribute is essential part of the <tt><nowiki><a></nowiki></tt> tag and should contain URL of the destination (See [[#Hyperlink | Hyperlink]]). | |||
=== Image Reference === | |||
The <tt>image</tt> attribute is essential part of the <tt><nowiki><img></nowiki></tt> tag and should contain filepath to the image (See [[Structured_Text#Image | Image]]). | |||
== SQF Code Examples == | |||
<tt>align</tt> <tt>valign</tt> demo: | <tt>align</tt> <tt>valign</tt> demo: | ||
<code>[[hint]] [[parseText]] "<t size='3'><t size='1' valign='top' align='right'>Top Right</t> <t size='1' valign='middle' align='center'>Middle Center</t> <t size='1' valign='bottom' align='left'>Bottom Left</t></t>";</code> | |||
{{Feature | Informative | Sometimes an extra space is required when outputting to [[hint]]. In the above example spaces between <tt><nowiki><t></nowiki></tt>s inside another <tt><nowiki><t></nowiki></tt> wrapper ensure that the hint will be 3 lines tall}} | |||
Create clickable image: | Create clickable image: | ||
<code>_ctrl = [[findDisplay]] 46 [[createDisplay]] "RscDisplayEmpty" [[ctrlCreate]] ["RscStructuredText", -1]; | |||
_ctrl [[ctrlSetPosition]] [0,0,1,1]; | |||
_ctrl [[ctrlCommit]] 0; | |||
_ctrl [[ctrlSetStructuredText]] [[parseText]] "<nowiki><a color='#00FF00' size='5' href='http://arma3.com'><img image='\A3\weapons_f\ammoBoxes\data\ui\map_AmmoBox_F_CA.paa' /></a></nowiki>";</code> | |||
The use of [[composeText]]: | |||
<code>_separator = [[parseText]] "<nowiki><br />------------------------<br /></nowiki>"; | |||
_image = "\a3\Data_f\Flags\flag_Altis_co.paa"; | |||
_txt1 = [[text]] "left"; | |||
_txt1 [[setAttributes]] ["align", "left"]; | |||
_txt2 = [[text]] "right"; | |||
_txt2 [[setAttributes]] ["align", "right"]; | |||
_structuredText = [[composeText]] [<nowiki/>[[image]] _image, [[lineBreak]], [[lineBreak]], [[text]] "Heading Text", _separator, _txt1, _txt2]; | |||
[[hint]] _structuredText;</code> | |||
[[Category:Data Types]] | |||
Revision as of 16:56, 30 May 2021
Structured Text is just another RV Engine type TEXT. It is a rich text, which is able to include images and formatting. It can be created using XML like syntax, as seen in parseText. However using XML like syntax alone is not going to magically turn given string into structured text, it should be converted to TEXT first. Introduced with Armed Assault, does not refer to Cold War Crisis or Resistance.
Markups
Syntax
All attribute values should be encapsulated in double "..." or single '...' quotes. Both of the following are correct:
<t size=""2.0"">Large text</t>
<t size='2.0'>Large text</t>
Text
Texts could be created with the following markup:
<t>Hello World!</t>
Or could also be inserted via the composeText / formatText and text commands.
Non-breaking space
A non-breaking space, commonly known as shows as ? in structured text control. Use   as an alternative.
<t>FIVE     SPACES</t>
Line break
Line breaks could be created with either of the following markups:
<br/>
<br />
<br></br>
Or could also be inserted via the composeText / formatText and lineBreak commands.
Image
Images could be created with either of the following markups:
<img image='\a3\Data_f\Flags\flag_Altis_co.paa'/>
<img image='\a3\Data_f\Flags\flag_Altis_co.paa' />
<img image='\a3\Data_f\Flags\flag_Altis_co.paa'></img>
Or could also be inserted via the composeText / formatText and image commands.
3
Clickable links, similar to HTML hyperlinks, could be created with the following markup:
<a href='http://arma3.com'>Arma 3</a>
By default the links are not underlined or have a different color to stand out. These attributes should be added separately.
Note: & should be escaped by &.
<a href='https://arma3.com/?foo&bar'>Example URL A</a> <!-- will not work -->
<a href='https://arma3.com/?foo&amp;bar'>Example URL B</a> <!-- will work -->
Attributes
The following inline attributes are supported:
- size
- color
- font
- align
- valign
- underline
- shadow
- shadowColor
- shadowOffset
- colorLink
- href
- image
Size
The structured text size attribute is a multiplier for the value of control config property size. Default is 1, meaning that the height of letters will be equal to the value set in config. Setting this to 2 will make letters 2 times the size, 0.5 will make them half the size, etc. If the control is defined as follows:
class MyStructuredText : RscStructuredText
{
...
text = "Hello!";
size = 0.04;
...
};
Then the structured text:
_control ctrlSetStructuredText parseText "<t size='2'>Hello!</t>";
Will result in a total text size of 0.04 * 2 = 0.08. Unfortunately, there is no script command to set or get the value of config size property dynamically.
Color
The color attribute is similar to HTML hex color and could either have format #RRGGBB or #AARRGGBB.
<t color='#ff0000'>Red text</t>
<t color='#99ffffff'>Semi-transparent white text</t>
Font
The value for the font attribute could be found in CfgFontFamilies config. Some of the Arma 3 fonts:
- EtelkaMonospacePro
- EtelkaMonospaceProBold
- EtelkaNarrowMediumPro
- LCD14
- LucidaConsoleB
- PuristaBold
- PuristaLight
- PuristaMedium
- PuristaSemibold
- RobotoCondensed
- RobotoCondensedBold
- RobotoCondensedLight
- TahomaB
<t font='PuristaBold'>Bold Text</t>
<t font='LCD14'>Wicked looking text</t>
Horizontal Alignment
The align attribute controls horizontal text alignment and could be one of the following:
- left
- center
- right
<t align='right'>Text displayed to the right</t>
Vertical Alignment
The valign attribute controls vertical text alignment and could be one of the following:
- top
- middle
- bottom
<t valign='bottom'>Text displayed at the bottom</t>
Underline
The underline attribute underlines each individual word in text. The normal spaces are not underlined.
<t underline='1'>Underlined Text</t>
Shadow
The shadow attribute controls the appearance of shadow/outline around text and could be one of the following:
- 0 - normal text
- 1 - classic shadow (text ghosting below and to the right)
- 2 - outline (slight, always black, outline around characters)
<t shadow='0'>Text with no shadow</t>
<t shadow='1'>Text with default black shadow</t>
<t shadow='2'>Text with default black outline</t>
Shadow Color
The shadowColor attribute controls the color of the shadow (not the outline, which is always black for some reason)
<t shadow='1' shadowColor='#ff0000'>Text with red shadow</t>
Shadow Offset
The shadowOffset attribute controls how far is the shadow offset from the text source (has no effect on the outline)
<t shadow='1' shadowColor='#ff0000' shadowOffset='0.5'>Text with red shadow, which is offset by half character size</t>
Link Color
Will change the color of the text if the text is a link, otherwise the text color is unaffected.
<t colorLink='#0000ff'><a href='http://www.arma3.com/'>Blue text</a></t>
<a colorLink='#0000ff' href='http://www.arma3.com/'>Blue text too</a>
<t colorLink='#0000ff'>Normal text color</t>
Hyperlink Reference
The href attribute is essential part of the <a> tag and should contain URL of the destination (See Hyperlink).
Image Reference
The image attribute is essential part of the <img> tag and should contain filepath to the image (See Image).
SQF Code Examples
align valign demo:
hint parseText "<t size='3'><t size='1' valign='top' align='right'>Top Right</t> <t size='1' valign='middle' align='center'>Middle Center</t> <t size='1' valign='bottom' align='left'>Bottom Left</t></t>";
Create clickable image:
_ctrl = findDisplay 46 createDisplay "RscDisplayEmpty" ctrlCreate ["RscStructuredText", -1];
_ctrl ctrlSetPosition [0,0,1,1];
_ctrl ctrlCommit 0;
_ctrl ctrlSetStructuredText parseText "<a color='#00FF00' size='5' href='http://arma3.com'><img image='\A3\weapons_f\ammoBoxes\data\ui\map_AmmoBox_F_CA.paa' /></a>";
The use of composeText:
_separator = parseText "<br />------------------------<br />";
_image = "\a3\Data_f\Flags\flag_Altis_co.paa";
_txt1 = text "left";
_txt1 setAttributes ["align", "left"];
_txt2 = text "right";
_txt2 setAttributes ["align", "right"];
_structuredText = composeText [image _image, lineBreak, lineBreak, text "Heading Text", _separator, _txt1, _txt2];
hint _structuredText;