Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide additional guidance or clean up use of BallotMeasureContest fields #348

Open
indymag opened this issue Oct 20, 2016 · 2 comments
Open

Comments

@indymag
Copy link

indymag commented Oct 20, 2016

BallotMeasureContests have the following fields available directly or inherited through ContestBase

ContestBase::BallotTitle
ContestBase::BallotSubTitle
BallotMeasureContest::SummaryText
(some others as well but there is little ambiguity to their purpose)

The spec should provide additional guidance on the correct use of these fields. Specifically, there is the potential for overlap between the purposes of BallotSubTitle and SummaryText.

@afsmythe
Copy link

afsmythe commented Jan 20, 2020

Presently the VIP docs use the following language for some of the more obvious examples of possible overlapping fields:

ContestBase.Abbreviation: An abbreviation for the contest.
ContestBase.BallotTitle: Title of the contest as it appears on the ballot.
ContestBase.BallotSubTitle: Subtitle of the contest as it appears on the ballot.
BallotMeasureContest.FullText: Specifies the full text of the referendum as it appears on the ballot.
BallotMeasureContest.SummaryText: Specifies a short summary of the referendum that is on the ballot, below the title, but above the text.

This language is very similar to the language from the NIST specification.

Following a review of the VIP feeds provided by participating states, it looks like ContestBase.Abbreviation is usually used to abbreviate ContestBase.BallotTitle and ContestBase.BallotSubTitle is indeed used interchangeably with BallotMeasureContest.SummaryText, although this field's documentation is already explicit that this is a summary of the ballot measure (referendum) content. Unfortunately, there isn't a VIP feed in use which uses all 5 of the fields listed above nor is there an export using each of ContestBase.BallotTitle, ContestBase.BallotSubTitle and BallotMeasureContest.SummaryText. If there is a real world example of all 5 of these fields (including non VIP data) being used then perhaps we could use that data to describe how the VIP record should be generated and include that as part of the XML example.

@afsmythe
Copy link

Punting until we can obtain a real world example of this data's use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants