Difference between revisions of "Extensions:LiveClock"

From Lorekeeper Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
(Edited infobox and general description)
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=LiveClock|desc=Adds a working clock to the site!|auth=Speedy|status=stable|github={{Github|user=SpeedyD|branch=lorekeeper/tree/extension/LiveClock}}|LKVer=2.0.0|migration=no|package=no}}
<!-- Put a short summary of your extension here! -->
+
 
 +
Adds a working clock to the site!
 +
By default, this will ONLY replace the static clock on the dashboard..
 +
 
 +
But you can add clocks wherever you want! Highly suggested to put it on the footer.
 +
 
 +
This extension uses Javascript and JQuery for it's live updates.
 +
 
 +
Thanks, as always, to [[User:Mercury|Mercury]]!
 +
 
 
== Installation ==
 
== Installation ==
 
Pull the extension branch and push to your site.
 
Pull the extension branch and push to your site.
 
Will replace the default clock on the dashboard, so be wary of conflicts if your dashboard is modified.
 
Will replace the default clock on the dashboard, so be wary of conflicts if your dashboard is modified.
 +
Don't forget to run <code>php artisan update-extension-tracker</code>!
  
 
== Configuration ==
 
== Configuration ==
Line 9: Line 19:
  
 
== Usage ==
 
== Usage ==
Simply put the following in any location you want a clock: <syntaxhighlight>
+
Simply put the following in any location you want a clock: <code>{!! LiveClock() !!}</code>
{!! LiveClock() !!}
 
</syntaxhighlight>
 
  
Optionally, add the following in front of the LiveClock line to get a little clock icon in front.
+
Optionally, add <code><i class="far fa-clock"></i><code> in front of the LiveClock line to get a little clock icon in front.
<syntaxhighlight lang="html">
 
<i class="far fa-clock"></i>
 
</syntaxhighlight>
 
  
 
== Troubleshooting ==
 
== Troubleshooting ==
Line 24: Line 29:
  
 
== Images ==
 
== Images ==
<!-- Do you have any images to show what it looks like in action? -->
+
<!-- Note to self: add GIF of it working sometime soon -->
 +
 
 
== See Also ==
 
== See Also ==
 
Alternatively, you could try [[Extensions:Mini clock|Newt's Mini Clock extension]], which was in fact the inspiration for this little project.
 
Alternatively, you could try [[Extensions:Mini clock|Newt's Mini Clock extension]], which was in fact the inspiration for this little project.

Revision as of 11:52, 1 November 2021

LiveClock
Description Adds a working clock to the site!
Author(s) Speedy
Status stable
Github lorekeeper/tree/extension/LiveClock
LK Version 2.0.0




Adds a working clock to the site! By default, this will ONLY replace the static clock on the dashboard..

But you can add clocks wherever you want! Highly suggested to put it on the footer.

This extension uses Javascript and JQuery for it's live updates.

Thanks, as always, to Mercury!

Installation

Pull the extension branch and push to your site. Will replace the default clock on the dashboard, so be wary of conflicts if your dashboard is modified. Don't forget to run php artisan update-extension-tracker!

Configuration

No configuration necessary. LiveClock bases the time on your Lorekeeper timezone.

Usage

Simply put the following in any location you want a clock: {!! LiveClock() !!}

Optionally, add in front of the LiveClock line to get a little clock icon in front.

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

See Also

Alternatively, you could try Newt's Mini Clock extension, which was in fact the inspiration for this little project.