=========================================
FSGPlugin_TravellerIconsList version 2.03
=========================================

FSGPlugin_TravellerIconsList is a FindStatGen (FSG) plugin. It only can be used together
with FSG. User must be familiar how to install and use GSAK/FSG macros/plugins. See 
documentation of GSAK/FSG for details.

The macro generates a list of icons of TBs and coins the user has discovered or moved.

  **************************************************************************************
  * IMPORTANT:                                                                         *
  * FSGPLUGIN_TRAVERLERICONSLIST DIRECTLY READS INFORMATION FROM THE GEOCACHING.COM    *
  * WEBSITE. THIS MIGHT BE AGAINST THE TOU (TERMS OF USE) OF GEOCACHING.COM. THE USER  *
  * OF THIS MACRO HAS THE FULL AND ONLY RESPONSEBILITY FOR USING IT. THE AUTHOR OF THE *
  * MACRO WILL GIVE IN NO WAY THE GUARANTY FOR THE LEGALITY OF USING THIS MACRO.       *
  * THE AUTHOR WILL BE IN NO WAY RESPONSABLE FOR ANY PROBLEMS THE USAGE OF THE MACRO   *
  * WILL CAUSE.                                                                        *
  **************************************************************************************

Possible parameters for FSGPlugin_TravellerIconsList:
  - USERNAME, needed for logging in at gc.com
  - PASSWORD, needed for logging in at gc.com
  - SHOWONSTART to show icons on first display (section "open")
    default: not to show icons on first display (section "closed")
  - SHOWALL to show an icon for every TB/coin moved/discovered
    default: show icons for different types only (one per type image)
  - SHOWCOUNT to show an small numbers beneath the icons of how may times
    this TB/coin type has been moved/discovered
    default: not to show these numbers
  - FILE to use free output file name
    default: FSGPlugin_TravellerIconsList_output.txt
  
Generated output of the macro is additionaly written to file. When called
macro checks if there exists a prior written output file. If this file
exists and has been written prior to the actual date then new information 
is read from geocaching.com otherwise information is taken from file. 
This is done to limit load to geocaching.com and to save time when generating
profile data.
  
Example 1 - call the macro:
  <plugin>FSGPlugin_TravellerIconsList?username=Doblinus&password=xxxxx&showcount</plugin>
  (instead of "Doblinus" use your geocaching.com account name, for "xxxxx" set
  your password)
  
Normally, data information for TBs/coins will not change every day. So it doesn't
make sense to read unchanged information from geocaching.com once a day (if you
update your profile daily). Therefore, instead of reading data from geocaching.com
you can include the saved file by

Example 2 - include the saved file:
  <file>FindStatGenData/FSGPlugin_TravellerIconsList_output.txt</file>
  
Going that way you can save time when running FSG as the macro needs some (!) time
when reading data from geocaching.com.


I myself run the macro call (Example 1) from different "Setting Group" (see FSG
documentation) whenever my TB/coin statistic has significantly changed. In my
"Setting Group" which produces profile data I include file as in Example 2.

Therefore I set:

"Setting Group" 2 (in one of the "notes sections", for file generation only):
  <plugin>FSGPlugin_TravellerIconsList?username=Doblinus&password=xxxxx&showonstart</plugin>
  <plugin>FSGPlugin_TravellerIconsList?username=Doblinus&password=xxxxx
    &showall&file=FSGPlugin_TravellerIconsList_output_all.txt</plugin>

"Setting Group" 1 (for profile generation):
  <subhead>Bewegte oder entdeckte TBs und Coins</subhead>
  Die verschiedenen Typen
  <br>
  <file>FindStatGenData/FSGPlugin_TravellerIconsList_output.txt</file>
  <br>
  
Result you can see at my profile www.doblinus.de.
If you run into problems feel free to contact me. I will try to help you asap.

Doblinus 
(gc@doblinus.de)

