All Purpose Statistics Generator, FindStatGen3.gsk

V3.1.13 3-3-08


This version includes a few items that were in the Beta 3.1.12 release and some new additions:

1. Addition of Gibraltar flag and text to European map



2. New secondary title line which lists the total of Geocaches, other caches and Benchmarks if there are any. (Line won't appear if only Geocaches are in the database)



3. New option on Placed Form to select the number of Placed caches that are shown.



This defaults to 9999 (i.e. everything).


The following are the brand new items:

4. Addition of Montenegro and Serbia flags and text to maps. (Note that GC.com now supports Montenegro but, slightly confusingly, still calls Serbia 'Serbia and Montenegro'. The red portion of the map will also be the combined countries for the moment.)



5. Added support for links to Terracache Owners page in both Owner and Placed sections.

This feature will now sort and count Owner ID#s from both sites correctly, even if they happen to coincidentally use the same ID number.
(Note: I've written this so that other sites could also be added if they use similar style links derived from the Owner ID#)

6. Changed default section settings so that 'Placed' defaults to being excluded.

(A number of people have trouble with the Placed section - it's not as easy to make 'plug and play' because of the necessity of obtaining a full set of logs. I think it makes sense that this section is excluded by default for first time users. If you want to use it just select the right database in the 'Placed' database selector and choose Placed as one of the section options.)

Updated - please scroll down

V3.1.14 3-3-08

OK, I know, I know, don't try and add features at the last minute. I never learn...

Quick release to fix SQL bug in new Terracache feature when 'Include Own Finds in Placed' option was not selected.

Updated - please scroll down

V3.1.15 3-6-08

1. Spain/Estonia/Serbia fixed on Europe map

2. Vercheck gives more specific advice

3. Wherigo cache type added

5098

Updated - please scroll down

V 3.2.16 5-26-08

Many additions and tweaks. The major ones being:

1. Addition of optional cumulative find chart.



2. Optional Pie charts for many graphs.



Options for both new graphs are here:



3. Universal shaded maps.



Regions with cache finds are shaded in the same way as the existing World, US, Australia and Europe maps.



There is a new selectable Section:



and a new Map button



which opens a new Map form:



This check box list will be automatically populated from the Map Definition files in your macro folder.

There is a library of Map Definition files here. Download the data files for the maps you want and put those files in your 'macros' folder. When you run the macro it will find those files and you will then be able to select those maps for inclusion in your report.


4. Added 'Hide Archived' and 'Show Archived' buttons to the Placed Caches list.




5. Sort flags and data under maps in descending numerical order

6. Added IOM, Guerney and Jersey to European map

7. Added 'adopted' to hide stats

8. Added support for Geocaching Australia caches


3181

Updated - please scroll down

V3.2.18 7-1-08

A couple of small bug fixes:

1. Bug in Universal Maps if a State field name appears more than once in the list (Showed up in Poland - the macro was finding 'Pohjanmaa' inside 'Etelä-Pohjanmaa' and returning bad coordinates)

2. Fix for states/region names containing a single quote character.

5934

Updated - please scroll down

V3.3.19 9-27-08

A number of new features in this release. Note that to use it you will need to be running the latest build of GSAK - at least V7.2.3.

By far the most significant change is a move in thw code to using the new SQLite engine within GSAK. This is a much more powerful SQL engine than the previous SQL version and significantly speeds up the macro. With a large database you might expect to see at least a 50% reduction in the run time of the macro.

Changes/Additions/Bug fixes.

1. Added the cache icons to the Milestones, FTF and 'Finds by Type' tables. There is a corresponding 'Types?' option on the main form to select this option.





2. Fix the problem with Firefox occasionally inserting line breaks between the flag icons and country name under the maps.

3. Circumnavigation + Distance to Moon added to 'Total distance' in the Numbers section.



4. Added most FTFs in a month to 'Numbers' section

5. Cleaned up (and hopefully clarified) the main title bar to more clearly indicate the caches found from other sources (such as Terracaches and Benchmarks)

6. Updated the internal Help file system.


531

Updated - please scroll down

V3.3.20 9-29-08

Small bug fix for Title bar layout when the database contains caches from publishers other than GC.com. If you don't have any caches like this you don't need to worry about this update.


7188

Updated - please scroll down

V3.4.12 1-16-09

This will be the final release of FindStatGen that supports GSAK 7.2 - any future releases will require GSAK 7.5.


1. Some speed improvement to SQL database creation

2. Transparency added to cumulative charts shading




3. NEW - Finds By Bearing 'Radar' chart




4. NEW - Best Months Bar chart or Pie chart.




5. NEW - Last 365 Days statistics




6. FSG can now be called more than once by an external macro.


7. If an external macro calls FSG and a variable called $ExternalSettings is set with a number between 1 and 4 then FSG will use that as the settings group.


8. NEW - Time for Last 100 & 1000 finds




9. NEW - Finds by Year Cache Placed




10. NEW - 'Run date' selector.

This appears as a Date box on the initial form which will always default to the current date. Setting an earlier date will restrict all statistics to finds/logs with dates earlier than or equal to the new date.



It's quite fun to run your stats from a couple of years ago and see how things have changed!

Note: There's no specific error checking on this date. Set too early a date and you might have zero finds. Set a date in the future and some stats might not make sense with blank months at the end of the chart.


11. Short links using the "http://coord.info/" site used wherever possible to maximize the space available on the GC profile page.


12. Improved error message when there are logs with zero value Owner IDs in Placed caches - the offending caches are now listed in the message.


13. NEW - Added "Most cache types in a day" to the Some Numbers section.




14. Added new 'Minimal' style option to the 'Style color' option. This removes all background shading and other frippery so as to slim the output down by as many characters as possible. (In my case this reduced the file size from 145,000 to 115,000 characters)


15. NEW - Waymarks added to totals in header and Type section.





Note: For now at least you can only select 18 sections in total - even though there are quite a few more than that. If someone wants all the maps then it won't be possible to select all sections at the same time. Before I add more section selectors we'll have to see if that's a problem or not as I also suspect not all of them would fit in the GC profile anyway!



5239

Updated - please scroll down

FindStatGen3 V3.5.15 Release 3-29-09


NOTE: Requires GSAK 7.5.1.28 or later to run


1. Converted the saved settings to Sqlite. The FindStatGenData.dat file that used to store settings will be renamed as FindStatGenData.dat.old the first time you run this new beta. Your existing settings are converted over EXCEPT FOR the Section Order (because of #2 below). This is a one time conversion - it is recommended that you only run this new version from that point as, once the data file is converted, any changes made to the settings in the old version will not be reflected in the new.


2. NEW- dynamically generated Section Order form.



As mentioned above all your Section Orders will be reset to the default and will need re-entering with the new form. Make sure that all sections that you want to see are "enabled", otherwise they will be excluded from your generated HTML

From the options dialog, first click on "Section order"



Now "enable" sections by clicking on this button:



Finally you can use the + and - buttons on each item to move it up or down the list.


3. Main form layout changed to accommodate the new section form.
You now get to the sections through the 'Section Order' button.




4. NEW - County level maps.
(This is implemented through an extension to the 'Other Maps' section and uses chunks of code shamelessly plagiarized from KoosKoos and his County Mapping macro. Thanks Kevin! ) County maps fully support custom shadings.

Each map will need a map data file and the Master Index of all available Map Definition files is here.There is also a zip file of all US State County maps here. That zip file contains 52 custom county map files for the USA. Open the zip file and extract the data files for the states you want to map into your macros folder.

The macro will find those data files and present them as options in the 'Other Maps' check box list (accessed through the 'Maps' button underneath the report selector)



The maps are shaded by the number of finds in each county and have a key and list of counties under the map. Shading colors and the range bands are customizable map-by-map through the data files.



The map shading will default to the shades of red shown here. To edit this open up the map data file in a text editor (it's just plain text) and look for this section:

The $color1 - $color10 values are the shading colors for the bands as RGB hex colors. Edit these as you wish! The bands themselves are defined as $limit1 - $limit9

Note: If only $color1 and $color10 are defined then the macro will automatically create intermediate shades between those two extremes.

Here's a color picker that will help you generate the color codes in the right format.


5. NEW - Added Finds to Today's Date Section



Note: The percentages in this section are based on the best year.


6. NEW - Map, Language and Style data files (.dat) can optionally be placed in a sub-folder to the macros folder called FindStatGenData. (Both the macros folder and macros/FindStatGenData will be searched)


7. NEW - Second 'Notes' section ( Notes B )


8. NEW - Editable Titles for Notes sections



Displays as:



The Notes editor now has fields for both Notes sections and their Titles as well as individual Spell Check buttons. Both Notes sections can use HTML and can be positioned anywhere in the report using the Section Order editor.


9. NEW - Finds by Found Date section




10. NEW - Option to center output.
(Adds <center> tags around the entire <div> )




11. Macro's Internal Help system brought up to date.

12064

Updated - please scroll down

FindStatGen3 V3.6.18 Release 10-3-09


NOTE: Requires GSAK 7.6 or later to run


This release adds:

A. County Map File editor
This allows the editing of the shading colors and levels for the county level maps. This is accessed from the 'Maps' selector.





1. Select the map data file you want to edit from the combo box (this will list all the map data files you have in your macros or FindStatGenData folders). The map data file will be automatically loaded.

2. If it is a shaded map file then the 'Shading' section will show you the current limits and shading colors for that map. All or any of these may be edited. Note that the colors must be hex format RGB data preceded by a #.

If you select a non-shaded map file (the state and regional maps) then the Shading section will be blank.

3. You can choose to link the shading for this map to the Master Shading File. That allows you to use many maps and to alter the shading colors in just one place for all of them. The Master Shading File can be selected and edited just like any other map.



4. The color picker 4 may be used to obtain the hex color values in the right format. Drag the pointers around the wheel and the center square to find a color you like. Then click in the color data box above the picker and the text will automatically be selected ready to be copied and pasted into the appropriate color box.

5. You can refresh the display at any time so that the small bars by each color will update to show the colors you've chosen.

6. There is also limited access to the names fields of the map file. The fields that mustn't be changed as they will break the map are shown greyed out for information only.

7. You can change the field that the map uses for its data - for example the DeLorme maps may use any of the user data fields. Note: You will need to use byonke's Delorme map macro to update a GSAK cache field with the appropriate Delorme page information.

8. Once you finished your edits click 'Save'. You MUST Save every map you edit once you've finished with it or your changes will be lost.

9. Click 'Save & Exit' when you're done!



B. Check for missing Counties when running a County level map.

If there are blank county fields in the current map then the macro issues a warning and asks if it can update the data. It then runs GetCounty() and then automatically runs the routines to create the SQLite table again before picking up where it left off.
(This form has a 10 sec Delay before automatically proceeding on the 'Missing Counties' warning screen to allow unattended running.)





C. Added one-time run check box option to run GetCounty() for this run only.



Note: This will not work with Delorme or other shaded maps that don't use the County field



D. The Diff/Terr Chart is now a separate Section
in the Section Order editor and may be enabled/disabled and moved as with any other section independently of the Diff/Terr bar charts.

(Note: As with all new sections Diff/Terr Chart will initially show up Disabled and at the end of your report. You'll need to Enable it and move it to where you want it)



E. NEW - Finds By Placed Month Chart



Note: This is a new section so will need to be enabled and moved to the position you want through the Section Order editor.



F. NEW - Most consecutive months with a FTF



(I'm not such a FTF fiend these days as I used to be! )



G. New SQLite based centroid routine.
Runs blindingly fast! Around 0.1 sec on my 2700 finds as compared to about 5 seconds before.



H. NEW - Elevation (much requested and long prevaricated...)

This uses the methodology developed in this macro and uses the same SQLite database created by that macro (so your previous time spent waiting for data wont be wasted).

It queries the geonames.org satellite and shuttle data for elevation data at the best resolution it can. If the macro can't find a result at the 90m resolution it tries again with the 1km resolution data. The macro populates an SQLite database with the elevations of every waypoint in your Found dataabse. This database is cumulative and will build up into a permanent record so that the geonames server is hit as little as possible.

Warning: If you run this against a large database it may take a LONG time to run the first time through! The geonames.org website is a bit variable - when I first ran this it flew through a 2000 entry database in about 10-15 minutes however it can take a few seconds for each entry. It's free data so you get what you pay for!

Note that the best resolution available is 90m (300ft) - so, if the cache were near a cliff then the reported elevation could easily be wrong. Up a cliff when it should be in an adjacent valley or vice-versa.

The new Elevation section in FSG then uses this data to show a summary of the highest 10 and lowest points in the database and their elevations (in appropriate units) along with the average elevation. In further runs the GSAK database is filtered down to only those entries where we don't have data and we only hit the geonames server for those.

Once again - be warned that the first pass through your 'Found' database will be time consuming but after that it will only have to scan for newly added caches.

To use this section first go to 'Section Order' in the macros options and enable and position the new 'Elevation' section (it will initially be at the end of the list).



When the section runs it will warn you that there is missing elevation data and give you the option to update the missing elevations or continue without doing so. (This form will automatically disappear after 10 seconds to allow unattended running. Elevations will NOT be updated in that case.)



The result in FSG looks like this:



There is also an optional elevation chart. Note that this will default to OFF so check this if you want the chart to show.







I. NEW - Elevation editor

This is a fairly basic tool for editing the elevations if you have better data. It allows you to edit existing data, not add new, so the macro must have been allowed to add its own elevation before you try and change it.

Accessed through 'Elevation' button in the 'edit' cluster on the main options screen:



Elevations are stored separately for each database (following the GSAK philosophy very database is independent) so the routine will edit Elevations on caches in whichever database is currently selected as your 'Finds' database for FSG. This database is shown in the title of the editor screen.



To edit an elevation:

Enter the cache code (1) and click the 'Load' button (2) - this will display the current value in the edit window (3). You can then change this as desired and then click Update (4) to store it in the database.



J. NEW - Added Days/Find sort option to Placed caches





K. Map text CSS changed to be Webkit friendly.



L. All SQLite - Another major change which should be invisible. The Milestone corrections and Specials tables are now moved over to SQLite in the main database. The macro will (should) do a one time conversion of any existing legacy SQL tables to the new SQLite format and then rename the old files for archive.

These were the last two SQL tables left - everything is now in the one large SQLite database.



M. NEW - Custom Milestones. The current Milestone correction system allows the replacement of existing milestones but not the addition of new ones. You can now add any milestones you like to the corrected table and they will appear in the final output, whether or not they are in the normal numerical sequence. For example this shows the addition of the 111, 222 etc milestones to the normal 100 step sequence. (These repeated numbers have significance in Germany).



To make it easier to add new Milestones of this kind the editor now supports adding a milestone by just adding the number with a blank code field. If you do this then a milestone will be added using the cache that is already at that position with no need to enter the specific code.

For example, just entering '555' and a blank code field like this. Will cause the macro to look-up what should be milestone 555 and add it, and its correct date, as a custom milestone.



To summarize. Any milestones in the corrected table, whatever numbers they have, will now show in the final milestone list.





N. Added <subhead> tags to the Notes editor.

The Notes display system now recognizes pseudo <subhead> tags in the Notes text. Any text between the <subhead> and </subhead> tags will be formatted as normal FSG Heading lines with all the correct formatting.

For example this text:



Will get displayed like this:





O. NEW - Weekend/Weekday comparison





P. NEW - Total characters used in logs





Q. Change - Allow custom map names in State level maps

Currently the map file name in State level maps is fixed to to be the same as the country name. This change allows you to override that in the map data file by assigning a new name to the $MapName variable (as with the County level maps). For example hulmgulm's new Ireland map uses a map called Ireland2.gif and so his map data file contains the line $MapName = "Ireland2"


7284

Updated - please scroll down

FindStatGen3 V3.7.11 Release 1-7-10

Note: This release supports GSAK V7.7 and the new SQLite version introduced in 7.7 and later builds of 7.6.


1. Added St. Martin to world map and list of countries


2. NEW - Javascript toggle for county map totals

The tables under the shaded county maps now have two selector buttons - one to show the finds in descending numerical order of finds and the other in ascending alphabetical order.




3. Added State option as data source in map file editor
to facilitate shaded versions of country level maps.




4. Country flags for Milestones and FTF




5. Type icons in 'Most Cache types in a day'




6. Option to enable/disable flag icons




7. Flags added to Elevation and some Numbers lines




8. Elevation list only shows one zero elevation

A lot of people seem to have many caches with an elevation of zero ft/m as their lowest find. The macro now only shows one of them.



It should still fully display any finds with negative heights.


9. NEW - First very basic trial of style color generator.

This adds a new 'Style color' option called 'Generator'. When you select this option a new edit box appears next to the combo box where you enter a seed color as a hex RGB number.



This is used as a base color and other shades are automatically created from this. Warning - you can get some pretty nasty colors with some seeds! Lighter seed colors work better than dark ones. I take no responsibility for any nausea caused by your color selections.

This is pretty crude for now as I'm not sure how useful it is. If there seems merit then I'll add a color picker instead of that unfriendly edit box.

Technical note: Eight shades of the seed color are created. The seed itself, three lighter tones formed by overlaying it with various percentages of white and four darker ones by overlaying with percentages of a dark grey.


10. NEW - Placed charts

Two half size charts for Placed caches. (I like this size - might be an idea to change the large finds chart to this size)

The first is a cumulative finds on your caches over time and the second shows how the Caching Karma ratio changes as you find and hide more caches.



At the moment the two charts are enabled/disabled as a pair through a new entry on the Placed Stats menu:




1666

Updated - please scroll down

FindStatGen3 V3.8.03 Release 1-24-10

Interim release mainly to address the features broken by the changes to the GC.com Profile page.

1. Changes to html formatting to work with new limitations on GC.com profile page.

Known issue: Currently the numeric map overlays will still be incorrect in Google Chrome (and possibly Safari as it is also Webkit based). To fix this requires a change from GC.com which Raine and I have been discussing or a bugfix from Google.


2. Moved the 'Show elevation chart' option to the Elevation form

3. Added an option to override the automatic elevation interval calculation

4. Added an option to show/hide multiple locations with zero elevation on elevation table

These are all on a new form accessible through the 'Elevation' button on the main options form:




(The 'Edit Elevations' form to edit specific elevations for individual caches is now accessed as a sub-form to this screen)

11048

Updated - please scroll down

FindStatGen3 V3.9.90 Release 6-2-10

Note: Functionally equivalent to V3.9.12Beta


1. NEW - Options for Hide/Show Archived in 'Finders of My Caches'



All the figures and percentages are recalculated and displayed optionally with and without the archived caches.


2. NEW - Finds/Day chart

(Suggested by maccamob from a GCA chart by caughtatwork & Rabbitto.)




3. Increased size of Pie charts


4. Improved log word count algorithm

Improved algorithm, also strips out any "[Edited by...]" strings in logs to correct the word count. (Applies to both Own and Placed logs)
You will see changes in the log word counts. The old algorithm counted spaces and could be fooled by double spaces and line feeds. This is better, although not perfect.


5. Bug fix for erroneous South Australia shading on Australia map


6. Fix for map overlay numbers in all browsers including Google Chrome

I 'think' I've found a solution that works in all browsers for the overlay numbers on maps.


7. NEW - Multiple home coordinates

A long requested feature. FSG now supports having multiple 'Home' coordinates so that 'Distance from home' figures are correct and will be based on your 'Home' at the time of the find.

The entry screen is accessed through a new 'Home' button on the main options form.



Click this and you get this window:



You can enter coordinates and the dates at which your 'Home' changed to those coordinates into the database. The coordinates field accepts any of the coordinate format that GSAK normally accepts and will be converted to your selected display format in the main window. Note that only one entry is allowed for any particular date.

Type the text 'current' in the coordinates field rather than coordinates to make FSG use the currently set Home position from the selected date.

The screenshot above shows that the current position would be used from 5/3/2000 until 3/7/2007 when it changed to N 30° 12.234 W 97° 23.456, it then changed again to the North Pole on 6/11/2008 and back to the current position on 1/6/2009.

Note: FSG defaults to using the 'current' position for all caches found from 3 May 2000 - the day that Geocaching started. This is the same behavior as before.


8. NEW - Map data file installer

This simplifies the process of installing map data files. This is accessed through the 'Map' editor menu:



When selected the macro interrogates the GSAK web site and lists all available map data files:



Check the ones you want and click 'Install' and those files will be downloaded and installed into your macros\FindStatGenData folder. The list is generated dynamically every time and will always reflect the current releases available on GSAK.net.


9. Heat map shaded Diff/Terr chart.



And option to enable/disable heat map shading




10. Days with at least one FTF are shaded green on Finds By Found Date chart





11. Elevation uses Google if Geonames times out.

If the Geonames elevation server times out, the macro will now use the Google elevation data instead. The first elevation queried from Geonames will wait until the full timeout period however subsequent queries in the same batch will drop through to Google immediately.


12. Add state/country/flag information to Centroid location.



Note: I've also changed the way the Centroid map displays when you click the map button. It has the advantage that it displays within the page, no new window opens. This map is a static map but is clickable to get to a normal Google Map.


13. Shade the county list table under custom maps.




14. NEW - Most Countries in a day line.



(Only displays if there is more than one country - respects the Locationless setting.)


15. NEW - 'Most States in a day' and 'Most Counties in a day' lines.





16. NEW - 'Maximum distance in a day' map



Note: This is limited to a total of 40 plotted caches. If there are more than 40 then just the first and last 20 will be plotted.


17. NEW - Notes Test



Allows you to test that the html in the Notes sections renders correctly. Click the 'Test' button by the appropriate section and a small browser window will open rendering the entry.






18. NEW - Support for '10 Year Events'

Groundspeak have now confirmed that there will be no long term new cache type entry in GPX files or PQs for the one-off 10 Year Event caches. This, and the inconsistency in allowed cache naming, means that we have to mark these manually.

To mark an Event cache (either found or placed) as a 10 Year Event place the string 'FindStats10YearEvent' anywhere in the 'User Notes' section of the cache entry in GSAK. If the find is within the allowed dates and the marker string is present then it will be given the pseudo 10 Year type within FSG.





19. Add total number of finders to Placed section title.





20. Added distance from home to Centroid





21. Added flag for Curacao to World Map and code to map it in Netherland Antilles


22. Add flag icons for Placed Caches.


23. 'Locationless' icon re-invented.




14208

Updated - please scroll down

FindStatGen3 V4.0.21 Release 12-18-10

Note: Functionally equivalent to V4.0.20Beta

Requires GSAK 7.7.3.26 or later


1. NEW - Native shaded World Map replaces World66 version.



This is a replacement for the existing 'World Map' section that offers full shading. The shading colors and bands can be edited like any other shaded map via the Map Data File Editor. The map data file is called 'World Country Shading File'. If you already use the World Map section no option changes need to be made to see this map with its default settings.



2. NEW Europe shaded map



This replaces the current World66 Europe map with one that offers full shading. The shading colors and bands can be edited like any other shaded map via the Map Data File Editor. The map data file is called 'Europe Country Shading File'. If you already use the Europe Map section no option changes need to be made to see this map with its default settings.



3. NEW Canada shaded map



This replaces the current World66 Canadian Provinces map with one that offers full shading. The shading colors and bands can be edited like any other shaded map via the Map Data File Editor. The map data file is called 'Canada Country Shading File'. If you already use the Canadian Province Map section no option changes need to be made to see this map with its default settings.



4. NEW US States shaded map



This replaces the current World66 US State map with one that offers full shading. The shading colors and bands can be edited like any other shaded map via the Map Data File Editor. The map data file is called 'US State Shading File'. If you already use the US State Map section no option changes need to be made to see this map with its default settings.



5. US County Map



US County Map is now a new section that can be positioned anywhere in the report.



Even though it's a separate section the shading levels and colors can be customized using the Map File Editor like all the other shading maps.


(Note: In all the above new maps the map is constructed at macro run time using image space polygons and then stored as an image file on the GSAK server for efficient retrieval. Your Geocaching ID# is used to create the image names.)


6. Option in Map File Editor to use map overlays



Text overlays (when available) can thus be enabled/disabled for each map independently.



7. Option to use Legacy World66 maps
They've become unreliable but are still there for those who want to use them.





8. Added further higher resolution source databases to elevation retrieval

Elevation update now has five options which it will check in order of preference.

a. 3m/10m from usgs.net for USA only (Thanks to Cairngorm for this code!)
b. 30m resolution 'Aster' from Geonames
c. 90m resolution from Geonames
d. 1000m resolution from Geonames
e. Google

There is also a new option on the elevation update form to use the Aster 30m data. This setting is saved with the other settings. This data is good in some areas of the world but poor in others.



9. NEW - Notes sections now support <file>...</file> tags

If you insert a file name between <file></file> tags in the Notes file then FSG will look for a file of that name in your macros folder and the contents of that file will then be inserted into the Notes at that point.

It is suggested that other macros use this as a means for inserting their output text into the FSG output.

For example, macro 'Foobar.gsk' might create output html that you want to include in your stats. Instead of writing its output directly to the Notes file the Foobar.gsk macro writes it to a text file called "FoobarOutput.txt" in the gsak macros folder. You could then insert the following lines in your Notes B field:

FSG would then automatically include that text file in the Notes output along with the appropriate heading.

You can have as many sets of <file>...</file> tags as you like, each with a different file name, in both the Notes and Notes B sections. It is also supported in the 'Test' function in the Notes editor.

Notes:

a. FSG makes no attempt to check the contents of the files - whatever is there will get inserted verbatim.

b. File can contain plain text or html. However if you want to include any formatting then it must be html.

c. File extension can be anything you like. Foobar.foo would work fine.

d. You may also want to include a Subhead name and tags above the <file></file> tags.



10. Split out 'one find' on Finds Per Day chart
Much requested change, 'one find' days are now removed from the chart and listed below allowing the chart scale to be expanded.





11. Correct log dates using time logged
This has recently become a problem for those logging on GC.com using the iPhone app. When you use the iPhone to post a log then those logs are posted with an exact time rather than the generic '19:00' time logs get that are posted on the website. Logs posted late at night Seattle time could end up in the wrong day in GSAK.

The correction attempts to mimic the GC website logic and converts all logs dated 1-1-2008 onwards back to Seattle time from the Zulu time in the log. DST is accounted for with data included for years 2000 - 2015.

This correction is currently only applied to GC caches.

Note: iPhone users should expect to see changes to dates - I hope correctly! You may see changes that you didn't expect because prior erroneous dates were hidden - if they weren't Milestone caches then you likely didn't notice if the date was wrong.



12. County, State, Country Finds in a day correctly ordered
All 'Finds in a day' entries are now listed in Found order.



13. Add cache count to max dist in a day





14. Allow corrected Milestones after last calculated milestone

Allows the addition of a corrected milestone with a count greater than the last calculated milestone. e.g. previously, if you have 580 finds and a milestone increment of 100 then you couldn't create a corrected milestone for find 555. Now you can.



15. Finds by found days FTF count



New total FTF count data below 'Finds by Found Day' chart.



16. Support for new GA log links



17. Fix support for Saint Vincent and the Grenadines



18. Added Average distance to 'Finds by Miles from Home'





19. Added scroll bars to Special Caches editor to support more than 16 caches



20. Support 'Groundspeak HQ' and 'Lost and Found Celebration' pseudo cache types

As with other pseudo cache types these look for a trigger string in the User Notes section of the cache.

For 'Groundspeak HQ' place 'FindStatsGroundspeakHQ' in User Notes.
For 'Lost and Found Celebration' place 'FindStatsLostFound' in User Notes.



21. All pseudo cache types now also support the alternate 'pseudo trigger phrases

Alternate trigger phrases are: PseudoType10YearEvent, PseudoTypeGroundspeakHQ and, PseudoTypeLostFound



22. NEW Heat shaded bars and charts

Option to use 'heat' shading for bars and charts. This does not affect any maps which continue to use their own map shading files.

The Shaded bars options have been reformatted to offer this.



There are now three options for bars.

a. Flat shaded



b. 3D shaded



c. Heat Map shaded



Additionally, the, 'Use Heat Map Shading' in the chart options now applies this shading to all charts if selected.






Many thanks to jGda for the code for this which saved me a lot of time finding the right places to add the options.



23. Option to set number of Elevations to show
Sets number of entries in the 'Highest and Lowest Elevations' table. Defaults to 10 of each





24. NEW Finds by Placed Date



Also supports the heat map shading option if that's your cup of tea:



This is a new section so will need enabling and positioning in the 'Section Order':



(Yes - I just need a find that was placed on June 22! Already have 6 that were placed on Feb 29... )



25. Option to make Placed Date = Found Date for Event Caches

This is designed for repeating event caches where the GC code stays the same but the placed date keeps changing, and multiple finds are allowed. Put 'FindStatsRepeatingEvent' somewhere in the User Notes for the cache and FSG will use each Finds 'Found' date as the appropriate 'Placed' date for that cache.


Plus many, many other small tweaks and fixes.


771

Updated - please scroll down

FindStatGen3 V4.0.22 Release 12-27-10


Requires GSAK 7.7.3.26 or later

Couple of bug fixes:

1. Improve handling of any bad US State or Canadian Province names in the users database.

2. Fix 'Northwest Territories' and 'Newfoundland and Labrador' in the Canadian Province map.


(6707)

Updated - please scroll down

FindStatGen3 V4.1.14 Interim Release 5-7-11

Note: Functionally equivalent to V4.1.13Beta

Requires GSAK 7.7.3.53 or later


(Note: This is an interim release, I expect others to follow as we develop fixes for the major restrictions Groundspeak added to the Profile page on May 5)

1. Change Section Order form to use /\ and \/ instead of + and -




2. Remove old elevation data

Now that FSG runs on later versions of 7.7 only it is safe to rename the old elevation SQLite file to avoid confusion.


3. Shaded maps stored on server

Instead of being created live every time they are viewed the county shaded maps are created when FSG is run and then stored as images on the GSAK server. This has a few advantages:

a. The statistics html file is smaller.

b. The data is sent using PUT in the headers rather than GET embedded in a URL, so there are no longer the restrictions on data size which limited us to around 400 or so polygons.

c. The server load on GSAK is reduced as the map image is only created once.

The caveat with this change is that you must be connected to the internet when you run FSG. However that requirement has been there for a while with things like the Elevation updates.

The final maps are then stored and used as with any static image. They are png files identified by the Owner ID, map name and settings set. For example, these are map 193380_tx_4.png - i.e. A Texas map created from FSG settings group 4 by me, and map 193380_britishisles_1.png - a map of the British Isles from FSG settings group 1.





4. New - Australia map

Although the Australia map wasn't actually a World66 map it was designed to look the same so now, after all the other maps had been updated, looked out of place.



The new Australia map is fully shaded. The shading colors and bands can be edited like any other shaded map via the Map Data File Editor. The map data file is called 'Australia State Shading File'. If you already use the Australia Map section no option changes need to be made to see this map with its default settings.


5. Shaded map overlays

The Australia State, Canada Province, US State and European Country maps now all have optional text overlays. The overlays default to enabled but may be individually disabled in the map file editor.











6. NEW - Map option to use page background color

New option in the Map Data File Editor:



If checked this will override any other map background choice and instead always use whatever color has been chosen for the main page background color. This means that the maps blend in with no apparent border. It is supported by the Master Shading File.





7. NEW - First Cache By Country

New section listing 'First cache by Country' as suggested by Luzian and Moravan.



This is a new section so will need to be enabled and positioned in the Section Order form. By default it will be placed at the end and disabled.





8. NEW - Plug-in system

FindStatGen now allows 'plug-ins' through a new pseudo tag to the 'Notes' sections. If you include a tag like this in a Notes section:

<plugin>MyMacro</plugin>

Then FSG will call the macro 'MyMacro'.

As a simple example, an entry in a Notes section like this:



With FSGChildMacro.gsk containing this code:

Would result in:



As with all Notes section text you can add custom sub-headers as required. A Notes section can include as many <plugin></plugin> tags with different macros as the user wants.

<plugin>macroname</plugin> will accept the following formats for 'macroname'

• macroname
• macroname.gsk
• macroname?parms
• macroname.gsk?parms

More information on Plug In macros can be found here


9. NEW - Additional Notes Section

'Notes C' works just like the other two Notes sections, complete with editor and Test and Spell Check buttons.



Note: 'Test' does support the plug-in system as best it can, although not all variables may be available until run time. In particular the AllFinds database will be from the *last* time FSG was run.


10. Flexible Notes sections

This release introduces a very flexible Notes system where a Notes section can be added before or after any other section.

This is accessed through the Section Order menu.



Clicking any of the 'Notes' or 'N' buttons ('N' is shown on the half-width sections) will open a Notes edit window.



There are two editing areas. The top area is for Notes immediately before the selected section, while the bottom one is for Notes that will be placed immediately after.

a. Each Note has its own title.

b. These areas support all current Notes pseudo tags including <subhead></subhead>, <file></file> and <plugin></plugin>

c. Formatting must be done using html

d. Titles are optional in the new Section Notes. If the Title field is left blank in the editor then no header will be shown. (Regular Notes sections have not changed and a title will always show in those)

Note: The difference between these Notes sections and the regular ones is that these have no associated text file. All data is stored in the database. If you want an external app to modify a notes section then it's likely still better to use the existing Notes A, B and C sections.


11. Add support for 'Other' cache type


Updated - please scroll down

FindStatGen3 V4.1.15 Release 5-9-11

Requires GSAK 7.7.3.53 or later

Many, many tweaks and changes to accommodate the new restrictions on the Geocaching.com profile page.


Updated - Please scroll down

FindStatGen3 V4.2.05 Release 7-13-11

(Note: Functionally identical to 4.2.04B)

Requires GSAK 7.7.3.53 or later

1. Fully matches Groundspeak update to the geocaching.com website on Thursday June 09, 2011.


2. NEW Tabs

This release introduces a new tab page feature for the statistics. You can see an example here.



Each tab button will switch between a different set of sections. The number of tabs, the text on the button and the sections included are all fully user customizable.

Customization of tabs is done through a new pseudo tag in the Section Notes. You access these through the Section Order screen. Entering <tab>Tab Name</tab> in the Section Notes *before* a section will create a new tab starting at that point.

For example, the 'Finds' tab in the example I link to above was created by this entry in the very first section:



Rules for <tab> tags.

• Tab tags are only valid in the 'Notes before' section notes of a section. They will be ignored anywhere else.
  
• The Tab tag must be the *only* entry in that 'Notes before' section. Any other entries will be ignored.

Order all your sections as you do now, then insert tab breaks wherever you want them to start using <tab>Tab Name</tab> tags in the 'Notes before' section note section. The rest is (should be) automatic.


3. Option to suppress title of regular Notes sections.

Including the pseudo tag '<notitle/>' in a regular Notes section will stop the title displaying.


4. Added anchor tag at top of output

is now at the beginning of the html output allowing the user to add anchor links back to that position.


5. Section Editor shows 'Tab' positions

The Section Order editor shows 'Tab' (or 'T' in half width sections) instead of 'Notes' (or 'N') for those sections where a tab has been set. This makes it easier to see where the tab breaks will occur.





6. Copy Settings Group

New Copy option for Setting Groups:



Clicking this will show the following form:



Select a Setting Group that you wish to copy the current setting group to and click 'Copy'

WARNING: Everything in the selected group will be deleted and replaced with the contents of the current setting group. That includes: Section Order, Notes, Section Notes, Home positions, Milestone edits, Special caches etc. Be sure that's what you actually want to happen!


(14126)

Updated - Please scroll down

FindStatGen3 V4.3.12 Release 7-28-12

(Note: Functionally identical to 4.3.11B)

Requires GSAK 7.7.3.53 or later



1. New style color option - 'Smooth'



This is based on the great new style from FormicaPL which she called Smooth. Many thanks to her for the work.




2. Reworked many menus for V8.


3. Triggering using 'Placed' color scheme in Notes section

If you put the string '<placed>' in a Notes section then it will use the Placed color scheme for the section header.


4. Extended logging

FSG now supports extended logs where very long logs are split across a single 'Found' log and multiple 'Write note' logs. The 'Write note' logs will be added into the total log word length. This is triggered by:

a. 'Write note' logs must have the same date as the 'Found' log
b. The string 'FindStatsExtendedLog' is somewhere in the user notes for that cache.


5. New Favorites section

Shows the ten caches you have found with the most favorite points.



or



Note: This section is only active in GSAK V8. Favorite Point data is currently only available through the API.

The new Favorites section will be found at the end of the Section Order menu. You will need to 'Enable' it and position it where you want it in the report.


6. Fav Points in Placed and Sorts





Note: Both these will only appear if you are running GSAK V8


7. Native support for Groundspeak HQ, 10 Year Event, and Lost and Found types

These new cache types are now being returned by the API (although not PQs). FSG will now recognize them without having to use a special trigger phrase in the notes.


8. Supports $xsea and $ysea values in shaded map data files
If the string variables $xsea and $ysea are found in the map data file then that point will be used to start the fill for the 'sea' background. It defaults to 2,2 as now. Sea fill coordinates origin is top left of map as with all map data coordinates.


9. Comments supported in Notes
A line starting with the '#' character anywhere in a Notes section will be ignored when displaying that section.

Note: The '#' character must be the first non white-space character on a line for it to be recognized as a comment. Mid line comments are not supported


10. Google Elevation API now returns Resolution.
The FSG elevation query will use and populate resolution values if the Google elevation look-up is used.


11. Finds by Type now correctly reports percentage of total finds (not total caches).
(See here)


12. Find by date show completed months/values



Completed rows/columns are shown by the green header


13. Center point restored after macro runs


14. Added Sort by LastFind to Placed Caches





(9293)

Updated - Please scroll down

FindStatGen3 V4.4.09 Release 5-26-13

Requires GSAK 7.7.3.53 or later

(Functionally identical to V4.4.08B with the NOERROR fix)



1. Support for the 'Block party' cache type P.

This has a special cache type P in the most recent versions of GSAK. For older versions entering either 'FindStatsBlockParty' or 'PseudoTypeBlockParty' in the User Notes for a cache will signal to FSG to mark that cache with the 'Block Party' type and Icon. It will appear in the 'Cache Types' section and the icon will be used anywhere that cache appears in the stats.

Here's some dummy examples:








2. Move Finds By Month chart to use POST

The Finds by Month chart is now created when FSG is run and then stored on the gsak website, like the maps. This allows moving to POST variables rather than GET and removes the limitation on data length that long term cachers may be seeing.



3. New Option to set RunDate externally

If the variable $ExternalRunDate is set to a valid date string on entry then GSAK will use that date as the default Run Date rather than today's date. $ExternalRunDate should be a string variable containing the date required in the format "YYYYMMDD".

If $ExternalRunDate contains a valid date AND $AutoRun = TRUE then the initial form and delay will be skipped. If $AutoRun is absent or FALSE then the initial form will be shown, with the requested date pre-selected as the Run Date.

For example, this code will run FSG with the run date set to March 31st 2010, Settings set to 1, and will skip the opening form. (It will likely show the options form the first time you run this version. The automatic version checker will enforce that. Should skip all forms in subsequent runs.)

If $AutoRun = TRUE is omitted then you will get this:




This should facilitate the request to have multiple runs with different dates to animate maps. Create a loop with $ExternalRunDate incrementing appropriately and use a Settings Group containing just the one map you want to animate.


4. New Option to set Start Date externally

The companion feature to $ExternalRunDate, if the variable $ExternalStartDate is set to a valid date string on entry then FSG will use that date as the Start date for the generated statistics. $ExternalStartDate should be a string variable containing the date required in the format "YYYYMMDD".

This may be used either on its own or in conjunction with $ExternalRunDate. The default, if $ExternalStartDate is not used, is to show all your cache finds starting from the date of your first find.

For example, this code will run FSG with the start date set to Jan 1st 2010 and the run date set to Dec 31st 2010. Thus it will give you statistics for just calendar year 2010.

5. Amendment to the way $ExternalSettings works

To correspond with the change made with the new $ExternalRunDate, if $ExternalSettings contains a valid Settings number AND $AutoRun = TRUE then the initial form and delay will be skipped. If $AutoRun is absent or FALSE then the initial form will be shown, with the requested Settings number set. (As now)


6. Changed position of restore CENTER when the macro ends to before Restore Sort
(See here for more information as to why this matters)


7. Override Maximum Caches in a Month Scaling Value

New option to allow overriding the maximum caches in a month scaling value that is used in the 'Finds by Month' charts. Currently all years are scaled to the same maximum month value. The new override allows you to change that maximum scaling value to whatever you want. Any months with more than that number of finds will be clipped to the maximum. Any clipped months will have the number of finds text shown in red to indicate clipping.



For example, here are my Finds per Month charts for 2009, 2010, and 2011 with the new Override Maximum Month option set to 100. All bars are scaled to a maximum height of 100 and any months with more than 100 finds are clipped back to that same maximum bar height but with their finds number shown in red.




The default value of 0 for this field will leave the automatic scaling as it is now.


8. Remove deprecated PREPROCESS command and fixed NOERROR


(866)

Updated - Please scroll down