Help Text as a PDF file, single html file, or split into multiple html files
The Digital Athletic Log

next up previous contents
Next: 13 Split Time Wristband Up: Digital Athletic Log Help Previous: 11 Importing Data

Subsections


12 Advanced Options and Features


12.1 Linking Keyword and Sport Entries

Keywords can be used to add fields to sport entries. This allows you to customize the Digital Athletic Log for your particular needs.

For example, you could store the maximum depth information with a sport entry for scuba diving. Or you could store the amount of time spent in a training zone for a running entry. Fields are added to a sport entry by linking keyword entries to the sport entry.

Entries are linked by setting the keyword entry's date and time to match the sport entry's date and time. The sport entry form has a keyword menu for doing this automatically.

When you change the date or time of a SPORT entry linked to keyword entries, the keyword entries' date and time are updated to maintain the link.

Sport entries, which have keywords linked to them, display a `K' in the `other' column of the sport entry log.

To unlink a keyword entry from a sport entry, change the KEYWORD entry's date or time.


12.2 Making Entries By Email

In addition to making entries to the Digital Athletic Log via the web, you may make entries to your training log by email. This is useful if you can't get to a web browser, but you have access to email. Most cell phones can be used to send an email via simple text message.

To make an entry via email you must send a formatted email to entry@athleticlog.org. The Digital Athletic Log ingests email to the training log at 05 and 35 minutes past each hour.

12.2.1 Basic Email Entry Addition

The following line in the body of an email sent to the Digital Athletic Log creates a log entry:

u=joeuser|s=running|d=8/2/04|t=4pm|min=21|dst=5

This adds a `running' entry to joeuser's training log, with a date of 2004-08-02, a time of 16:00:00, a duration of 21 minutes, and a distance of 5 (using default units for `running').

