joomla:time_ruler:documentation:all_settings

All settings explained

For reference to the following explanation of the modules settings, here is a example of a fully configured Time Ruler module:

(Commercial Unlimited License only)

Allows to determine which source for the current date and time is be used:

Use this Servers time

Uses the Server time of the server where your Joomla installation is residing. This time will not include any Time Offset setting performed in Joomla.

Use Joomla Time and include Joomla Time Offset setting

Uses the Server time of the server where your Joomla installation is residing, and adds the Joomla Time Offset as set in your Joomla Configuration.

(Commercial Unlimited License only)

Allows to add or subtract any arbitrary number of hours to the current Date and Time determined by the Time Source setting.

Example:

2  ... Adds 2h of Time Offset from current Server or Joomla time
-3 ... Subtracts 3h of Time Offset from current Server or Joomla time



Find the Module ID in the list of modules, File Reference may be a number (unrecommended as it might be confused with a Module ID) or a title or name (recommended).

Define the rules as per the following structure:

<Module ID or File Reference>=<Date & Time Rule>

The Date and Time rules defined here allow date and time based activation of the assigned modules. Any combination of date and time is allowed and by using only a time and a “zero” date the time is applied to the current time of day. That specific allows activation within a single day. For the time the 24h format is used, such as 08:30:00 and 14:30:00 according to the GNU Time Format.

Alternatively there is another rule format allowing more granular control by allowing to define hours, weekdays, days of month and years.

These are the recognized rule formats:

  • yyyy-mm-dd hh:mm:mm|yyyy-mm-dd hh:mm:mm - to be active for any calendar date & time period within the first and second given date and time
  • times|weekdays|days of month|months|years - to be active within given times, weekdays, days of month, months and years

Any combination of these rules is allowed, every rule must be in its own line.

Example:

2006-12-24 08:30:00|2006-12-26 09:45:30
08:00-16:30|mon-fri|*|jan-aug|2007-2008



Calendar Rules are rules based on calendar dates and times on the calendar day. This rule allows setting of calendar period beginning with the first date & time and ending with the second date & time.

When omitting time, please use 00:00:00 as time

Example:

2006-12-24 08:30:00|2006-12-26 09:45:30

Use the format of YYYY-DD-MM HH:MM:SS for specifying a date and time, as in following examples:

  • 2006-12-24 00:00:00 - for Dec. 24th, 2006 at midnight
  • 2006-12-24 08:30:00 - for Dec. 24th, 2006 at 8:30 morning

By omitting the year with 0000 instead, the date applies to any year. For example:

  • 0000-12-24 15:30:00 - for Dec. 24th of any year at 15:30 afternoon (3:30pm)
  • 0000-00-00 09:45:00 - for any day at 9:45 morning

If there is the year omitted with 0000 and the month of the second date is before the month of the first date, then the second date is seen to be in the forthcoming year.

For example 0000-12-24 00:00:00|0000-01-02 00:00:00 defines a date region from Dec. 24th of the current year to Jan. 2nd the following year.

Same applies to hours of day, for example 0000-00-00 22:00:00|0000-00-00 04:00:00 defines a date region from 22:00 (10:00pm) of the actual day until 04:00 (4:00am) of the next day.

With omitting a date with “0000-00-00” the rule applies to every day.

When omitting time, please use 00:00:00 as time.

For stability always use the full date format and use ZEROS to ommit values.

For Joomla 1.5 sites use the # character as delimiter instead of the | character when experiencing lost rules during save of the Time Ruler settings.

So some rule of:
2006-12-24 08:30:00|2006-12-26 09:45:30

will then read as:
2006-12-24 08:30:00#2006-12-26 09:45:30



This rule allows definition of recurring dates and times. An Asterisk (*) is used here to ommit values.

Example:

08:00-16:30|mon-fri|*|jan-aug|2007-2008

The individual parts of this rule are defined in its order of:

times|weekdays|days of month|months|years
  • Times: Use a single time 08:30 or a time period 08:30-16:00 in the format of hh:mm. Leave out any seconds, those are unsupported here. To cross a time frame over a 24h period, something as 18:00-02:00 is supported.
  • Weekdays: Use a single weekday mon or a weekday period mon-wed where the weekdays are in its english 3-letter abbreviations: mon tue wed thu fri sat sun
  • Days of Month: Use a single day 1 or a day period 5-28 for the days of any month.
  • Months: Use a single month jan or a month period feb-mar to define months, where the months are in its english 3-letter abbreviations: jan feb mar apr may jun jul aug sep oct nov dec
  • Years: Use a single year 2007 or a year period 2007-2008 to define years.
  • Ommit Values by using the Asterisk (*): 08:00-16:30|mon-fri|*|jan-aug|2007-2008 does ommit any day of month, so all days of the month count.
For Joomla 1.5 sites use the # character as delimiter instead of the | character when experiencing lost rules during save of the Time Ruler settings.

So some rule of:
08:00-16:30|mon-fri|*|jan-aug|2007-2008

will then read as:
08:00-16:30#mon-fri#*#jan-aug#2007-2008



In this area define any File Reference followed by the equal sign ('=') and the real path and filename to the file. The file needs to stay within the Joomla directory structure and be any type of file: Text File, HTML File, PHP-Script. This allows you to include arbitrary files in addition to modules.

Define the File References as per the following structure:

<File Reference>=path/to/file/and/filename.ext

Example:

file1=contribution/scripts/somescript.php
myflash=contribution/myflash.html
Only use relative paths, meaning paths that start without a “/”. See the example above…



Time Ruler will look for the Module ID and then call the associated module. Time Ruler itself does not output any code. With the Module Filter you may control if Time Ruler shall adhere to a modules published state, or not. The options are therefore:

  • Disregard published state of modules… Will call every module once its rule is passed, disregarding its published state.
  • Only show published modules … Will call only a module that is also published once its rule is passed.



Allows to set the style in which the called modules output shall be generated, set the desired HTML output that will be applied to the output of the modules controlled by Time Ruler.

This setting is only applicable when used with Joomla 1.0.x



With 'Show debug information' the module will open a new window and show information on the rules, if passed or not, files missing to file references and more. Use this to see if rules are passed or as help in support issues. In normal operation, this option may stay at 'No debug information'.