Difference between revisions of "Extensions:Character Prev and Next"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Further setup. Will finish later.)
(Page completed! I think! Probably!)
Line 9: Line 9:
 
| You will not be able to download this. This wiki page is only for referencing purposes.
 
| You will not be able to download this. This wiki page is only for referencing purposes.
 
|}
 
|}
'''Page under construction, sorry!'''
+
This extension adds previous and next buttons on character pages. It will allow you to more quickly look through character pages in order.
 +
 
 +
Additional credits to [https://github.com/AW0005 Moif] for inspiration on fixing the gaps and as always, [[User:Mercury|Mercury]] for helping with code, cleaning up, advice, etc, etc, etc. :)
  
<!-- Put a short summary of your extension here! -->
 
 
== Installation ==
 
== Installation ==
 
As this extension is part of v3.0.0, you will want to perform any actions required to update properly. But there are no other installation steps otherwise.
 
As this extension is part of v3.0.0, you will want to perform any actions required to update properly. But there are no other installation steps otherwise.
 +
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
In the <code>config/lorekeeper/extensions.php</code> file, find:
 +
<syntaxhighlight lang="html">// Previous & Next buttons on Character pages - Speedy</syntaxhighlight>
 +
Under <code>'previous_and_next_characters' =></code> you will find the following two options:
 +
<code>'display' => 0</code> If set to 1, it will display the buttons. By default, it is 0 to keep it turned off.
 +
<code>'reverse' => 0</code> This reverses the previous and next buttons. By default, it is 0 to have the higher number as previous and the lower number as next, reflecting masterlist order. Set it to 1 to reverse that to have the higher number as next and the lower number as previous.
 +
 
 
== Usage ==
 
== Usage ==
<!-- Is there anything users should know about using your extension? -->
+
It is simply for ease of navigation characters without having to go back to the masterlist over and over.
 +
 
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
I'm Speedy#4060 on Discord, but please do not contact me directly.
 +
 
 +
Instead, please tag me in the Lorekeeper server if you need my help.
 +
 
 +
I am not a regular there, so asking something without a tag might not get a response.
 +
 
 
== Images ==
 
== Images ==
<!-- Do you have any images to show what it looks like in action? -->
+
<!-- Note to self: add images sometime soon -->
 +
 
 +
== Version History ==
 +
* '''*1:''' Initial creation.
 +
* '''*2:''' Swapped it to be in extension settings rather than site settings.
 +
* '''*3:''' Tidied up variables.
 +
* '''*4:''' Added extra check for safety.
 +
* '''*5:''' Ensured previous and next buttons work over gaps.
 +
* '''*6:''' Cleanup for consistency and reversal code.
 +
* '''*7:''' Removed test code.
 +
(This extension has never had a tracker update, and never will.)
 +
 
 
== 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. -->

Revision as of 08:19, 4 June 2023

Previous & Next buttons on Character pages
Description Displays previous and next buttons on character pages.
Author(s) Speedy
Status stable
Github SpeedyD/lorekeeper
LK Version 3.0.0 dev
Is part of LK v3.0.0's release







THIS EXTENSION IS PART OF v3.0.0
This extension has been merged into the develop branch (aka the future v3.0.0 branch) as Previous & Next buttons on Character pages.
You will not be able to download this. This wiki page is only for referencing purposes.

This extension adds previous and next buttons on character pages. It will allow you to more quickly look through character pages in order.

Additional credits to Moif for inspiration on fixing the gaps and as always, Mercury for helping with code, cleaning up, advice, etc, etc, etc. :)

Installation

As this extension is part of v3.0.0, you will want to perform any actions required to update properly. But there are no other installation steps otherwise.

Configuration

In the config/lorekeeper/extensions.php file, find:

// Previous & Next buttons on Character pages - Speedy

Under 'previous_and_next_characters' => you will find the following two options: 'display' => 0 If set to 1, it will display the buttons. By default, it is 0 to keep it turned off. 'reverse' => 0 This reverses the previous and next buttons. By default, it is 0 to have the higher number as previous and the lower number as next, reflecting masterlist order. Set it to 1 to reverse that to have the higher number as next and the lower number as previous.

Usage

It is simply for ease of navigation characters without having to go back to the masterlist over and over.

Troubleshooting

I'm Speedy#4060 on Discord, but please do not contact me directly.

Instead, please tag me in the Lorekeeper server if you need my help.

I am not a regular there, so asking something without a tag might not get a response.

Images

Version History

  • *1: Initial creation.
  • *2: Swapped it to be in extension settings rather than site settings.
  • *3: Tidied up variables.
  • *4: Added extra check for safety.
  • *5: Ensured previous and next buttons work over gaps.
  • *6: Cleanup for consistency and reversal code.
  • *7: Removed test code.

(This extension has never had a tracker update, and never will.)

See Also