Elections Player Tags

The following scene and tag naming conventions are solely for the Chameleon Elections Player. For scene and tag naming conventions for the Elector Player, please refer to the following document: Elector Player Tags.

SCENE NAMES
Scene names must start with the text indicated on the left column (except for 'Other'). To ignore a scene, start the scene's name with a '!', e.g. '!Name (Contest) Ignore me'. To hide a scene from the Rundown Builder module in Chameleon Flow, append ‘{hidden}’ to the scene name. E.g., ‘Contest No Show in Flow {hidden}’. Note that the Name part of the scene name can be anything you want except for the ‘(', ‘)', ‘{’ and '}’ characters.
Name (Contest) or Name (Area) or Name (Riding) or Contest Name or Area Name or Riding Name	The scene name for a Contest type. Showcasing results from a race (contest).
Name (Choice) or Name (Candidate) or Choice Name or Candidate Name	The scene name for a Choice type. Showcasing information about individuals (or Parties treated as individual entities).
Name (Party) or Party Name	A scene of type Party. Showcasing information about Parties.
Name (Ticker) or Name (Crawl) or Ticker Name or Crawl Name	The scene name for a Ticker or Crawl type.
Background Name	A scene with no active tags of type Background. These will be listed in the Elections Player drop-downs for backgrounds.
Bug Name	This is an Other scene type but is treated specially in the Ticker tab in the Elections Player where scenes of this type fills the drop-down control for the Bug section.
Sponsor Name	This is an Other scene type but is treated specially in the Ticker tab in the Elections Player where scenes of this type fills the drop-down control for the Sponsor section.
Other	All other scenes with names that don't start with the above names nor a '!'.

