mirror of
https://github.com/janishutz/libreevent.git
synced 2025-11-25 13:24:24 +00:00
update docs
This commit is contained in:
14
website/dist/docs/admin-panel/events/index.html
vendored
14
website/dist/docs/admin-panel/events/index.html
vendored
@@ -13,11 +13,12 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Events</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Events</h1>
|
||||
<p>This is the most feature rich admin page of libreevent. Here you can change everything regarding an event.</p>
|
||||
<h2>Creating new events</h2>
|
||||
<p>Creating new events is as simple as clicking the plus icon in the top right corner and following the prompts.</p>
|
||||
@@ -26,8 +27,9 @@
|
||||
<h3>Event description</h3>
|
||||
<p>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.</p>
|
||||
<h3>Event location</h3>
|
||||
<p>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 <a href="/docs/admin-panel/seatplan-editor">here</a></p>
|
||||
<p>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 <a href="/docs/admin-panel/seatplan-editor">here</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
12
website/dist/docs/admin-panel/index.html
vendored
12
website/dist/docs/admin-panel/index.html
vendored
@@ -13,11 +13,12 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Home</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Home</h1>
|
||||
<p>The admin panel is where you can change basically everything about libreevent. It can be reached by visiting your libreevent instance and at the end type '/admin'. Example: 'https://libreevent.janishutz.com/admin' (note that this is not a valid URL!)
|
||||
</p>
|
||||
<p>Here's a list of the pages available when logged in as the root user. </p>
|
||||
@@ -32,6 +33,7 @@
|
||||
<p></p>
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
@@ -13,13 +13,15 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Locations</h1>
|
||||
<p>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.</p>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Locations</h1>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
14
website/dist/docs/admin-panel/pages/index.html
vendored
14
website/dist/docs/admin-panel/pages/index.html
vendored
@@ -13,13 +13,15 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Pages</h1>
|
||||
<p>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 <a href="/templates">here</a>. 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 <a href="https://development.janishutz.com">here</a>.</p>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Pages</h1>
|
||||
<p>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 <a href="/templates">here</a>. 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 <a href="https://development.janishutz.com">here</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
12
website/dist/docs/admin-panel/plugins/index.html
vendored
12
website/dist/docs/admin-panel/plugins/index.html
vendored
@@ -13,15 +13,17 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Plugins</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Plugins</h1>
|
||||
<p>libreevent can be extended easily with plugins. Plugins add additional features and can be official or community made. When installing plugins, you need to remember that a server restart is required to activate the plugins as libreevent does not feature hot module loading (yet). You then can manage the plugins using their built-in settings page that they ship with.</p>
|
||||
<p><strong>Please only install plugins from sources you trust!</strong></p>
|
||||
<p>You may read on about plugins and how to install them <a href="/docs/plugins/">here</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Seatplan editor :: docs - libreevent</title>
|
||||
<title>Seat plan editor :: docs - libreevent</title>
|
||||
<link rel="stylesheet" href="/docs/css/style.css">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
@@ -13,25 +13,27 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Seatplan editor</h1>
|
||||
<p>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.</p>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Seat plan editor</h1>
|
||||
<p>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.</p>
|
||||
<h2>Adding more components</h2>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<h2>Removing components</h2>
|
||||
<p>You may remove components by clicking the trash icon or by hitting 'delete' on your keyboard.</p>
|
||||
<h2>Editing history</h2>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<h2>Component number property</h2>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<p><strong>Example:</strong>
|
||||
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'.</p>
|
||||
<h2>Saving</h2>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
@@ -13,11 +13,12 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Settings</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Settings</h1>
|
||||
<h2>2FA</h2>
|
||||
<p>You can require the users to enable Two-Factor Authentication when confirming their email.
|
||||
The following settings are available:</p>
|
||||
@@ -46,7 +47,7 @@ The following settings are available:</p>
|
||||
<h2>Currency</h2>
|
||||
<p>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 <a href="https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes">here</a> (Wikipedia). This setting defaults to USD.</p>
|
||||
<h2>Ticket Timeout</h2>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<h2>Payment gateway</h2>
|
||||
<h3>Select a gateway</h3>
|
||||
<p>With this setting, you can select the payment gateway to use. You may follow the link <a href="https://libreevent.janishutz.com/docs/payments">here</a> to get more information on the payment gateway. You need to hit save to enable editing for the gateway settings.</p>
|
||||
@@ -96,8 +97,9 @@ The following settings are available:</p>
|
||||
<h2>Modifying an account</h2>
|
||||
<p>You can update the username and the password of any admin account by clicking onto it.</p>
|
||||
<h2>Removing an account</h2>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
|
||||
<script src="/docs/js/index.js"></script>
|
||||
|
||||
Reference in New Issue
Block a user