Scuba Logger

Introduction

This is the help page for my Scuba Logger plugin for WordPress. It allows you to log dives so that they can be easily included in posts and searched. For example, you can automatically include a table in a post giving the details of a particular dive. You can also search the log, for example, to find all dives greater than 30 metres. Finally, you can report simple statistics about your log such as the total number of minutes underwater.

The plugin can be installed through the WordPress admin interface (just search for ‘Scuba Logger’). Once installed and activated, dives can be entered from Tools -> Scuba Logger. You can include as much or as little detail as you like for each dive. The only required information is the dive number, which must be unique.

Entering Dives in the Log

Once the plugin is installed, you can enter dives in the dive log by going to the admin area of your WordPress blog, and then to Tools -> Scuba Logger. There, you’ll see a form that looks like this:

Dive Log Entry Form

The dive number is the only mandatory field. It must be a positive number that has not been used already. Usually your first dive would be dive number 1, your second, dive number 2, etc. The following table gives a summary what can/should be entered in the remaining fields:

Field Explanation Notes
Date Date of the dive Chrome: choose a date from the chooser, or enter DD/MM/YYYY. Safari/Firefox: enter date in format YYYY-MM-DD.
Dive Site Name of the particular dive site Text; 100-character limit
Location The closest town or area to the dive site Text; 100-character limit
Objective The objective of the dive (e.g. ‘tourism’, ‘recover lost weight belt’) Text; 100-character limit
Buddy Buddy for the dive Text; 100-character limit
Time down The time you descended Chrome: choose a time with the chooser. Safari/Firefox, enter a time in 24-hour format: HH:MM.
Dive time The duration of the dive in minutes Must be a (positive) whole number
Max Depth The maximum depth reached during the dive Must be a (positive) number
Average Depth The average depth during the dive Must be a (positive) number
Water Temp The water temperature Must be a number
Visibility The visibility distance Must be a number
Boat Name The name of the boat if it was a boat dive Text; 100-character limit
Air Temp The air temperature Must be a number
Weather Short description of the weather Text; 100-character limit
Sea Conditions Short description of the weather Text; 100-character limit
Dive attributes checkboxes Attributes with which to tag a dive Check the appropriate ones
Notes Important notes about dive – not intended to be a full description (these can go in the blog posts themselves). Text; 10,000-character limit

If you prefer imperial units, you can change to feet and Fahrenheit in Settings -> Scuba Logger. The units only affect how the dive is displayed, no numerical conversion is done.

When you have entered all the details you want, click ‘Save Dive’. The dive will now be added to the list of dives below the form. If any of the details were entered incorrectly (e.g. the dive number is not unique) an error message will be displayed and you’ll get a chance to fix the problem.

Putting Dive Summaries in Blog Posts

To include a table summarising a dive in a WordPress blog post, you can use the shortcode:

[scubalogger type="dive" divenum="62"]

where divenum is the number of the dive you want to include. This produces a table summarising the dive like this:

Place:Old Man's Hat Buddy:Eithne
Weather:Warm, moderate wind Type:Boat (Sea Life V)
Max. depth (m):20.4 Visibility (m):10
Time down:11:22 Dive time (mins):40
Average depth (m):11.3 Water temp. (C):21.0

If you want to use a single table to summarise two dives (if you did two dives on a single boat outing for example, and want to write about them together in one blog post), you can use:

[scubalogger type="doubledive" divenum1="70" divenum2="71"]

This produces a table like:

 Dive 1Dive 2  Dive 1Dive 2
Place:Semle WreckAluminium Pidgeon Buddy:Eithne
Weather:Fine, warm Type:Boat
Max. depth (m):39.022.8 Visibility (m):2015
Time down:08:4710:39 Dive time (mins):4453
Average depth (m):15.212.2 Water temp. (C):26.026.0

One final way is to give brief summaries of a selection of dives in a single table, using:

[scubalogger type="summarytable" divenums="111,112,113,114"]

This produces a table like:

Dive # Date Time Down Dive Time (mins) Max Depth (m) Average Depth (m) Water Temp. (C) Objective -- Notes
111 2013-10-12 14:18:00 45 7.6 4.2 19.0 Assist on OWC Dive 1/4 -- Instructor: Doug, 3 students
112 2013-10-12 10:36:00 45 9.4 5.2 19.0 Assist on OWC Dive 2/4 -- Instructor: Doug, 3 students
113 2013-10-13 13:36:00 32 7.3 5.2 19.0 Assist on OWC Dive 3/4 -- Instructor: Doug, 3 students
114 2013-10-13 15:20:00 40 17.0 9.4 19.0 Assist on OWC Dive 4/4 -- Instructor: Doug, 3 students

Giving Statistics of the Dive Log

You can give basic statistics about the log too, for example:

I have done [scubalogger type="logstat" detail=”numdives”] dives ([scubalogger type="logstat" detail="numloggeddives"] are logged here), and I have spent a total of [scubalogger type="logstat" detail="timeunderwater"] minutes underwater. That is the same as [scubalogger type="logstat" detail="timeunderwater" format="hm"], or [scubalogger type="logstat" detail="timeunderwater" format="dhm"].

will produce a sentence like:

I have done 148 dives (148 are logged here), and I have spent a total of 5929 minutes underwater. That is the same as 98 hours and 49 minutes, or 4 days, 2 hours and 49 minutes.

The statistics will be automatically updated as the dive log grows.

If you want to give the total time underwater up to a particular dive, use for example: [scubalogger type="logstat" detail="timeunderwater" format="hm" uptodive="20"].

To Add a Search Page to your Dive Log

The ‘Search Dives’ link at the top allows you to search the dive log for various types of dives, depth ranges, locations etc. To include a search page in your dive log, just add a new page and include the short code:

[scubalogger type="querylogform"]

Now it’s really easy to answer questions like ‘how many night dives have I done?’ or ‘how many wreck dives have I done that were deeper than 30 metres?’, etc. This is one of the major benefits of using Scuba Logger – check out the search page on this site.

Planned Improvements / Features

The following are planned new features / improvements:

  • Imperial or Metric units (currently all units are metric) – this is implemented in version 0.1.8. Go to Settings -> Scuba Logger
  • User-defined dive attributes
  • More styles of tables for displaying dives from log.

Leave a comment if you have ideas, or to give a link to your Scuba Logger dive log.

Leave a Reply