CHOICE / CANDIDATE TAGS
These tags are only available for CONTEST and CHOICE scenes. Add [#] for additional Choices. ex: ^choice[1].name for 2nd choice’s name. ^choice.name is the same as ^choice[0].name. Note: [0] refers to the leading candidate for the election area that the candidate belongs to.
^choice[#].firstname	The first name of the candidate (ex: John). [#] = Position of candidate in the race where [0] is the leading candidate. Tag is a Text object.
^choice[#].lastname	The last name of the candidate (ex: Smith). Tag is a Text object.
^choice[#] or ^choice[#].name	The full name of the candidate (ex: John Smith). Tag is a Text object.
^choice[#].custom <custom name format>	Customize the display of a candidate’s name. Note that the angle brackets characters < > are required. The available custom name format tags are: {firstname} {lastname} {name} {firstinitial} {firstletter} {incumbent} {elected} {partyname} {partyaltname} {partycode} {votes}. Tag is a Text object. Examples: <{lastname}, {firstname}> will display a candidate’s name as: ‘Smith, John'. <{name} {incumbent}> will display as: ‘John Smith [i]'. The ‘[i]' to represent an incumbent is set up in the Player Preferences. If not an incumbent, the ‘[i]’ will be absent. <{firstinitial} {lastname}> will display as: ‘J. Smith’. <{firstletter} {lastname}> will display as: ‘J Smith’.
^choice[#].media	An image representing the candidate. Tag is a graphics object.
^choice[#].details	Details about the candidate. Limited to 255 characters. Tag is a Text object.
^choice[#].winner	A Visible tag object. Visible if the candidate is elected. Tag can be a Text or Graphics object.
^choice[#].incumbent	A Visible tag object. Visible if the candidate is the incumbent for the office. Tag can be a Text or Graphics object.
^choice[#].acclaimed	A Visible tag object. Visible if the candidate is a winner for the office by acclaim. Tag can be a Text or Graphics object.
^choice[#].votes% or ^choice[#].vote% or ^choice[#].percentage ^choice[#].percentagetext	The percentage of votes for the candidate. Tag is a Text object. See note about the Percent Sign '%' below. If the ^choice[#].percentagetext tag is used, the '%’ sign will be forcibly shown. See note about Percentage Decimal Places below.
^choice[#].votes	The number of votes received for the candidate. Tag is a Text object.
^choice[#].votesPrevious	The number of votes received for the candidate in the event prior to the current elections event. Tag is a Text object.
^choice[#].votesPrevious%	The percentage of votes for the candidate in the event prior to the current elections event. Tag is a Text object. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.
^choice[#].votesdiff or ^choice[#].votediff	The difference in votes received by the candidate for the current and previous elections event. Tag is a Text object.
^choice[#].votesdiff% or ^choice[#].votediff%	The difference in vote percentages for the candidate for the current and previous elections event. Tag is a Text object. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.
^choice[#].voteslead	The number of votes that the candidate has as a lead over the next candidate. Tag is a Text object. Only available for Contest scenes.
^choice[#].contestType	The type name of the contest that the candidate participated in. Tag is a Text object.
^choice[#].eligiblevotes	The number of eligible votes for the contest that the candidate participated in. Tag is a Text object.
^choice[#].eevp Deprecated: ^choice[#].popvotes%	The Estimated Expected Vote Percentage (EEVP) for the contest that the candidate participated in. Tag is a Text object. In its deprecated usage, the ^choice[#].popvotes% tag was used to show the assigned popular votes percentage for a contest. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.
^choice[#].popvotesPrevious%	The percentage of popular votes for the contest in the event prior to the current elections event that the candidate participated in (the ‘candidate’ is likely a Party). Tag is a Text object. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.
^choice[#].popTotalVotes	The number of popular votes for the contest that the candidate participated in (the ‘candidate’ is likely a Party). Tag is a Text object.
^choice[#].seats%	The percentage of seats for the candidate (the ‘candidate’ is likely a Party). Tag is a Text object. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.
^choice[#].seats	The number of seats received by the candidate (the ‘candidate’ is likely a Party). Tag is a Text object.
^choice[#].seatsPrevious	The number of seats received by the candidate (the ‘candidate’ is likely a Party) for the event prior to the current elections event. Tag is a Text object.
^choice[#].seatsPrevious%	The percentage of seats for the candidate (the ‘candidate’ is likely a Party) in the event prior to the current elections event. Tag is a Text object. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.
^choice[#].seatsdiff	The difference in seats received by the candidate (the ‘candidate’ is likely a Party) for the current and previous elections event. Tag is a Text object.
^choice[#].seatsdiff%	The difference in seat percentages for the candidate (the ‘candidate’ is likely a Party) for the current and previous elections event. Tag is a Text object. See note about the Percent Sign '%' below. See note about Percentage Decimal Places below.

PARTY TAGS

Add [#] for additional Parties. ex: ^choice[1].party.name is the name for the 2nd party. ^choice.party.name is the same as ^choice[0].party.name.

^choice[#].party.name

The full name of a party. (ex: Republican Party, Democratic Party, Liberal Party, Conservative Party, etc.) Tag is a Text object.

Available for Party, Choice and Contest scenes.

^choice[#].party.altname

The alternative name of a party. Tag is a Text object.

Available for Party, Choice and Contest scenes.

^choice[#].party or ^choice[#].party.code

The short name or acronym for the party. (ex: GOP for the Republicans, DEM for the Democrats) Tag is a Text object.

Available for Party, Choice and Contest scenes.

^choice[#].party.colour or ^choice[#].party.color

Changes the diffuse colour for the material assigned to a graphics object based on a specified string value that is the hex format of a colour assigned the the Party. The hex format for a colour should specify either the RGB values or ARGB values, e.g., ‘#FF0000’ for the saturated red colour (without specifying the alpha value), or ‘#7D00FF00’ for saturated green colour with an alpha value of hex 7D (i.e., decimal 125). Note that the starting '#' character is optional. If the alpha value is not specified, the current alpha value of the material will be retained. Tag is a Graphics object.

Available only for Elections Player for XPression - for Party, Choice and Contest scenes.

Requires Elections Player for XPression v6.0.0.84 or higher. Only works with XPression 10.5 build 5508 or later.

^choice[#].party.colourvalue or ^choice[#].party.colorvalue

Sets the text to the hex formatted value of the colour assigned to the Party. For more information regarding the hex formatted colours, see the description for the ^choice[#].party.colour tag. Tag is a Text object.

Available for Party, Choice and Contest scenes.

Requires Elections Player for XPression v6.0.0.84 or higher. For Elections Player for Web, requires v6.0.0.67 or higher.

^choice[#].party.media

^choice[#].party.media <prefix>

The graphics logo for the party. The <prefix> portion of the tag is optional. Note: when using files as a source for replacement logos, it is always best specify a prefix. The reason is that there are certain file names in the Windows operating system that are reserved. For example, ‘CON’ and ‘LPT’ can’t be used even when paired with file extensions. Tag is a Graphics object.

Elections Player for XPression:

In the absence of the <prefix> part, the player looks for an XPression material that is named based on the party code. The name of the material that is assigned to the Quad at design time determines the format of the name of the replacement materials that can be used for replacement on output. The format of the materials is: prefixPARTYCODE. For example: during design time, the material assigned is named ‘logoLIB’ and during output the party should be ‘CON’, then the player will look for a replacement material that is named ‘logoCON’.
When the <prefix> part is specified as part of the tag’s name, the source of the logo will be from a file that is in the Logos folder (specified in the Elections Player’s Preferences) instead of another XPression material. The file prefix specifies what the prefix of the logo filename to look for on output. For example: we have a tag ^choice[0].party.media <logo> and the party on output is ‘CON’, then the player will look for a logo file that is named ‘logoCON.png'. The extension can be of any image type that is supported by XPression, e.g., .png, .jpg, .bmp. Note that the search for a matching file is case insensitive, i.e., ‘logocon.png’ or 'LogoCon.Jpg' will also work.

Elections Player for Web:

In Elections Player for Web, the player always looks for a logo file located in the Logos folder.
In the absence of the <prefix> part, the player looks for a file with a name that is the party code. For example: on output, the party of interest is ‘LIB’, then player will look for a file named ‘LIB.png’. The type of image (and hence, the extension of the file) can be of any valid image type, e.g., .png, .jpg, .bmp, etc. The search for the logo filename is case insensitive, i.e., ‘lib.png' or ‘Lib.PNG’ will also work.
When the <prefix> part is specified as part of the tag’s name, the player will look for a file that name has the following format: prefixPARTYCODE.ext. For example: the desired party code on output is ‘CON', ^choice[0].party.media <logo> is the tag and the prefix is ‘logo’, then the player will search for a logo file named ‘logoCON.jpg’. Again, the search is case insensitive and the file extension can be from any valid image file type, e.g., .png, .jpg, .bmp.

Available for Party, Choice and Contest scenes.

^choice[#].party.leading

The number of seats/ridings is leading in votes (but not elected). Tag is a Text object.