janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2026-03-14 07:00:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Janis Hutz
2024-05-24 09:50:23 +02:00
parent 284f96a42d
commit 8e127a1cb5
44 changed files with 280 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/src/admin-panel/events.md
View File

@@ -11,4 +11,4 @@ This is the name that is being displayed when users are browsing your events. Ca
Describe what your event is about. It will be displayed underneath the event name when users are browsing your events. In the browsing view, the length of the description is limited to 150 characters, after which three dots will be added to the text and a 'continue reading' button will be added. Technically, there's no limit to the length of the event description, but don't overdo it with the length, as the user is unlikely to read more than a couple words anyway.
### Event location
Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide [here](&/admin-panel/seatplan-editor)
Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using our handy seat plan editor. See our seat plan editor guide [here](&/admin-panel/seatplan-editor)

2
website/src/admin-panel/locations.md
View File

@@ -1,3 +1,3 @@
# Locations
libreevent allows you to create an infinite amount of locations where you can host events in. These locations all can have a seat plan - or not. This is entirely your choice. You may use libreevent's powerful seat plan editor to edit the seat plan if you choose to add one. All of the locations can be assigned to one or multiple events such that you do not waste any time creating seat plans when it is not necessary.
libreevent allows you to create an infinite amount of locations where you can host events in. These locations all can have a seat plan - or not. This is entirely your choice. You may use libreevent's powerful seat plan editor to edit the seat plan if you choose to add one. All the locations can be assigned to one or multiple events such that you do not waste any time creating seat plans when it is not necessary.

2
website/src/admin-panel/pages.md
View File

@@ -1,3 +1,3 @@
# Pages
With the page editor you can easily create the start page (the landing page, so the page that gets displayed when the user visits the website). You may select one of a few templates which you can choose [here](/templates). Then you should upload the promotional text and a few images. The image count depends on the template selected. If you want to use a more feature rich start page, you can create a custom HTML start page. If you need even more customization, please consider moving libreevent to a sub-domain and building a complete website on the main domain. You can get beautiful fully custom websites built for you [here](https://development.janishutz.com).
With the page editor you can easily create the start page (the landing page, so the page that gets displayed when the user visits the website). You may select one of a few templates which you can choose [here](/templates). Then you should upload the promotional text and a few images. The image count depends on the template selected. If you want to use a more feature rich start page, you can create a custom HTML start page. If you need even more customization, please consider moving libreevent to a subdomain and building a complete website on the main domain. You can get beautiful fully custom websites built for you [here](https://development.janishutz.com).

12
website/src/admin-panel/seatplan-editor.md
View File

@@ -1,20 +1,20 @@
# Seatplan editor
The seatplan editor is a graphical editor where you can create and modify the seating plan of virtually any room. We recommend that you start in the top left corner of the seatplan and then move down diagonally, as it is the easiest to do. Each so-called component can be either a stand area, a stage area or a seating area, with each of them featuring different layouts. You can change everything in the properties pane.
# Seat plan editor
The seat plan editor is a graphical editor where you can create and modify the seat plan of virtually any room. We recommend that you start in the top left corner of the seat plan and then move down diagonally, as it is the easiest to do. Each so-called component can be either a stand area, a stage area or a seating area, with each of them featuring different layouts. You can change everything in the properties-panel.
## Adding more components
You may add more components by simply clicking the plus icon in the toolbar of the editor. The component will spawn in the top left corner of the seatplan and the view will automatically be moved towards it.
You may add more components by simply clicking the plus icon in the toolbar of the editor. The component will spawn in the top left corner of the seat plan and the view will automatically be moved towards it.
## Removing components
You may remove components by clicking the trash icon or by hitting 'delete' on your keyboard.
## Editing history
The editor features undo and redo functions such that you can undo your mistakes and accidental undos can be reverted. Just hit the corresponding button in the toolbar or use the keyboard shortcuts Ctrl + Z for Undo and Ctrl + Y for Redo.
The editor features undo and redo functions such that you can undo your mistakes and accidental undo can be reverted. Just hit the corresponding button in the toolbar or use the keyboard shortcuts Ctrl + Z for Undo and Ctrl + Y for Redo.
## Component number property
This property can be used to tell the system in which order to number seats in. You can start at one for every time the numbering should start at 1 again. Just keep in mind that for optimal results, you should use a different sector whenever setting the component number to 1 again as otherwise there might be two seats 1 in a sector which can lead to confusion for the customer. You will be notified if there's such a conflict before deploying the seat plan.
This property can be used to tell the system in which order to number seats in. You can start at one for every time the numbering should start at 1 again. Just keep in mind that for optimal results, you should use a different sector whenever setting the component number to 1 again as otherwise there might be two seats 1 in a sector which can lead to confusion for the customer.
**Example:**
You've got a seat plan which has 4 seat components. These 4 components are grouped into two different sectors. Now, for the component where the seat numbering should start for each sector, set the component number property to 1. This will tell the system to start numbering the seats from this component. You may also choose the numbering direction with the option right below called 'Numbering direction'.
## Saving
The editor does auto-save a draft every minute. Pressing Ctrl + S or hitting the Save button in the toolbar will immediately save the seatplan as a draft. Click the deploy button to save the seatplan permanently, irreversibly overwriting any potentially existing old seatplan of that location, except you change the location name after the fact.
The editor does auto-save a draft every minute. Pressing Ctrl + S or hitting the Save button in the toolbar will immediately save the seat plan as a draft. Click the "deploy" button to save the seat plan permanently, irreversibly overwriting any potentially existing old seat plan of that location, except you change the location name after the fact.

4
website/src/admin-panel/settings.md
View File

@@ -15,7 +15,7 @@ disable | Disable Two-Factor-Authentication entirely (only for users, ro
This setting allows you to change the currency in which you want your customers to pay. The code has to be a valid ISO 4217 currency code. See more [here](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) (Wikipedia). This setting defaults to USD.
## Ticket Timeout
The ticket timeout setting allows you to specify for how much time of inactivity the ticket is reserved for a user. The value is to be entered in seconds. The database is parsed every five minutes by default (can be changed in the config file) and, if the threshold set here is exceeded, the session is garbage collected and all tickets selected are returned to the available tickets pool.
The ticket timeout setting allows you to specify for how much time of inactivity the ticket is reserved for a user. The value is to be entered in seconds. The database is parsed every five minutes by default (can be changed in the config file) and, if the threshold set here is exceeded, the session is garbage-collected and all tickets selected are returned to the available tickets pool.
## Payment gateway
@@ -67,4 +67,4 @@ You can update the username and the password of any admin account by clicking on
## Removing an account
You can delete an admin account by right clicking on it (yes, right click) and hit delete. Confirm again that you want to delete the account and then it's gone.
You can delete an admin account by right-clicking on it (yes, right click) and hit delete. Confirm again that you want to delete the account, and then it's gone.