Difference between revisions of "Extensions:News Expansion"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Setting up template)
Tag: 2017 source edit
 
(Added content)
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}}|migration=yes/no|package=yes/no}}
+
{{Extensioninfobox|title=News Expansion|desc=Add staff-only bulletins to the Staff Panel and add truncation to News|auth=Preimpression|status=status testing|github={{Github|user=preimpression|branch=newsExpansion}}|migration=yes|package=no}}
<!-- Put a short summary of your extension here! -->
+
This expansion adds staff Bulletins using the News model and database table. It also adds a "staff member" power to allow Miscellaneous staff links to be added to the sidebar for any staff member to see, regardless of actual power. The extension adds the latest bulletin (truncated to a pixel size using JQuery) to the top of the admin panel but does not currently support notifying admins for new Bulletins.
 +
 
 
== Installation ==
 
== Installation ==
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+
Pull the branch and run the migration.
 +
 
 +
Make sure that if you are manually adjusting for conflicts, that you are careful to maintain the admin bulletin = false indication on public news - you don't want your regular members to be able to see admin Bulletins or be notified for them!
 +
 
 
== Configuration ==
 
== Configuration ==
<!-- Is any configuration necessary? Describe it here! -->
+
You will need to add the generic "staff" power to existing non-admin staff roles in order for them to see the Bulletins list on the sidebar of the Admin Panel.
 +
 
 
== Usage ==
 
== Usage ==
<!-- Is there anything users should know about using your extension? -->
+
In order to add Bulletins, you go to the now-labeled '''News and Bulletins''' link on the sidebar and click "Create New Staff Bulletin." Note that if you accidentally make a staff bulletin as a news post or vice versa, you cannot swap it from the admin panel - you would need to go to the database and switch the boolean there.
 +
 
 +
On the admin list of news and bulletins, staff bulletins are marked by the same crown icon that the admin panel link uses. Admin news links go to a different url from regular news but are still accessible from the original /news/ url.
 +
 
 
== Troubleshooting ==
 
== Troubleshooting ==
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+
I don't know of any issues, but if you find any please feel free to let me know. I am also always open to Pull Requests if people want to improve upon my code.
 +
 
 
== See Also ==
 
== See Also ==
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
+
To contact me, find me on the LK Discord server as Uri!
 
 

Latest revision as of 15:44, 12 August 2020

News Expansion
Description Add staff-only bulletins to the Staff Panel and add truncation to News
Author(s) Preimpression
Status status testing
Github newsExpansion
LK Version Unspecified
Contains a Migration






This expansion adds staff Bulletins using the News model and database table. It also adds a "staff member" power to allow Miscellaneous staff links to be added to the sidebar for any staff member to see, regardless of actual power. The extension adds the latest bulletin (truncated to a pixel size using JQuery) to the top of the admin panel but does not currently support notifying admins for new Bulletins.

Installation

Pull the branch and run the migration.

Make sure that if you are manually adjusting for conflicts, that you are careful to maintain the admin bulletin = false indication on public news - you don't want your regular members to be able to see admin Bulletins or be notified for them!

Configuration

You will need to add the generic "staff" power to existing non-admin staff roles in order for them to see the Bulletins list on the sidebar of the Admin Panel.

Usage

In order to add Bulletins, you go to the now-labeled News and Bulletins link on the sidebar and click "Create New Staff Bulletin." Note that if you accidentally make a staff bulletin as a news post or vice versa, you cannot swap it from the admin panel - you would need to go to the database and switch the boolean there.

On the admin list of news and bulletins, staff bulletins are marked by the same crown icon that the admin panel link uses. Admin news links go to a different url from regular news but are still accessible from the original /news/ url.

Troubleshooting

I don't know of any issues, but if you find any please feel free to let me know. I am also always open to Pull Requests if people want to improve upon my code.

See Also

To contact me, find me on the LK Discord server as Uri!