Template:Sefirat HaOmer Box/doc

This template returns a box containing the complete Sefirat HaOmer count for the day, based on the customary sefirah count found in the (Ashkenazi) siddur. The content of the box is driven by the template. It indirectly makes use of the template Current hour offset in time zone, so that it will show the proper count based on your chosen time zone. See below for the currently supported time zones and parameters.

This box is the same length (in pixels) as a standard userbox, and is intended mainly for use on userspace pages. It is also intended that this template be transcluded on the page Counting of the Omer. However, it is probably not appropriate to add it to other mainspace pages.

Behavior outside the period of Sefirat HaOmer
This template is designed to make the box completely disappear when it is not the period of Sefirat HaOmer. Accordingly, if you use this template on a page and want it to reappear during a new Sefirat HaOmer cycle, you will have to purge the cache of that page sometime during that new Sefirat HaOmer cycle (i.e., on the second day of Passover or later).

During the interval of Sefirat HaOmer, the top of the template page should show a box similar to the ones shown in the documentation, but for the current day's date (if the cache has been purged). During other times of the year, the template page should show nothing except this documentation.

Default
{{Sefirat HaOmer Box}}

The examples above and at right are hard-coded for Iyar 29 (so they do not disappear off-season).

Without parameters, the count is based on the day's midnight-to-midnight UTC date. Using the parameter  moves the box to the right hand side of the page:

With time zone abbreviation
{{Sefirat HaOmer Box[|tz=time_zone][|erev=erev]}}
 * (' ' means 'optional', do not include the square brackets when using this template)

where
 * time_zone is the desired time zone abbreviation (see below and also the list of time zone abbreviations);


 * erev is an optional parameter to force the count to advance at 18:00 (6:00 pm) local time. See below.
 * Capability in similar templates to use the code  to disable automatic daylight saving time adjustment was not included in this template. This template uses Daylight saving in time zone (indirectly) to automatically adjust the offset according to daylight saving time (DST), if applicable. If you wish to suppress daylight saving time adjustment in a time zone that otherwise uses it (like in Arizona or Saskatchewan), please use the   parameter instead.

With time offset
{{Sefirat HaOmer Box|offset=offset[|erev=erev]}}
 * offset is the time offset from UTC/GMT in hours; see map below. Non-integer offsets are valid. Template cannot accommodate DST when using offset. When  is present, any time zone abbreviation is ignored.


 * erev is an optional parameter to force the Hebrew calendar date to advance at 18:00 (6:00 pm) local time. See below.

erev parameter: Hebrew dates begin the evening before
The MediaWiki software, and therefore this template, normally calculate date conversions using conventional midnight-to-midnight days. For example, this template would return the Hebrew calendar date 1 Elul 5773 for the entire Gregorian day of 7 August 2013.

However, Hebrew calendar dates actually run from sundown to sundown. Thus 1 Elul 5773 actually begins at sundown on 6 August, while 2 Elul begins at sundown on 7 August. To approximate this behavior, the parameter   forces the template to advance the Hebrew calendar date at 18:00 (6:00 pm) in the time zone selected. Thus, at 6:00 pm on 7 August, the template would advance the Hebrew calendar date to 2 Elul. (The page might need to be purged.)


 * In this template, the required format for this parameter is.

Date
{{Sefirat HaOmer Box|Hebrew calendar month|Hebrew calendar day of month}}
 * Passing the parameters of a Hebrew calendar date (month and day) returns a box containing the count for that Hebrew calendar date, or nothing at all if the date does not fall within the period of the count. (See above for behavior outside the Sefirat HaOmer period.) Other parameters (except for ) are ignored in this case.

Supported time zones
Currently the following time zones are supported: {{#if:{{{1|}}}||

Related templates
}}
 * Sefirat HaOmer
 * Hebrew calendar today in time zone
 * Hebrew calendar tomorrow in time zone
 * Current hour offset in time zone
 * Current minute offset in time zone
 * Current hour in time zone
 * Current minute in time zone
 * Daylight saving in time zone

Source
Template was substantially copied from its Hebrew Wikipedia counterpart.