Difference between revisions of "Extensions:Forums"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Initial setup)
Tag: 2017 source edit
 
m (was is)
Tag: 2017 source edit
 
(5 intermediate revisions by the same user not shown)
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}}|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=Forums|desc=Forums for your Lorekeeper site.|LKVer=2.0.0|auth=Preimpression|status=Testing|github={{Github|user=preimpression|branch=extension/forums}}|migration=yes|package=no}}
<!-- Put a short summary of your extension here! -->
+
 
 +
'''This extension is NOT currently compatible with develop (lorekeeper v. 3.0.0).'''
 +
 
 +
Forums for your site, utilizing the Comments extension by Uri and Newt.
 +
 
 +
'''This extension is still in testing and may have bugs. Strongly advise to test on local first.'''
 +
 
 +
 
 
== Installation ==
 
== Installation ==
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+
 
 +
* Pull the branch and merge it into your main branch
 +
* Run <code>php artisan migrate</code>
 +
* Run <code>php artisan update-extension-tracker</code>
 +
 
 +
 
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
 
 +
Permissions may be set at the forum level and may overflow to the grandchild level - but to be safe, you should set permissions per forum.
 +
 
 +
[[File:Example of Placeholder Forums.png|alt=Example of forum.|thumb|Example of forum.]]
 +
 
 
== Usage ==
 
== Usage ==
<!-- Is there anything users should know about using your extension? -->
+
 
 +
Create Forums in the Admin Panel.
 +
 
 +
Users' post page from their profile will be visible to logged in users but not guests, due to the permission-checking code.
 +
 
 +
Forums with no parent forum will be considered Categories and will not show the form to create threads, nor will any threads created in them be visible without the url or in the widget.
 +
 
 +
'''Optional:''' Include this widget in any page (homepage suggested) to include the most recent 5 posts: <pre>@include('widgets._recent_forum_posts')</pre>
 +
 
 +
'''Note:''' Deleting a comment that has had direct replies to it will transfer "parentage" of the comment to the the comment's parent. To hinder this, consider adjusting the delete Gate or wrap the delete button in an If statement to check if the user is staff.
 +
 
 +
'''Note:''' Deleting a thread will delete comments within it.
 +
 
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
 
 +
Permissions are a bit janky. If anyone has any suggestions, please let me know.
 +
 
 +
 
 +
== Planned ==
 +
 
 +
* ??? - Test and perhaps revise permissions.
 +
 
 
== See Also ==
 
== See Also ==
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
  
 +
Discord: Uri#2154

Latest revision as of 10:29, 1 July 2023

Forums
Description Forums for your Lorekeeper site.
Author(s) Preimpression
Status Testing
Github extension/forums
LK Version 2.0.0
Contains a Migration



This extension is NOT currently compatible with develop (lorekeeper v. 3.0.0).

Forums for your site, utilizing the Comments extension by Uri and Newt.

This extension is still in testing and may have bugs. Strongly advise to test on local first.


Installation

  • Pull the branch and merge it into your main branch
  • Run php artisan migrate
  • Run php artisan update-extension-tracker


Configuration

Permissions may be set at the forum level and may overflow to the grandchild level - but to be safe, you should set permissions per forum.

Example of forum.
Example of forum.

Usage

Create Forums in the Admin Panel.

Users' post page from their profile will be visible to logged in users but not guests, due to the permission-checking code.

Forums with no parent forum will be considered Categories and will not show the form to create threads, nor will any threads created in them be visible without the url or in the widget.

Optional: Include this widget in any page (homepage suggested) to include the most recent 5 posts:

@include('widgets._recent_forum_posts')

Note: Deleting a comment that has had direct replies to it will transfer "parentage" of the comment to the the comment's parent. To hinder this, consider adjusting the delete Gate or wrap the delete button in an If statement to check if the user is staff.

Note: Deleting a thread will delete comments within it.

Troubleshooting

Permissions are a bit janky. If anyone has any suggestions, please let me know.


Planned

  •  ??? - Test and perhaps revise permissions.

See Also

Discord: Uri#2154