The following scene and tag naming conventions are solely for the Elector Player. For scene and tag naming conventions for the Chameleon Elections Player, please refer to the following document: https://bannisterlake.atlassian.net/wiki/pages/resumedraft.action?draftId=811892743 .
SCENE NAMES | |
---|---|
Scene names must start with the text indicated on the left column (except for 'Other'). Note that the Name part of the scene name can be anything you want except for the ‘(', ‘)', ‘{’ and '}’ characters. | |
Name (Area) or Name (Riding) or Area Name or Riding Name | The scene name for a Riding or Area type. Showcases voting results from an election area. |
Name (Choice) or Name (Candidate) or Choice Name or Candidate Name | The scene name for a Candidate or Choice type. Showcases information about individuals. |
Name (Party) or Party Name | A scene of type Party. Showcasing information about parties. |
PartyMap Name | A scene of type Party and sub-type of Map. Showcases information about election areas being won by particular parties in a map form. |
PartySummary <options> Name | A scene of type PartySummary. Showcases information about Party votes, vote percentages and vote percentage differences for a Region based on the the current Event, it’s Dissolution Event and the immediate previous Elections event. The options are optional but if present must be contained within the angle bracket characters and separated by a ‘|' character. Note that this is a special type of a Party scene where all parties will be listed (depending on the options below) irrespective of whether the 'Group Non-Main Parties’ setting is set or not. The following options are available:
Example of scene with compound options: PartySummary <MaxVote%=20.5|ShowMainParties=1|ShowNoVoteParties=1>. Requires Elector Player for XPression v6.0.0.43 or higher or Elector Player for Web v6.0.0.22 or higher. |
Name (Summary) <filter> or Summary <filter> Name | A scene of type Summary. Showcasing summary of voting results for areas belonging to a region filtered by some conditions (e.g., Incumbents losing, Party retaining seat). The filters are similar to the ones that you see in Elector Flow in the Riding Results Summary module.
|
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 Player drop-downs for backgrounds. |
Bug Name | This is an Other scene type but is treated specially in the Ticker tab in the Elector 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 Elector Player where scenes of this type fills the drop-down control for the Sponsor section. |
Widget Name or Time Name | This is an Other scene type but is treated specially in the Ticker tab in the Elector Player where scenes of this type fills the drop-down control for the Widget section. These scene types are only supported by Elector Player for XPression (v6.0.0.64 and later) and are not available for Elector Player for Web. |
Other | All other scenes with names that don't start with the above names nor a '!'. |
CHOICE / CANDIDATE TAGS | |
---|---|
Add [#] for additional Choices. ex: ^choice[1].name for 2nd choice’s name. ^choice.name is the same as ^choice[0].name. | |
^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. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].lastname | The last name of the candidate (ex: Smith). Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#] or ^choice[#].name | The full name of the candidate (ex: John Smith). Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].custom <custom name format> | Customize the display of a candidate’s name. Note that the angle brackets characters < > are required. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. The available name format tags are: {firstname} {lastname} {firstinitial} {incumbent} {elected} {partycode} {votes} {vote%}. |
^choice[#].media | An image representing the candidate. Tag is a Graphics object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].details | Details about the candidate. Limited to 255 characters. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].winner | A Visible tag object. Visible if the candidate is elected. Tag can be a Text or Graphics object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].incumbent | A Visible tag object. Visible if the candidate is the incumbent for the office. Tag can be a Text or Graphics object. Available for Choice/Candidate and Area/Riding scenes. |
^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. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].vote% or ^choice[#].percentage | The percentage of votes for the candidate. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. **See note about the Percent Sign '%' below. If the ^choice.percentagetext or ^summary[#].choice[#].percentagetext tag is used, the '%’ sign will be forcibly shown. |
^choice[#].votes | The number of votes received for the candidate. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].voteslead | The number of votes that the candidate has as a lead over the next nearest candidate in the same election area. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].voteslead% | The number of votes that a candidate has as a lead over the next nearest candidate as a percentage of the total votes in the election area that the candidates belong to. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. **See note about the Percent Sign '%' below. |
^choice[#].voteslose | The number of votes that the candidate is losing by as compared to that of the leading candidate in the same election area has. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. |
^choice[#].voteslose% | The number of votes that the candidate is losing by as compared to that of the leading candidate as a percentage of the total votes in the election area that the candidates belong to. Tag is a Text object. Available for Choice/Candidate and Area/Riding scenes. **See note about the Percent Sign '%' 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 the party. (ex: Republican Party, Democratic Party, Liberal Party, Conservative Party, etc.) Tag is a Text object. Available for Party, Choice/Candidate and Area/Riding 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 Elector Player for XPression - for Party, Choice/Candidate and Area/Riding scenes. Requires Elector Player for XPression v6.0.0.25 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/Candidate and Area/Riding scenes. Requires Elector Player for XPression v6.0.0.25 or higher. For Elector Player for Web, requires v6.0.0.9 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. Elector Player for XPression:
Elector Player for Web:
Available for Party, Choice/Candidate and Area/Riding 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/Candidate and Area/Riding scenes. |
^choice[#].party.leading | The number of seats/ridings is leading in votes (but not elected). Tag is a Text object. Available only for Party scenes. |
^choice[#].party.elected | The number of seats/ridings that a party has won (elected or acclaimed). Tag is a Text object. Available only for Party scenes. |
^choice[#].party.total ^choice[#].party.total.prev[#] | The number of seats/ridings that a party is leading in or has won in the current election event. Tag is a Text object. For the .prev[#] tag, the number of seats/ridings that a party has won in a previous election event is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’. The previous events must be similar in terms of geographic and political purposes, e.g., Canadian Federal elections or U.S. Presidential elections on different years. Available only for Party scenes. |
^choice[#].party.total% ^choice[#].party.total%.prev[#] | The percentage of seats/ridings that a party is leading or elected in the current election event. Tag is a Text object. For the .prev[#] tag, the percentage of seats/ridings that a party was elected in previous election events is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. **See note about the Percent Sign '%' below. |
^choice[#].party.totaldiff ^choice[#].party.totaldiff.prev[#] | The number of seats/ridings that a party is gaining or losing in the current event as compared to the previous election event immediately before the current event. Tag is a Text object. For the .prev[#] tag, the comparison is done for the current event against the previous event specified by the index in the '[#] part. The ‘[#]’ is optional and if missing is the same as ‘[0]’, i.e., basically the same as the tag without the .prev[#] part. Available only for Party scenes. |
^choice[#].party.electedhasvotes | The number of seats/ridings with votes that a party has been declared elected in for a region or all regions in the current event. Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. |
^choice[#].party.leadinghasvotes | The number of seats/ridings with votes that a party is leading in but not elected in for a region or all regions in the current event. Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. |
^choice[#].party.totalhasvotes | The number of seats/ridings with votes that a party is leading in or is elected in for a region or all regions in the current event. Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. |
^choice[#].party.seatshasvotes | The number of seats/ridings with votes for a region or all regions in the current event. Tag is a Text object. Available only for Party scenes. |
^choice[#].party.totalhasvotes% | The percentage of seats/ridings with votes that a party is leading in or is elected in for a region or all regions the current event. Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. **See note about the Percent Sign '%' below. |
^choice[#].party.totalprevhasvotes | The number of seats/ridings with votes that a party is leading in or is elected in for a region or all regions in the previous event (i.e., using the assigned incumbent party). Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. |
^choice[#].party.totalprevhasvotes% | The percentage of seats/ridings with votes that a party is leading in or is elected in for a region or all regions in the previous event (i.e., using the assigned incumbent party). Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. **See note about the Percent Sign '%' below. |
^choice[#].party.totaldiffhasvotes | The number of seats/ridings with votes that a party is gaining or losing in for a region or all regions in the current event as compared to the previous election event. Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. |
^choice[#].party.totaldiffhasvotes%
| The percentage of seats/ridings with votes that a party is gaining or losing in for a region or all regions in the current event as compared to the previous election event. Note that this only works for the current event and when the incumbent party for each election area (in the current event) is set appropriately. Tag is a Text object. Available only for Party scenes. **See note about the Percent Sign '%' below. |
^choice[#].party.votes ^choice[#].party.votes.prev[#] | The number of votes for the party in the current election event. Tag is a Text object. For the .prev[#] tag, the number of votes for the party in a previous election event is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. |
^choice[#].party.vote% or ^choice[#].party.percentage
^choice[#].party.vote%.prev[#] | The percentage of votes for the party. Tag is a Text object. For the .prev[#] tag, the percentage of votes for the party in a previous election event is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. **See note about the Percent Sign '%' below. If the ^choice.party.percentagetext tag is used, the '%’ sign will be forcibly shown. |
^choice[#].party.votediff ^choice[#].party.votediff.prev[#] | The difference in the number of votes that a party has for the current event as compared to a previous election event. Tag is a Text object. For the .prev[#] tag, the # value indicates the index of the previous event to use as a comparison from the list of previous events defined via the Elections Settings dialog in the Elector Player UI. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. |
^choice[#].party.votediff% ^choice[#].party.votediff%.prev[#] | The difference in the popular vote percentage that a party has for the current event as compared to a previous election event. Tag is a Text object. For the .prev[#] tag, the # value indicates the index of the previous event to use as a comparison from the list of previous events defined via the Elections Settings dialog in the Elector Player UI. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. **See note about the Percent Sign '%' below. |
^choice[#].party.voteseligible ^choice[#].party.voteseligible.prev[#] | The maximum number of eligible votes possible for the specified region of the election event. Tag is a Text object. For the .prev[#] tag, the # value indicates the index of the previous event to use. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. |
^choice[#].party.seatseligible ^choice[#].party.seatseligible.prev[#] | The seats possible for the specified region of the election event. Tag is a Text object. For the .prev[#] tag, the # value indicates the index of the previous event to use. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Available only for Party scenes. |
POLL TAGS | |
---|---|
For SUMMARY scenes, add [#] for additional Summaries. ex: ^summary[1].polls.total is the total polls for the 2nd summary. ^summary.polls.total is the same as ^summary[0].polls.total. | |
^choice.polls.percentage or ^choice.polls.% | The percentage of polls reporting for the election area. Tag is a Text object. For Area/Riding and Party scenes, use the tags as shown since there is only a single polls info specified for the scene. **See note about the Percent Sign '%' below. If the ^choice.polls.percentagetext or ^summary[#].polls.percentagetext tag is used, the '%’ sign will be forcibly shown. |
^choice.polls.reported | The number of polls which have been reported for the election area. Tag is a Text object. For Area/Riding and Party scenes, use the tag as shown since there is only a single polls info specified for the scene. |
^choice.polls.total | The total number of polls available for the election area. Tag is a Text object. For Area/Riding and Party scenes, use the tag as shown since there is only a single polls info specified for the scene. |
^choice.polls.custom <custom polls format> | Customize the display of polling information. Note that the angle brackets characters < > are required. Tag is a Text object. For Area/Riding and Party scenes, use the tag as shown since there is only a single polls info specified for the scene. The available poll format tags are: {polls} {polls%} {totalpolls}. |
EVENT TAGS | |
---|---|
If available, add [#] for additional Events or Summaries. ex: ^choice[1].event.date is the name for the 2nd event. ^choice.event.date is the same as ^choice[0].event.date. | |
^choice.event.date | The date for the election event. Tag is a Text object. For Area/Riding and Party scenes, use the tag as shown since there is only a single event specified for the scene. |
^choice.event.date.prev[#] | The date for a previous election event. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Tag is a Text object. Available only for Party scenes. |
^choice.event.year | The year of the election event. Tag is a Text object. For Area/Riding and Party scenes, use the tag as shown since there is only a single event specified for the scene. |
^choice.event.year.prev[#] | The year for a previous election event. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Tag is a Text object. Available only for Party scenes. |
^choice.event or ^choice.event.name | The name of the election event. Tag is a Text object. For Area/Riding and Party scenes, use the tags as shown since there is only a single event specified for the scene. |
^choice.event.name.prev[#] | The name of the previous election event. The ‘[#]’ is optional and if missing is the same as ‘[0]’. Tag is a Text object. Available only for Party scenes. |
AREA TAGS | |
---|---|
If available, add [#] for additional Choices or Summaries. ex: ^choice[1].area.name is the name for the 2nd area. ^choice.area.name is the same as ^choice[0].area.name. | |
^choice.area or ^choice.area.name | The name of the election area (ex: Region or Riding) Tag is a Text object. For Party and Area/Riding scenes, use the tags as shown since there is only a single area specified for the scene. |
^choice.region | The name of the election Region. Tag is a Text object. For Area/Riding scenes, this provides the name of the region that the area/riding belongs to. |
^choice.area.nameline1 | The area/riding name that is split into 2 lines. This is for use with graphics that are too short to hold the entire name of the riding in a single line. The 2 lines of text are assigned using Elector Flow. Tags are Text objects. For Area/Riding scenes, use the tags as shown since there is only a single area specified for the scene. |
^choice.area.ID | An numeric value assigned as the ID for an area/riding. This ID is usually provided by the datafeed. In the absence of a datafeed ID, the database record number is used instead. Tag is a Text object. For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene. |
^choice.area.details | Details about the area/riding. Tag is a Text object. For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene. |
^choice.area.electors | The number of electors available for the area/riding. Tag is a Text object. For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene. |
^choice.area.mailballots | The number of mail-in ballots submitted for the area/riding. Tag is a Text object. For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene. |
^summary[#].area.totalvotes | The total number of votes in the area/riding for summary [#]. Tag is a Text object. Only for Summary scenes. |
^summary[#].area.partyincumbent or ^summary[#].area.partyincumbent.code | The short name or acronym for the party that won the area/riding prior to the current election event. Tag is a Text object. Only for Summary scenes. |
^summary[#].area.partyincumbent.name | The full name of the party that won the area/riding prior to the current election event. Tag is a Text object. Only for Summary scenes. |
TEXT CAPTIONS | |
---|---|
This tag is available for all scene types except BACKGROUND scenes. Add [#] for additional Captions. ex: ^caption[1].label for the 2nd text caption. ^caption.label is the same as ^caption[0].label | |
^caption.label | Text caption with optional label to show in the Elector Player and the Elector Flow Playlist Builder module. Tag is a Text object. |
TICKER TAGS | |
---|---|
These tags are only available for TICKER scenes. | |
^story or ^content or ^story.content | Contents of an RSS News item. Tag is a Text object. |
^header or ^story.header | Title of an RSS News item. Tag is a Text object. |
SPECIAL TAGS | |
---|---|
### | Each election area or riding's representative graphic element for use in a party map. Each riding is marked with the colour of the party's candidate who is in the lead or who is elected. Otherwise, the riding is black (or whatever colour is designated as being vacant in the project). The tag should be in a 3 digit format (e.g., 001). Tags are Graphics objects. Only for PartyMap scenes. |
**Percentage Decimal Places: By default, the number of decimal places shown for the percentage will depend on the text assigned to the object at design time. For example, if the text in the tag at design time is ‘0.00’ then on output, the percentage value will also show 2 decimal places back filled with ‘0’s. This feature is controlled by an option in the Elector Player’s Preference settings.
**Percent Sign: If there’s a '%' in the text assigned to the object at design time, the % sign will appear at the end of the number. This feature is controlled by an option that can be disabled in the Elector Player’s Preference settings.