Difference between revisions of "Extensions:Masterlist Sublists"

From Lorekeeper Wiki
Jump to navigation Jump to search
(created page)
Tag: 2017 source edit
 
m (Added updating to v2 link)
 
(5 intermediate revisions by 2 users 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=Sub Masterlists|desc=Create additional masterlist pages with specific characters and species|auth=junijwi|status=testing|github={{Github|user=junijwi|branch=masterlist-sub}}|migration=yes|package=no|modified-main=yes}}
 
<!-- Put a short summary of your extension here! -->
 
<!-- Put a short summary of your extension here! -->
 
== Installation ==
 
== Installation ==
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+
Please take care when resolving merging conflicts!! I would recommend backing up your site and database before beginning, testing on a local copy, and otherwise reading the [[Tutorial: Installing Extensions]] guide before moving forward.
 +
This isn't a complex extension, but it touches a lot of different locations of code and can be deceptively large in scope. It may cause many conflicts. I would encourage you to @ me in the discord server if you're not sure about a certain merge (which code to accept for merging), my contact information is below.
 +
 
 +
Pull the branch, push, and run <code>php artisan migrate</code>.
 +
 
 +
As a note, the only place this extension places sub masterlist links is in the new sidebar menu added to the masterlist section. If you want to add it to the navbar, make a submasterlist first, then add its link to the _nav.blade.php file located in <code>resources\views\layouts</code>.
 +
 
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
When creating a sub masterlist, you can assign both categories or species to it. You can set the sub masterlist so that it ONLY shows up on the sublist (is excluded from the main masterlist).
 
== Usage ==
 
== Usage ==
<!-- Is there anything users should know about using your extension? -->
+
As some examples for useage:
 +
Creating NPC masterlist, create an NPC character category. Create a sublist called NPC which has the NPC category, and turn 'show main' off. If you do not include species here, then it will have all species of any characters marked in the NPC category.
 +
 
 +
Creating a pets masterlist, create a pets character category. Create a sublist called pets which has the Pets category, and include all pet species. Turn 'show main' off and they should appear in the sublist but not in the main list.
 +
 
 +
You can use this as an easy sort to create species specific masterlists which are all still included in the main masterlist as well.
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
There are some quirks to this extension right now-- as I did not want to create an extra database table nor deal with potential overlap problems, each species and each category can only be assigned to ONE sub masterlist.
 +
Additionally, breadcrumbs only check for sublists linked to category, not species.
 +
 
 +
If anyone has any suggestions for improving upon this extension, please feel free to contact me!
 +
 
 +
Otherwise, feel free to @ me in the discord (Juni#0448) for any issues.
 
== See Also ==
 
== See Also ==
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
 
+
* [[Updating:_to_2.0.0]]

Latest revision as of 10:10, 25 March 2024

Sub Masterlists
Description Create additional masterlist pages with specific characters and species
Author(s) junijwi
Status testing
Github masterlist-sub
LK Version Unspecified
Contains a Migration
Is part of LK v2 (modified-main)



Installation

Please take care when resolving merging conflicts!! I would recommend backing up your site and database before beginning, testing on a local copy, and otherwise reading the Tutorial: Installing Extensions guide before moving forward. This isn't a complex extension, but it touches a lot of different locations of code and can be deceptively large in scope. It may cause many conflicts. I would encourage you to @ me in the discord server if you're not sure about a certain merge (which code to accept for merging), my contact information is below.

Pull the branch, push, and run php artisan migrate.

As a note, the only place this extension places sub masterlist links is in the new sidebar menu added to the masterlist section. If you want to add it to the navbar, make a submasterlist first, then add its link to the _nav.blade.php file located in resources\views\layouts.

Configuration

When creating a sub masterlist, you can assign both categories or species to it. You can set the sub masterlist so that it ONLY shows up on the sublist (is excluded from the main masterlist).

Usage

As some examples for useage: Creating NPC masterlist, create an NPC character category. Create a sublist called NPC which has the NPC category, and turn 'show main' off. If you do not include species here, then it will have all species of any characters marked in the NPC category.

Creating a pets masterlist, create a pets character category. Create a sublist called pets which has the Pets category, and include all pet species. Turn 'show main' off and they should appear in the sublist but not in the main list.

You can use this as an easy sort to create species specific masterlists which are all still included in the main masterlist as well.

Troubleshooting

There are some quirks to this extension right now-- as I did not want to create an extra database table nor deal with potential overlap problems, each species and each category can only be assigned to ONE sub masterlist. Additionally, breadcrumbs only check for sublists linked to category, not species.

If anyone has any suggestions for improving upon this extension, please feel free to contact me!

Otherwise, feel free to @ me in the discord (Juni#0448) for any issues.

See Also