TitleBar Script - Revision history

Rob: /* Technical Details */

2009-02-20T08:56:05Z

Technical Details

← Older revision		Revision as of 08:56, 20 February 2009
Line 17:		Line 17:
	\|-		\|-
	\|Procedure Use:		\|Procedure Use:
	\|"titlebar" type, "entity" context		\|"titlebar" type, "entity" context, "container" context
	\|-		\|-
	\|}		\|}

Rob: /* Technical Details */

2009-02-20T08:50:30Z

Technical Details

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

Rob at 00:15, 16 December 2008

2008-12-16T00:15:34Z

← 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:33Z

← 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 default text to display ("Choose an Item from the List Below").<br>		\|(String) Entry: Contains the default text to display ("Choose an Item from the List Below").<br>
	Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text\|encoding]].
	\|-		\|-

Rob at 14:00, 12 December 2008

2008-12-12T14:00:28Z

← 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 default text to display ("Choose an Item from the List Below").<br>		\|Entry: Contains the default text to display ("Choose an Item from the List Below").<br>
	Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text\|encoding]].

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

2008-12-12T10:58:21Z

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

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

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

The TitleBar script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|Text
|Entry: Contains the default text to display ("Choose an Item from the List Below").<br>
Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text|encoding]].
|-
|}

==Description==

The TitleBar script is only used within portals that display a choose form where the user can select an item. At the top of the choose form is a title bar that contains a prompt, directing the user to select an item from the list presented. This script allows an author to specify the exact text to be displayed at the top of the selection table, making it possible to remind the user of the context being selected or how many selections remain.

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

==Example==

When displaying selections where the user can select multiple items, it's helpful to inform the user how many choices remain. This can be easily achieved by a script like the one below.

<pre>
@text = "Add a Special Ablity - " & hero.child[resAbility].field[resSummary].text
</pre>