Skip to content

Commit

Permalink
✨ Voting-booth: Improve election info in the ballot ticket PDF for pa…
Browse files Browse the repository at this point in the history
…rent-children elections (#135)

Parent issue: sequentech/epi#112
  • Loading branch information
Findeton committed Sep 20, 2023
1 parent 90ca800 commit 1553f2f
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/general/reference/election-creation-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -1087,6 +1087,7 @@ to download the ballot ticket PDF.
- [`success_screen__ballot_ticket__logo_subheader`](#election-presentation-options-success_screen__ballot_ticket__logo_subheader)
- [`success_screen__ballot_ticket__h3`](#election-presentation-options-success_screen__ballot_ticket__h3)
- [`success_screen__ballot_ticket__h4`](#election-presentation-options-success_screen__ballot_ticket__h4)
- [`success_screen__ballot_ticket__show_election_id`](#election-presentation-options-success_screen__ballot_ticket__show_election_id)

If set, this optional property will modify the voting booth behaviour and the
success screen will not show the link to download the ballot ticket PDF. This
Expand All @@ -1105,6 +1106,7 @@ option does not hide the ballot tracker hash nor the QR code to the ballot
- [`success_screen__ballot_ticket__logo_subheader`](#election-presentation-options-success_screen__ballot_ticket__logo_subheader)
- [`success_screen__ballot_ticket__h3`](#election-presentation-options-success_screen__ballot_ticket__h3)
- [`success_screen__ballot_ticket__h4`](#election-presentation-options-success_screen__ballot_ticket__h4)
- [`success_screen__ballot_ticket__show_election_id`](#election-presentation-options-success_screen__ballot_ticket__show_election_id)

If set, this optional property will modify the heading logo that appears next
in the PDF ballot ticket that the voter can download from the voting booth
Expand All @@ -1129,6 +1131,7 @@ PDF.
- [`success_screen__ballot_ticket__logo_subheader`](#election-presentation-options-success_screen__ballot_ticket__logo_subheader)
- [`success_screen__ballot_ticket__h3`](#election-presentation-options-success_screen__ballot_ticket__h3)
- [`success_screen__ballot_ticket__h4`](#election-presentation-options-success_screen__ballot_ticket__h4)
- [`success_screen__ballot_ticket__show_election_id`](#election-presentation-options-success_screen__ballot_ticket__show_election_id)

If set, this optional property will modify the heading text that appears next
to the header logo in the PDF ballot ticket that the voter can download from
Expand All @@ -1151,6 +1154,7 @@ in the same position in the ballot ticket PDF.
- [`success_screen__ballot_ticket__logo_header`](#election-presentation-options-success_screen__ballot_ticket__logo_header)
- [`success_screen__ballot_ticket__h3`](#election-presentation-options-success_screen__ballot_ticket__h3)
- [`success_screen__ballot_ticket__h4`](#election-presentation-options-success_screen__ballot_ticket__h4)
- [`success_screen__ballot_ticket__show_election_id`](#election-presentation-options-success_screen__ballot_ticket__show_election_id)

If set, this optional property will modify the subheading text that appears next
to the header logo in the PDF ballot ticket that the voter can download from the
Expand All @@ -1173,6 +1177,7 @@ in the same position in the ballot ticket PDF.
- [`success_screen__ballot_ticket__logo_header`](#election-presentation-options-success_screen__ballot_ticket__logo_header)
- [`success_screen__ballot_ticket__logo_subheader`](#election-presentation-options-success_screen__ballot_ticket__logo_subheader)
- [`success_screen__ballot_ticket__h4`](#election-presentation-options-success_screen__ballot_ticket__h4)
- [`success_screen__ballot_ticket__show_election_id`](#election-presentation-options-success_screen__ballot_ticket__show_election_id)

If set, this optional property will modify the title of the ballot ticket
that appears below the header logo in the PDF ballot ticket that the voter can
Expand All @@ -1194,6 +1199,7 @@ By default, if this optional property is not set, then an i18n string saying
- [`success_screen__ballot_ticket__logo_header`](#election-presentation-options-success_screen__ballot_ticket__logo_header)
- [`success_screen__ballot_ticket__logo_subheader`](#election-presentation-options-success_screen__ballot_ticket__logo_subheader)
- [`success_screen__ballot_ticket__h3`](#election-presentation-options-success_screen__ballot_ticket__h3)
- [`success_screen__ballot_ticket__show_election_id`](#election-presentation-options-success_screen__ballot_ticket__show_election_id)

If set, this optional property will modify the text of the ballot ticket
that appears below the title of the PDF ballot ticket that the voter can
Expand All @@ -1203,6 +1209,27 @@ By default, if this optional property is not set, then an i18n string saying
`Your vote has been cast correctly. This document justifies its issuance.`
will appear in the same position in the ballot ticket PDF.

### Election Presentation Options: `success_screen__ballot_ticket__show_election_id`

- **Property name**: `success_screen__ballot_ticket__show_election_id`
- **Type:** `Boolean`
- **Required:** No
- **Default:** -
- **Example:** `true`
- **Related:**
- [`success_screen__hide_download_ballot_ticket`](#election-presentation-options-success_screen__hide_download_ballot_ticket)
- [`success_screen__ballot_ticket__logo_url`](#election-presentation-options-success_screen__ballot_ticket__logo_url)
- [`success_screen__ballot_ticket__logo_header`](#election-presentation-options-success_screen__ballot_ticket__logo_header)
- [`success_screen__ballot_ticket__logo_subheader`](#election-presentation-options-success_screen__ballot_ticket__logo_subheader)
- [`success_screen__ballot_ticket__h3`](#election-presentation-options-success_screen__ballot_ticket__h3)
- [`success_screen__ballot_ticket__h4`](#election-presentation-options-success_screen__ballot_ticket__h4)

If set, this optional property will include the election id in the PDF ballot
ticket that the voter can download from the voting booth success screen.

By default, if this optional property is not set, thus the election id doesn't
appear in the PDF ballot ticket.

### Election Presentation Options: `success_screen__redirect__url`

- **Property name**: `success_screen__redirect__url`
Expand Down

0 comments on commit 1553f2f

Please sign in to comment.