Difference between revisions of "Extensions:Terms Popup"

From Lorekeeper Wiki
Jump to navigation Jump to search
(initial setup)
Tag: 2017 source edit
 
(docu added)
Tag: 2017 source edit
Line 1: Line 1:
{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|LKVer=What Lorekeeper version the ext is built on|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Terms Popup|desc=Makes a popup show when a user first visits the site that they have to accept before continuing. You can put anything in there.|auth=Cylunny|status=testing|github={{Github|user=Cylunny|branch=extension/terms-popup}}|LKVer=2.1.2|migration=yes|package=no}}
<!-- Put a short summary of your extension here! -->
+
 
 +
This makes a popup appear for visitors of your site that they have to accept before continuing. The content of the popup is customizable. It will appear for logged out users/visitors once per browser, and once for a logged in user (acceptance is saved to the database).
 +
 
 
== Installation ==
 
== Installation ==
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+
* pull & deal with merge conflicts
 +
* <code>php artisan migrate</code>
 +
* <code>php artisan optimize</code> x2
 +
* <code>php artisan update-extension-tracker</code>
 +
 
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
You can edit the title, content and button text of the popup in the config/lorekeeper/settings.php file.
 +
You may also disable it by setting the value to 0.
 +
Make sure to run optimize after editing these or changes will not persist.
 +
 
 
== Usage ==
 
== Usage ==
<!-- Is there anything users should know about using your extension? -->
+
For visitors (logged out), the accept is saved in their local storage, so it should pop up on every new browser once. For users (logged in), accept is stored to the user db table.
 +
 
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
We are never 100% safe from those pesky bugs. If you find something, feel free to contact me- I am Cylunny on the lorekeeper discord!
 +
 
 
== Images ==
 
== Images ==
<!-- Do you have any images to show what it looks like in action? -->
+
<gallery>
 +
File:Termspopup.jpg|Unedited Popup and edited example
 +
</gallery>
 +
 
 
== See Also ==
 
== See Also ==
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
+
If this extension helped you, feel free to support me on [https://ko-fi.com/cylunny Kofi]!
 
 

Revision as of 06:02, 14 October 2023

Terms Popup
Description Makes a popup show when a user first visits the site that they have to accept before continuing. You can put anything in there.
Author(s) Cylunny
Status testing
Github extension/terms-popup
LK Version 2.1.2
Contains a Migration







This makes a popup appear for visitors of your site that they have to accept before continuing. The content of the popup is customizable. It will appear for logged out users/visitors once per browser, and once for a logged in user (acceptance is saved to the database).

Installation

  • pull & deal with merge conflicts
  • php artisan migrate
  • php artisan optimize x2
  • php artisan update-extension-tracker

Configuration

You can edit the title, content and button text of the popup in the config/lorekeeper/settings.php file. You may also disable it by setting the value to 0. Make sure to run optimize after editing these or changes will not persist.

Usage

For visitors (logged out), the accept is saved in their local storage, so it should pop up on every new browser once. For users (logged in), accept is stored to the user db table.

Troubleshooting

We are never 100% safe from those pesky bugs. If you find something, feel free to contact me- I am Cylunny on the lorekeeper discord!

Images

See Also

If this extension helped you, feel free to support me on Kofi!