Notice the fields are separated by the `$\mid$' (shift `$\backslash$') character or any form of white space (space, tab, newline, etc.). Each field takes the form $fieldname=value$. The entry MUST contain the username field (`u') and either a sport (`s') or keyword (`k') fields, or it will not be ingested to the log.

The example below shows the same entry written with spaces and newlines separating the fields:

u=joeuser s=running
d=8/2/04 t=4pm
min=21 dst=5

When an entry is made by email, the Digital Athletic Log sends a receipt summarizing the entry to the email address which made the entry and to the email address on file for the username. The receipt sometimes gets tagged as spam by email software.

If the entry's date (`d') or time (`t') fields are not specified, the Digital Athletic Log will set them to the time the email was ingested.

Sports and keywords may be specified either by their name or their ID number. If the sport's or keyword's name has spaces in it, do not type the spaces. For example, if the sport name is ``Weight Training'', then the sport field in the email would be ``s=weighttraining''. The sport and keyword names are case insensitive. With the exception of spaces, the names must be entered verbatim. If `2' is the ID number for the `running', the first example can be written:

u=joeuser s=2 d=8/2/04 t=4pm min=21 dst=5

Making a keyword entry by email is very similar to making sport entry. The sport field (`s') is replaced by the keyword field (`k'). The keyword value is entered using the keyword value field ('kv').

u=joeuser	 k=pushups d=8/2/04 t=4pm kv=60

The above example would make an keyword entry of 60 pushups in joeuser's training log for 2004-08-02 at 16:00.

Below is a list of the fields recognized by the Digital Athletic Log.

Fields for both sport and keyword entries:
    u...username (required)
    d...date of entry
    t...time of entry

Fields for keyword entries:
    k...keyword or keyword id number
   kv...keyword value

Fields for sports entries:
    s...sport name or id number
  dst...distance in sport's default units
   hr...duration hours
  min...duration minutes
  sec...duration seconds
  ahr...average heart rate
  mhr...maximum heart rate
    r...route id number
   tp...temperature (default is your default temp units)
   tu...temperature units (overrides your default)
    a...altitude (in users default altitude units)
   au...altitude units (overrides user's defaults)
    e...change in elevation (in users default altitude units)
   eu...change in elevation units (overrides user's defaults)
   pe...perceived effort (valid range 6 to 20)

Field order does not matter. No field should be duplicated.

The Digital Athletic Log will send you an email if it can not ingest the entries to the log. Possible causes include:

-
An invalid username or no username specified.
-
The sport or keyword name/id number does not belong to the username.
-
Neither a keyword nor a sport was specified.
-
The route id number does not belong to the username.

You may override the sport's default units with the `du' field. Valid distance abbreviations are m, mi, km, and yd. The following example specifies a 5 km run.

u=joeuser|s=running|d=8/2/04|t=4pm|min=21|dst=5|du=km|

You may create a linked sport and keyword entry (both having the same date and time) by specifying both in a single entry. Combining the previous examples to create a `running' sport entry which is linked to a 'pushup' keyword entry, send the following:

u=joeuser|s=running|d=8/2/04|t=4pm|min=21|dst=5|du=km|k=pushups|kv=100|

12.2.2 The Remarks Field

The remarks fields is unique in that it can span multiple lines. To span multiple lines it MUST end with a `$\mid$'. If the remarks fields does not end with a `$\mid$', only the first line is read as the remarks. Consider the following example where the remarks will span multiple lines:

u=joeuser
s=running
d=8/2/04
t=4pm
min=21
dst=5
rmks= This set of remarks
spans multiple lines.
It ends with a vertical bar|

Then consider this example, where only the first line of the 'rmks' field will be saved as the remarks:

u=joeuser
s=running
d=8/2/04
t=4pm
min=21
dst=5
rmks= Only this line will be read
these lines will not be read
because there is NO vertical bar at
the end of the remarks field.

12.2.3 Multiple Entries Per Email

You can enter multiple entries per email by separating them with a `-ne-' (next entry) tag. The following example makes two entries from a single email:

u=joeuser|s=2|d=8/2/04|t=4pm|min=21|dst=5|du=km|
-ne-
u=joeuser|s=2|d=8/3/04|t=4:15pm|min=21|sec=34|dst=4.8|du=km|

Both entries must have a username field (`u') and either a sport (`s') or keyword (`k') field.

12.2.4 Comments

Text from the characters `//' to the end of the line is ignored, as is any text between `/*' and `*/'. Lines with no fields in them are also ignored. In the text below, the middle line of the 'rmks' field will not be included in the entry's remarks.

u=joeuser|s=running|d=8/2/04|t=4pm
min=21|dst=5
rmks= most of this remark will be read
// but not this line because it it a comment 
however, this line will be read.|

A note, with the email address which made the entry, is added to the remarks field of entries made by email. Normal viewing of the log hides this note. Entries made by email have an `@' symbol in the `other' column of the log.

I have done a lot of testing on the email entry, but I would encourage you to cc: yourself on emails, until you convince yourself that the entries are being made correctly. If you have problems with the email entry feature, please email me (the site administrator) with the email address from which you sent the entry, the date and time you sent the message, the text of the message (if you have a copy), and a description of the problem.


12.2.5 Email Input Admin Page

The ``Email Input Admin'' page (the ``entry by email'' link) displays a list of your sport, keyword, and route ID numbers. It also displays a list of all the field tags which can specify data in an email entry. These lists may be sent to an email address for reference.

The field tag list can be sent in a long format, abbreviated, or really abbreviated format:

Field Tag List in Long Format:

Fields for both sport and keyword entries:
    u...username (required)
    d...date of entry
    t...time of entry

Fields for keyword entries:
    k...keyword or keyword id number
   kv...keyword value

Fields for sports entries:
    s...sport name or id number
  dst...distance in sport's default units
   hr...duration hours
  min...duration minutes
  sec...duration seconds
  ahr...average heart rate
  mhr...maximum heart rate
    r...route id number
   tp...temperature (default is your default temp units)
   tu...temperature units (overrides your default)
    a...altitude (in users default altitude units)
   au...altitude units (overrides user's defaults)
    e...change in elevation (in users default altitude units)
   eu...change in elevation units (overrides user's defaults)
   pe...perceived effort (valid range 6 to 20)

Field Tag List in Abbreviated Format

Both:
u=user,d=date,t=time
Kwd:
k=keyword,kv=kw value
Sports:
s=sport,dst=distance,hr=hours,min=minutes,sec=seconds,ahr=ave HR,mhr=max HR,r=route,tp=temp,tu=temp units,a=alt,au=alt units,e=delta elev,eu=delta elev units,pe=effort

Field Tag List in Really Abbreviated Format

u,d,t
k,kv
s,dst,hr,min,sec,ahr,mhr,r,tp,tu,a,au,e,eu,pe


12.3 Plotting Data in the Remarks Fields

You may generate plots from data saved in the remarks field of either a keyword or sport entry. This allows you to store and plot: lap/mile splits, results of a conconi or VO2 max test, a terrain profile, etc.

To generate a plot from data in the remarks, enter the `-plot-' tag three time. This separates the remarks into 4 sections (Remarks -plot- Header Info -plot- Data -plot- More Remarks).

Both the remark section and the header section may be empty.

The header section contains the plot title, x axis label, and y axis label all separated by a `;'. The data points are stored as ordered pairs, with each pair separated by a `;' in the data section. For example:

Your remarks here. Just enter text as your normally would
-plot-
title for the plot;
x axis label;
y axis label;
-plot-
x1,y1;
x2,y2;
x3,y2;
etc...
-plot-

For the remarks to be plotted it MUST have the following:

-
3 and only 3 `-plot-' tags
-
At least one data point
-
The same number of commas and semi-colons in the data section

Entries with plot data in their remarks have a `P' displayed in the `other' column of the view log. In normal log viewing the plot data is hidden. Editing the entry will display all the data in the remarks section.

This example uses data from a conconi test. If you are not sure what a Conconi test is, see Reference [2] for more information.

I created a keyword called `Conconi Test'. I stored the data in the remarks section of the keyword entry.

Figure 33: A sample plot of data entered in the remarks field.
Image plot-remarks

-plot-
Conconi Test;
Speed, Running [mph];
Heart Rate [BPM];
-plot-
6,123;6,148;6.5,152;7,160;7.5,166;
8,172;8.5,176;9,180;9.5,184;10,187;
10.5,190;
-plot-

If you enter data to be plotted in the remarks section and no plot appears after you ``save changes'' to the entry, check the following:

  1. Is the plot tag `-plot-' used three times in the remarks section? If not, no plot will be generated.
  2. Did you skip a comma or semi-colon in the data section? If there are any data points that do not have two numbers, then no plot will be generated. For example ``1,0;2,3.2,3;4,5.6; will cause the plot to fail because the middle data point has three numbers in it 2, 3.2, and 3.


12.4 Setting Up Your Weather Report

If you provide the correct city and state in your profile, the Digital Athletic Log will display your current weather conditions and provide a link to your forecast from the weather underground.

12.4.1 Within the United States

Figure 34: A sample weather display.
Image Annapolis

If the city and state you entered does not match a location on the Weather Underground site, follow the link to display the forecast for your zip code (available in the US only). When the forecast is displayed it will provide you with the correct city and state name.

If you follow the `Click here for your Weather Sticker' link at the bottom of the weather underground page, the URL in your browser will be:

http://www.wunderground.com/geo/BannerPromo/US/{state}/{city}.html

Where {state} and {city} are the values you should enter for your city and state.

12.4.2 Outside the United States

To display weather for locations outside the United States you need to do the following:

  1. Enter ``x'' in the state field. This tells the log to lookup a forecast outside the US.
  2. Enter the 5 digit weather station ID number for your location in the zip code field.

You can get the five digit weather station ID number by emailing me with your location, or by locating your city's forecast on the weather underground. The URL in your browser will give you the station id number. For example, the URL for Perth Western Australia's forecast is:

http://www.wunderground.com/global/stations/94610.html The weather station ID number is the 5 digits just before the ``.html'', or 94610 in this case.


12.5 Tracking Equipment Usage

The Digital Athletic Log will also track equipment usage. It will display the total distance and time a piece of equipment has been used. There are two steps to setup equipment tracking in the log.

  1. Create a keyword for the piece of equipment. For example, a keyword called ``Trek 2200'' or ``New Balance 784''. The keyword's units don't matter for equipment tracking purposes.
  2. Create an equipment definition (the edit your...equipment link). The equipment definition pairs a sport with a keyword.

To indicate that a particular piece of equipment has been used during a sport entry, link the equipment's keyword to the sport entry. You link a keyword to a sport entry by selecting the keyword from the ``keyword to add'' menu on the ``sport entry'' page. See Section 12.1 for more information on linking keyword and sport entries.

The main page will display a summary of the total distance and time the equipment definition has been logged. The distances and times are based on the distances and times entered for the sport entry. The keyword

Figure 35: An example of the equipment totals.
Image equip_total


12.6 Sharing Your Log With Others

You can share your log entries with others. This allows others to see your recent log entries and your current goal progress.

Edit your profile to set the level sharing for your log. There are four levels of log sharing.

  1. Do NOT share your log with anyone. This is the default setting and it overrides all other sharing level.
  2. Only share your log with users on your friends list. When this sharing level is set, you may add and remove other log users from your ``friends list'', using the ``Edit your... friend list'' link. Only these users may see your recent log entries.
  3. Share your log with all Digital Athletic Log users. Anyone logged into the Digital Athletic Log may view your recent log entries.
  4. Share your log with the whole world. People do not have to be logged into the Digital Athletic Log to view your recent entries. This is if you want to share your log with people who don't have accounts on the Digital Athletic Log.

To view other users shared logs, follow the the ``View Shared Logs'' link.


12.6.1 RSS Feeds

If you have a level of sharing enabled, you and others can get an RSS feed with your last 7 days of sport entries. This allows your friends or coaches to follow your training in their favorite news/rss reader. Additionally, many blogs will accept RSS feeds. So using an RSS feed is a good way of incorporating your recent workouts into your blog.

To get the RSS feed for your site, first enable some level of sharing in your profile (as described above). Then go to the view shared logs page. When you display a user's recent entries with this page, there is a link to the RSS feed. Follow the RSS link. The URL for RSS is in your browser's address bar. Copy and paste this URL into your RSS reader or blog.

If at anytime you would like to stop making your RSS feed available, disable sharing in your profile and no further RSS feeds will transmitted.


next up previous contents
Next: 13 Split Time Wristband Up: Digital Athletic Log Help Previous: 11 Importing Data   Contents
Roger Cortesi 2006-11-12