Template:Event timer/doc: Difference between revisions

From 118Wiki
Jump to navigation Jump to search
(Basics. WIP)
 
(basic examples. wip)
Line 19: Line 19:


'''Today''' is if you, for some reason, want to compare the start date and end date for some specific date. This parameter is recommended only for advanced use.
'''Today''' is if you, for some reason, want to compare the start date and end date for some specific date. This parameter is recommended only for advanced use.
=== Dates ===
== Examples ==
=== Basic use ===
<pre>{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | End message = '''Autumn has passed.''' | Future message = '''There's still time until autumn.'''}}</pre>
Let's assume today is 10th October, which is between 23rd September and 22 December. Now, the template will render like this:
{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | End message = '''Autumn has passed.''' | Future message = '''There's still time until autumn.''' | Today = 10 Oct}}
If it was 4th July, before those dates, instead, we'd have the following render instead:
{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | End message = '''Autumn has passed.''' | Future message = '''There's still time until autumn.''' | Today = 4 Jul}}
And, if it was 25th December, after those dates, this is what we would get:
{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | End message = '''Autumn has passed.''' | Future message = '''There's still time until autumn.''' | Today = 10 Oct}}
=== Omitting end and future messages ===
We don't have to show anything before or after the selected dates.
<pre>{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.'''}}</pre>
So, on 10th October we will see this:
{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | Today = 10 Oct}}
But if on 4th July and 25th December, we will see nothing.
{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | Today = 25 Dec}}
=== Single-day ===
<pre>{{Event timer | Start = 26 Oct | End = 26 Oct | Message = '''Happy birthday, [[Jovenan]]!''' | End message = '''Jovenan's birthday has passed.''' | Future message = '''It's not yet Jovenan's birthday'''}}</pre>
On 26th October, we will have the following:
{{Event timer | Start = 26 Oct | End = 26 Oct | Message = '''Happy birthday, [[Jovenan]]!''' | End message = '''Jovenan's birthday has passed.''' | Future message = '''It's not yet Jovenan's birthday''' | Today =  26 Oct}}
Otherwise, we will have either of these:
{{Event timer | Start = 26 Oct | End = 26 Oct | Message = '''Happy birthday, [[Jovenan]]!''' | End message = '''Jovenan's birthday has passed.''' | Future message = '''It's not yet Jovenan's birthday''' | Today =  1 Jan}}
{{Event timer | Start = 26 Oct | End = 26 Oct | Message = '''Happy birthday, [[Jovenan]]!''' | End message = '''Jovenan's birthday has passed.''' | Future message = '''It's not yet Jovenan's birthday''' | Today =  31 Dec}}
=== Styling ===
<pre>{{Event timer | Start = 26 Oct | End = 26 Oct | Message = <div style="width: 80%; margin:auto; text-align: center; border: 3px double blue; background-color: lightsteelblue; font-size: 20px">Happy birthday, Jovenan!</div>}}</pre>
On 26th October, we will see this:
{{Event timer | Start = 26 Oct | End = 26 Oct | Message = <div style="width: 80%; margin:auto; text-align: center; border: 3px double blue; background-color: lightsteelblue; font-size: 20px">Happy birthday, Jovenan!</div>  | End message = '''Jovenan's birthday has passed.''' | Future message = '''It's not yet Jovenan's birthday'''| Today = 26 Oct}}

Revision as of 12:32, 10 October 2023

Note: This template is currently under construction.
This notice was placed here by Jovenan, so go bug her to finish the page if nothing's happening.


This template shows a message between selected dates. The message will be shown annually between those dates. More flexible usage is possible as described in the documentation.

Usage

Full usage:

{{Event timer | Start = | End = | Message = | End message = | Future message = | Today = }}

Parameters

All parameters are optional.

Start is for the start date and End is for the end date. If start date is omitted, the message will be shown until the end date from the beginning of the year. If end date is omitted, the message will be shown until the end of the year. If both are omitted, the message will be shown around the year.

Message is the message you want to show between start and end.

End message is shown after the end date has passed, and Future message is shown before the start date. If either is omitted, no message is shown during those times.

Today is if you, for some reason, want to compare the start date and end date for some specific date. This parameter is recommended only for advanced use.

Dates

Examples

Basic use

{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.''' | End message = '''Autumn has passed.''' | Future message = '''There's still time until autumn.'''}}

Let's assume today is 10th October, which is between 23rd September and 22 December. Now, the template will render like this:

It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.

If it was 4th July, before those dates, instead, we'd have the following render instead:

There's still time until autumn.

And, if it was 25th December, after those dates, this is what we would get:

It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.

Omitting end and future messages

We don't have to show anything before or after the selected dates.

{{Event timer | Start = 23 Sept | End = 22 Dec | Message = '''It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.'''}}

So, on 10th October we will see this:

It's autumn in the Northern Hemisphere on Earth accoring to the astronomical definition.

But if on 4th July and 25th December, we will see nothing.


Single-day

{{Event timer | Start = 26 Oct | End = 26 Oct | Message = '''Happy birthday, [[Jovenan]]!''' | End message = '''Jovenan's birthday has passed.''' | Future message = '''It's not yet Jovenan's birthday'''}}

On 26th October, we will have the following:

Happy birthday, Jovenan!

Otherwise, we will have either of these:

It's not yet Jovenan's birthday

Jovenan's birthday has passed.

Styling

{{Event timer | Start = 26 Oct | End = 26 Oct | Message = <div style="width: 80%; margin:auto; text-align: center; border: 3px double blue; background-color: lightsteelblue; font-size: 20px">Happy birthday, Jovenan!</div>}}

On 26th October, we will see this:

Happy birthday, Jovenan!