The Hiztory Plugin – This Day in History on Your WordPress Website

We’ve become accustomed to writing snippets of shortcode – both the good and bad – and publishing here on Internoetics… but we’ve generally refrained from venturing into the WordPress.org plugin realm because of the issues generally associated with the commitment that comes with continued development of anything once you release it as a more formal ‘product’. That safe distance we’ve maintained has come to an end.

We introduced you to some shortcode last week that would render ‘This Day in History’ information on your WordPress website (utilising our little API at Hiztory.org). The code was flawed for one reason above any other: it would only retrieve a single result. It didn’t take more than a few hours before we had people asking for something that would permit them to add multiple events. What we’ll provide on this post will provide that feature.

Although Hiztory was originally built for one of our aviation websites, and despite aviation content being a clear focus moving forward, it hasn’t detracted us form building upon the data and adding multiple other modules that relate to various interest groups or countries. Despite not having released these ‘other’ components into the wild (just yet), we though we’d release version 0.1 of a WordPress plugin that eases the techo-burden of displaying this and all future content on your website.

Plugin Title: Hiztory
Description: Display historical events on your WordPress website with shortcode.
Download (downloaded 596 times) | Plugin Page

Primary Differences

If you’re using the shortcode we’ve previously published, sadly, changing over to the plugin will require you to generate new shortcode in your posts and/or pages; it became apparent quite quickly that the options that we formerly provided weren’t the most appropriate. However, the change is advantageous. The time associated with the API request is now the time associated with your blog; we always expected to provide an option to include a GMT offset… but that isn’t necessary since we now plug into your own WordPress website’s timezone (as defined in SettingsGeneral). We now permit up to 15 results to be rendered on your website and have coded in a few extras that’ll permit you to offer a measure of customisation with how results are displayed.

Installing Hiztory

Like any plugin that you’ve ever installed into WordPress, it can be installed in a number of different ways.

The easiest method of installation is via the ‘Install Plugins’ menu on your own WordPress blog via  Plugins  ->  Add New  in the left hand menu. Search for “hiztory“. Since it’s essentially a misspelled word, we’re the only result with that keyword. Click Install Now… then Activate.

Of course, you could just download the zip file directly and then either upload it via the Upload option on the ‘Install Plugin’ administration page referenced above… or you could simply FTP the contents into your wp-content/plugins directory.

Settings

Once you click on Activate, you’ll see a Settings menu; select it. Alternatively, you will now be able to select the History Shortcode option from your Settings menu.

Hiztory Setting from the WP Settings Menu

Selecting the settings menu directs you to the shortcode generator

The Hiztory shortcode generator is a form that’ll construct shortcode based on the (non-default) options your select.

Hiztory Shortcode Generator

By clicking on  Get Shortcode  at this point we’ll just generate default usage by way of nothing other than the [hiztory] shortcode.

Default Usage

The default output provides us with one historical aviation event. You’ll likely want to change this!

Three Royal Naval Air Service BE.2 cs, one of them flown by Flight Lieutenant Egbert Cadbury, shoot down the German Zeppelin L 21 off Lowestoft, England. - 28th November 1916

Using the shortcode generator, and as an example, we’ll generate three results that’ll be cached locally for two hours. We’ll also change the formatting of the date so it renders as Sun 3rd Dec, 1944… and we’ll apply style to the date with html tags.

[hiztory number="3" datetags="em,strong" dateformat="D jS M, Y" cache="7200"]

Copy and paste the shortcode into your post/page text editor

You should note that the datetags, or the html formatting for the date, doesn’t include the < or > tag; this is automatically applied with the results.

The shortcode will generate the following result:

  • Japan Airlines Flight 446 was a Japan Airlines flight from Sheremetyevo International Airport of Moscow, Russian SFSR, Soviet Union to Tokyo International Airport (Haneda Airport) in ?ta, Tokyo, Japan. The DC-8-62 on the route crashed during the initial climb phase upon takeoff from Sheremetyevo. While it is established by investigation that the direct reason for the crash was stalling shortly after takeoff, the Soviet Accident Investigation Committee noted the possibility of accidental deployment of the spoilers and reduced thrust due to engine problems as the cause for this accident. - Tue 28th Nov, 1972
  • Sun Way Flight 4412, aoperated by Ilyushin Il-76 4L-GNI on a cargo flight crashed in a populated area of Karachi, Pakistan, shortly after taking off from Jinnah International Airport. All eight people on board were killed, as were a further two people on the ground. The aircraft was reported to have been trying to return to Jinnah after suffering an engine fire. - Sun 28th Nov, 2010
  • Avient Aviation Flight 324, operated by McDonnell Douglas MD-11 F Z-BAV, crashed on take-off from Shanghai Pudong International Airport on a flight to Bishkek – Manas International Airport, Kyrgyzstan with the loss of 3 lives. The plane was written-off. - Sat 28th Nov, 2009

