From b81f07b237602180b8a916010734a78650ac4e1b Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Sun, 17 Mar 2019 21:33:19 +0100 Subject: [PATCH] Bring documentation up to date --- doc/spelling_wordlist.txt | 1 + doc/user/events/display.rst | 13 ++++++ doc/user/events/email.rst | 31 ++++++++++++-- doc/user/events/invoicing.rst | 80 ++++++++++++++++++++++------------- doc/user/events/tickets.rst | 4 ++ 5 files changed, 96 insertions(+), 33 deletions(-) diff --git a/doc/spelling_wordlist.txt b/doc/spelling_wordlist.txt index 8fbefe59bb..f5f6150133 100644 --- a/doc/spelling_wordlist.txt +++ b/doc/spelling_wordlist.txt @@ -10,6 +10,7 @@ availabilities backend backends banktransfer +Bcc boolean booleans cancelled diff --git a/doc/user/events/display.rst b/doc/user/events/display.rst index 2f15496af5..5c821d8262 100644 --- a/doc/user/events/display.rst +++ b/doc/user/events/display.rst @@ -21,11 +21,18 @@ Frontpage text your product types, give more information on the event or for other general notices. You can use :ref:`Markdown syntax ` in this field. +Voucher explanation + This text will be shown above the voucher input box. You can use it to explain how to obtain a voucher and use it. + Show variations of a product expanded by default If this is not checked, a product with variations will be shown as one row in the show by default and will expand into multiple rows once it is clicked on. With this box checked, the variations will be shown as multiple rows right from the beginning. +Ask search engines not to index the ticket shop + If this is checked, we will set a HTML meta attribute asking search engines by Google not to put this ticket shop + into their searchable index. + The lower part of the page contains settings that you can **either** set on organizer-level for all your events **or** override for this single event individually. Those are: @@ -35,6 +42,12 @@ Primary color customers. We suggest not choosing something to light, since text in that color should be readable on a white background and white text should be readable on a background of this color. +Accent color for success + This color will be used for success messages. We suggest to choose a dark shade of green. + +Accent color for errors + This color will be used for error messages. We suggest to choose a dark shade of red. + Font Choose one of multiple fonts to use for your web shop. diff --git a/doc/user/events/email.rst b/doc/user/events/email.rst index 40c830b350..69deafeb93 100644 --- a/doc/user/events/email.rst +++ b/doc/user/events/email.rst @@ -8,8 +8,8 @@ event. :align: center :class: screenshot -The page is separated into three parts: "E-mail settings", "E-mail content" and "SMTP settings". We will explain all -of them in detail on this page. +The page is separated into four parts: "E-mail settings", "E-mail design", "E-mail content" and "SMTP settings". +We will explain all of them in detail on this page. E-mail settings --------------- @@ -30,10 +30,18 @@ Signature This text will be appended to all e-mails in form of a signature. This might be useful e.g. to add your contact details or any legal information that needs to be included with the e-mails. +Bcc address + This email address will receive a copy of every event-related email. + +E-mail design +------------- + +In this part, you can choose and preview the layout of your emails. More layouts can be added by pretix plugins. + E-mail content -------------- -The middle part of the page allows you to customize the exact texts of all e-mails sent by the system automatically. +The next part of the page allows you to customize the exact texts of all e-mails sent by the system automatically. You can click on the different boxes to expand them and see the texts. Within the texts, you can use placeholders that will later by replaced by values depending on the event or order. Below @@ -45,6 +53,7 @@ Placeholder Description ============================== =============================================================================== event The event name total The order's total value +total_with_currency The order's total value with a localized currency sign currency The currency used for the event (three-letter code) payment_info Information text specific to the payment method (e.g. banking details) url An URL pointing to the download/status page of the order @@ -112,6 +121,22 @@ Reminder to download tickets attendees to download their tickets. The e-mail should include a link to the ticket download. This e-mail will only ever be sent if you specify a number of days. +Order approval process + If you configure one of your products to "require approval", orders of that product will not immediately be confirmed + but only after you approved them manually. In this case, the following e-mail templates will be sent out. + + Received order + After an order has been received, this e-mail will be sent automatically instead of the "order placed" e-mail from + above. + + Approved order + This e-mail will be sent after you manually approved an order. This should include instructions to pay for the order, + which is why this will only be used for a paid order. For a free order, the "free order" e-mail from above will + be sent. + + Denied order + This e-mail will be sent out to customers when their order has been denied. + SMTP settings ------------- diff --git a/doc/user/events/invoicing.rst b/doc/user/events/invoicing.rst index 8508e0420c..85dc10c533 100644 --- a/doc/user/events/invoicing.rst +++ b/doc/user/events/invoicing.rst @@ -11,18 +11,6 @@ The settings at "Settings" → "Invoice" allow you to specify if and how pretix In particular, you can configure the following things: -Ask for invoice address - If this checkbox is enabled, customers will be able to enter an invoice address during checkout. If you only enable - this box, the invoice address will be optional to fill in. - -Require invoice address - If this checkbox is enabled, entering an invoice address will be obligatory for all customers and it will not be - able to create an order without entering an address. - -Require customer name - If this checkbox is enabled, the street, city, and country fields of the invoice address will still be optional but - the name field will be obligatory. - Generate invoices This field controls whether pretix should generate an invoice for an order. You have the following options: @@ -51,6 +39,51 @@ Attach invoices to emails "Automatically for all created orders" or to the payment confirmation e-mails if it is set to "Automatically on payment". +Invoice number prefix + This is the prefix that will be prepended to all your invoice numbers. For example, if you set this to "Inv", your + invoices will be numbered Inv00001, Inv00002, etc. If you leave this field empty, your event slug will be used, + followed by a dash, e.g. DEMOCON-00001. + + Within one organizer account, events with the same number prefix will share their number range. For example, if you + set this to "Inv" for all of your events, there will be only one invoice numbered Inv00007 across all your events + and the numbers will have gaps within one event. + +Generate invoices with consecutive numbers + If enabled, invoices will be created with numerical invoice numbers in the order of their creation, i.e. + PREFIX-00001, PREFIX-00002, and so on. If disabled, invoice numbers will instead be generated from the order code, + i.e. PREFIX-YHASD-1. When in doubt, keep this option enabled since it might be legally required in your country, + but disabling it has the advantage that your customers can not estimate the number of tickets sold by looking at + the invoice numbers. + +Invoice language + This setting allows you to configure the language of all invoices. You can either set it to one of your event + language or dynamically to the language used by the customer. + +Show free products on invoices + If enabled, products that do not cost anything will still show up on invoices. Note that the order needs to contain + at least one non-free product in order to generate an invoice. + +Show attendee names on invoices + If enabled, the attendee name will be printed on the invoice for admission tickets. + +Ask for invoice address + If this checkbox is enabled, customers will be able to enter an invoice address during checkout. If you only enable + this box, the invoice address will be optional to fill in. + +Require invoice address + If this checkbox is enabled, entering an invoice address will be obligatory for all customers and it will not be + able to create an order without entering an address. + +Require customer name + If this checkbox is enabled, the street, city, and country fields of the invoice address will still be optional but + the name field will be obligatory. + +Require a business address + If enabled, the invoice address form will require a company name and do not allow personal addresses. + +Ask for beneficiary + If enabled, the invoice address form will contain an additional field to input the beneficiary of the transaction. + Ask for VAT ID If enabled, the invoice address form will not only ask for a postal address, but also for a VAT ID. The VAT ID will always be an optional field. @@ -62,26 +95,13 @@ Generate invoices with consecutive numbers but disabling it has the advantage that your customers can not estimate the number of tickets sold by looking at the invoice numbers. -Invoice number prefix - This is the prefix that will be prepended to all your invoice numbers. For example, if you set this to "Inv", your - invoices will be numbered Inv00001, Inv00002, etc. If you leave this field empty, your event slug will be used, - followed by a dash, e.g. DEMOCON-00001. - - Within one organizer account, events with the same number prefix will share their number range. For example, if you - set this to "Inv" for all of your events, there will be only one invoice numbered Inv00007 across all your events - and the numbers will have gaps within one event. - -Show free products on invoices - If enabled, products that do not cost anything will still show up on invoices. Note that the order needs to contain - at least one non-free product in order to generate an invoice. - -Show attendee names on invoices - If enabled, the attendee name will be printed on the invoice for admission tickets. - -Your address - This should be set to the address of the entity issuing the invoice (read: you) and will be printed inside +Your invoice details + These fields should be set to the address of the entity issuing the invoice (read: you) and will be printed inside the header of the invoice. +Invoice style + This setting allows you to choose the design of your invoice. Additional designs can be added by pretix plugins. + Introductory text A free custom text that will be printed above the list of products on the invoice. diff --git a/doc/user/events/tickets.rst b/doc/user/events/tickets.rst index d3c35fdece..cccc8a8093 100644 --- a/doc/user/events/tickets.rst +++ b/doc/user/events/tickets.rst @@ -25,6 +25,10 @@ Generate tickets for non-admission products By default, tickets will only be generated for products that are marked as admission products. Enable this option to generate tickets for all products instead. +Offer to download tickets even before an order is paid + By default, ticket download is only possible for paid orders. If you run an event where people usually pay only after + the event, you can check this box to enable ticket download even before. + Below these settings, the detail settings for the various ticket file formats are offered. They differ from format to format and only share the common "Enable" setting that can be used to turn them on. By default, pretix ships with a PDF output plugin that you can configure through a visual design editor. \ No newline at end of file