Documentation

Brand: Twinpictures Plugin Oven | Category: WordPress Plugin | Author: Baden Coleman
Updated: 5 June, 2014

‘Rocstar’ Countdown Widget Options – Rockstar Features are available to those that think the plugin is totally worth 3 bucks

Sidebar Widget

The sidebar widget options should be relatively self-explanatory. Regardless, below is a line-by-line description of each Widget Option and Shortcode Atribute

Title

This is the optional title to display above the sidebar widget.

Target Date

This is the date that the target ‘launch’ event is to take place. To set the date, simply click the input filed and a fancy jQeury Datepicker widget will magically appear to assist in selecting the perfect date. Not that you need help in planning the perfect date, you romantic, you.

Magical jQuery Datepicker

Target Time

This area is where the time is set for the target ‘launch’ event. The format is the globally accepted HH:MM:SS, where HH = Hours 00 – 23, MM = Minutes 00 – 59 and SS is not the Schutzstaffel but rather the more benign ISO designator for Seconds 00 – 59.

Omit Weeks

By default Weeks will be displayed. Selecting ‘Yes’ will prevent weeks from being displayed. For events that are more than seven days away, omitting weeks will increasing the amount of days by a factor of seven. Why seven? Because there are exactly seven days in a week. Please refer to Wikipedia for a more detailed description of a week

Style

We dig your style, Dude. Therefore a number of countdown styles are available to mix and match any website. Please refer to T(-) Countdown Screenshots to view examples of all the styles that currently are delivered with the plugin.

Inject Script

This controles where the plugin inserts the JavaScript required for the countdown to function. Normally the JavaScript is inserted in the WordPress footer template. If for some reason your template does not have a footer, select Inline to have the JavaScript injected immediately after the countdown.

Rockstar Features

If you think the plugin is totally worth three bucks, then you will be presented with additional features—like a boss.

Above Countdown

The HTML that is to be displayed above the countdown.

Below Countdown

The HTML that is to be displayed below the countdown.

When Countdown Reaches Zero

The HTML that is to be displayed when the countdown reaches zero—and where to display this HTML:

  • Above The Countdown: Replace or display the HTML above the countdown.
  • Below The Countdown: Replace or display the HTML below the countdown.
  • Entire Widget: Replace the entire countdown widget with the HTML.
  • Count Up: Do not display any HTML, but rather have the countdown start counting up.

Digit Titles

This area allows each of the titles for the various time elements to be changed.

Schedule Recurring Countdown

This is a non-intrusive promo for T(-) Countdown Control, a premium countdown plugin that adds a sort of command center—the ability to schedule and manage mulitple recurring T(-) Countdowns.

Shortcode

The shortcode [tminus] is used to insert a countdown into a post or page. In it’s simplest form the shortcode is: [tminus t="DD-MM-YYYY HH:MM:SS"/]. The shortcode can also be used to wrap HTML that will be displayed on launch: [tminus t= "DD-MM-YYYY HH:MM:SS"]HTML to be displayed when the countdown reaches zero.[/tminus] The following is a complete list of shortcode attributes for T(-) Countdown:

T Attribute – Launch Date and Time

[tminus t="+1 hour 45 minutes"/]
The t attribute is used to assigned a date and time in almost any format. If no t value is assigned, the default launch date and time is assigned Dec 20, 2012 at 20:12:20—mostly because it’s kind of a cool date.

Note: Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed.
To avoid potential ambiguity, it’s best to use ISO 8601 (YYYY-MM-DD)

  • DD-MM-YYYY HH:MM:SS
  • DD.MM.YYYY HH:MM:SS
  • MM/DD/YYYY HH:MM:SS
  • YYYY-MM-DD HH:MM:SS

ID Attribute

[tminus t="31-12-2012 23:59:59" id="new-years-eve"/]
A unique ID for the countdown element. If the id attribute is not defined, a unique, random number will be assigned.

Weeks Attribute

[tminus t="01.01.2014" weeks="wochen"/]
Replaces the default title for ‘weeks’.

Days Attribute

[tminus t="1/1/2014" days="tage"/]
Replaces the default title for ‘days’.

Hours Attribute

[tminus t="next Thursday" hours="stunden"/]
Replaces the default title for ‘hours’.

Minutes Attribute

[tminus t="20 December 2012" minutes="minuten"/]
Replaces the default title for ‘minutes’.

Seconds Attribute

[tminus t="2012-12-31 23:59:59" seconds="sekunden"/]
Replaces the default title for ‘seconds’.

Omitweeks Attribute

[tminus t="2012-12-20" omitweeks="true"/]
Omit the weeks ‘true’ or show the weeks ‘false’. Default is ‘false’.

Style Attribute

[tminus t="2011-12-20" style="carbonite"/]
Defines the style to be used by the countdown. Available styles include:

  • jedi (Default)
  • darth
  • carbonite
  • carbonlite
  • c-3po
  • TIE-fighter

Jsplacement Attribute

[tminus t="2012-12-20" jsplacement="inline"/]
Where to inject the required javascript (footer or inline). The default setting ‘footer’ is recommended.

Before Attribute

[tminus t="2012-12-20" before="<p>May the force...</p>"/]
The HTML to be displayed above the countdown.

After Attribute

[tminus t="2012-12-20" after="<p>...be with you.</p>"/]
The HTML to be displayed below the countdown.

Width Attribute

[tminus t="2012-12-20" width="300"/]
The pre-launch width in px of the countdown – default is ‘auto’.

Height Attribute

[tminus t="2012-12-20" height="200"/]
The pre-launch height in px of the countdown – default is ‘auto’.

Launchwidth Attribute

[tminus t="2012-12-20" launchwidth="400"/]
The post-launch width in px of the countdown – default is ‘auto’.

Launchheight Attribute

[tminus t="2012-12-20" launchheight="700"/]
The post-launch height in px of the countdown – default is ‘auto’.

Launchtarget Attribute

[tminus t="2012-12-20" launchtarget="below"/]
The area that the post-launch HTML is to be displayed in (above, below, countdown or countup – default is ‘countdown’)

Styles

With a little bit of CSS knowledge, the CSS files can be easily modified. Two of the included styles—C-3PO and TIE-fighter—are generated entirely with CSS and do not required editing image files. Be sure to backup any new or modified styles offline, as updating the plugin will remove any modifications. We are always happy when people let us know about a new style they have created. If you would like to have your super-awesome style included in a future T(-) Countdown release, please email the css file to:

Rate & Vote

We are very happy to offer this plugin to the great community of open-source lovin’ WordPress users. Now be a nice social netwookiee and visit T(-) Countdown at the WordPress Repo to rate the plugin. Don’t forget to let others know if everything worked for your configuration by voting in the compatibility section.

Blab To Others

Join the Twinpictures Facebook Page or hit us up on the Twitter. If you post a nice video review, let us know and we will be happy to include it on the Twinpictures YouTube Channel.