Of course, you can choose not to display results in a list (as is the default case). In the next example, we’ll retrieve three historical events and format them in a block of text. By default, we’ll add the <br> tags after each event (you can change this in the option titled ‘After post HTML‘).

[hiztory number="3" type="events" datetags="strong" returnaslist="0" dateformat="l jS M, Y" cache="7200"]

Result:

Norway votes against joining European Union - Monday 28th Nov, 1994
70th CFL Grey Cup: Edmonton Eskimos defeats Toronto Argonauts, 32-16 - Sunday 28th Nov, 1982
71st Davis Cup: USA beats France in Grenoble (4-1) - Sunday 28th Nov, 1982

 

Retrieving Results for Another Date

By default, we’ll select the date associated with your WordPress installation in making our request to the API. At times, however, it might be necessary to render results for another arbitrary date.

By unticking the option that says “Yes, use WordPress blog time of for data requests?”, a date option appears. Keep in mind that this is a static date reference that won’t change over time.

Other Features

Some other features of the shortcode generation include:

  • Events relating to deaths, births, events and aviation.
  • Results between 1 and 15.
  • Custom separator between the content and date.
  • Defined or custom date format (using PHP’s date() function).

Using Shortcode in a Sidebar?

By default, WordPress doesn’t enable the filter that permits you to use shortcode in a sidebar widget. If you plan on using this plugin, a sidebar widget is probably the most appropriate place to display random history. To enable shortcode in widgets, we’ve create a simple form that’ll activate that function globally; it works outside our plugin as well.

Enable/Disable Sidebar Shortcode Support

RSS Feeds

There are a number of RSS feeds available that generate random output for each day. They are:

Births: http://www.hiztory.org/rss/birth.rss
Deaths: http://www.hiztory.org/rss/death.rss
Events: http://www.hiztory.org/rss/event.rss
Aviation: http://www.hiztory.org/rss/aviation.rss

The feeds can be consumed by most blogs and other CMS platforms by way of widgets and other types of integrated functionality. Certainly, in WordPress, there are countless plugins that’ll render feeds in different ways – not to mention shortcode, including our own.

The feeds are based on Australian Eastern Standard Time. If you’re elsewhere in the world, you can access a local feed using the following format:

http://www.hiztory.org/10/23/aviation.rss

Format is as follows: http://www.hiztory.org/[month]/[date]/[data-type].rss

The Future

We’ll build upon both the API and this plugin based almost exclusively on the feedback we receive. Some of the features that we’ll be including sooner rather than later include the following:

  • Ability to render results beyond the 15 limit currently imposed.
  • The API will shortly permit multiple events from multiple user defined categories (at the moment we only allow one category per request).
  • Geo-specific history queries
  • Additional categories (tech, marine, rail, country specific etc.).
  • Keyword filtering.

As a matter of interest, the shortcode we use to build the WordPress download box (with the download count) is scheduled in late January.

Let us know what you think.

Download from WordPress

Plugin Title: Hiztory
Description: Display historical events on your WordPress website with shortcode.
Download (downloaded 596 times) | Plugin Page
First Name:
Your Email Address:
 


If you liked this article, you may also like:

  1. “This Day in History” Information on Your WordPress Website with Shortcode
  2. WordPress Plugin: Lorem Ipsum Shortcode Generator
  3. Add a Facebook Follow/Subscribe Button to Your WordPress Website with Shortcode
  4. All Dates of a Year Into an Array with PHP
  5. Display a Random Quote on your Website with WordPress Shortcode
About Marty

is a passionate web developer from Sydney, Australia. He owns about 600 websites and makes a healthy living from working the web. As a day job, he works as a pilot for an international airline. Follow Marty on Twitter or Google+.

Trackbacks

  1. […] one of our aviation websites , we use a version of our Hiztory plugin to render a large amount of aviation history relevant to each day of the year (it’s actually […]

Please leave a comment or question!

*