HeaderTitle Script - Revision history

Rob: /* Technical Details */

2009-02-20T08:53:34Z

Technical Details

← Older revision		Revision as of 08:53, 20 February 2009
Line 15:		Line 15:
	\|Where Used:		\|Where Used:
	\|[[Portal Element (Data)\|Portals]]		\|[[Portal Element (Data)\|Portals]]
			\|-
			\|Procedure Use:
			\|"label" type, "info" context, "pick" context
	\|-		\|-
	\|}		\|}

Rob at 00:15, 16 December 2008

2008-12-16T00:15:58Z

← Older revision		Revision as of 00:15, 16 December 2008
Line 12:		Line 12:
	\|Fields Finalized?		\|Fields Finalized?
	\|Yes		\|Yes
			\|-
			\|Where Used:
			\|[[Portal Element (Data)\|Portals]]
	\|-		\|-
	\|}		\|}

Rob at 12:24, 15 December 2008

2008-12-15T12:24:53Z

← Older revision		Revision as of 12:24, 15 December 2008
Line 19:		Line 19:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|text		\|class="leftnormal"\|text
	\|Entry: Contains the empty string.<br>		\|(String) Entry: Contains the empty string.<br>
	Exit: Contains the text to be displayed to the user as the title above the table. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user as the title above the table. The final text may contain [[Encoded Text\|encoding]].
	\|-		\|-

Rob at 14:00, 12 December 2008

2008-12-12T14:00:49Z

← Older revision		Revision as of 14:00, 12 December 2008
Line 18:		Line 18:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|~~Text~~		\|class="leftnormal"\|text
	\|Entry: Contains the empty string.<br>		\|Entry: Contains the empty string.<br>
	Exit: Contains the text to be displayed to the user as the title above the table. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user as the title above the table. The final text may contain [[Encoded Text\|encoding]].

Rob: New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

2008-12-12T11:15:27Z

New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

:{| class="scripttable"
|class="leftnormal"|Initial Context:
|[[Pick Context|Pick]]
|-
|Alternate Context:
|None
|-
|Fields Finalized?
|Yes
|-
|}

The HeaderTitle script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|Text
|Entry: Contains the empty string.<br>
Exit: Contains the text to be displayed to the user as the title above the table. The final text may contain [[Encoded Text|encoding]].
|-
|}

==Description==

The HeaderTitle script is essentially a special-purpose [[Label Script|Label script]] used in conjunction with tables. This script allows you to synthesize the text to be displayed as a simple header for a table, without all the work of defining a custom template. It display a single line of text, centered within the header region above the table.

The initial context for the script is dictated by the "headerpick" attribute for the table. The engine will locate a pick within the container that is derived from the specified thing, and that will be the starting script context. Aside from that, the HeaderTitle script is a standard Label script.

When used for tables shown on the screen, the header text is centered within the header region and defaults to using a 10-point Arial font in soft white with a bold style. When used within sheet output, the text is centered in the header region with a solid, light-grey background, and it uses a 13-point Arial font in black with a bold style.

{{note}} The HeaderTitle script is read-only. Within this script, virtually all aspects of the structural hierarchy can be accessed, but nothing can be changed.

==Example==

The Skeleton files make extensive use of this mechanism for putting a suitable title above each table. For example, above the table for selecting Special Abilities, the header shows an appropriate title that includes how many selections remain.

<pre>
@text = "Special Ablities: " & hero.child[resAbility].field[resSummary].text
</pre>