GSAK (Geocaching Swiss Army Knife)
 

Contents - Index


Macro Run/Manage Dialog (Macro=>Run/Manage)



The macro run/manage dialog is a "central repository" for all your macros. From here you can run and manage all your GSAK macros. You can sort on any column by clicking on the title bar of that column (click again to toggle the sorting sequence). Columns can be moved and re sized, as can the dialog itself. Search for a macro by entering text in the search box - any macro file name or description that contains this text will be displayed.

Macro buttons:

Run - Run the currently selected macro (you can also run a macro via a double mouse click on any entry)

Version - Use this button to check if you have the latest version of this macro or all macros. When you first click on this button you will get the following dialog:



Select OK to check only the current macro (the one highlighted in the grid) or select "All" to check every macro

When the version of the macro on the GSAK web site is different to the version you have installed on your computer, you will get a dialog similar to the following:



Update - Immediately install the macro on your computer with the version on the GSAK web site
Forum - Open the GSAK forum post for this version of the macro in your browser. Use this to check for additional notes before deciding to update.
Skip - Skip this update and return to the macro manager (if only checking the current macro) or proceed to the next macro (if checking all)

Install - The easiest way to install a macro is by using the "file association" of the .gsk extension, see this topic for more information. However, there may be some macros that still have the .txt extension and this button will allow you to install these macros.

Uninstall - This button will allow you to remove an installed macro

Resync - Firstly, every *.gsk or *.txt file in your macro folder is interrogated for the "MacVersion =" or "MacDescription =" comment keywords (see note at end). If either these keywords are found then the macro install database is updated. That is, if the macro already exits in the database the description and version information is updated. If the macro does not exists in the database then an entry is created with this information. Secondly, every entry in your macro database is tested to see if the corresponding file exits in the macro folder. If this file is not found, the entry is deleted from the database.

There is also a right click menu with the following options:

Edit - Open this macro in your configured macro editor program 
Edit New Window - You will only see this option if GSAK is your default macro editor. It will open the macro in a new instance of the macro editor so that you can edit multiple macros at the same time.
Edit Forms - Edit any forms for this macro in the forms designer
Rename - Rename the current macro file
Reset count - Rest the counter for the number of times the macro has run back to zero
Run - Run this macro
Resync this macro - This option will update the grid with the latest information from the macro on your hard disk. Useful when you have macros that you write but are not published on the GSAK server and do not get updated by the usual install method. 

Note: Macro authors should include the following header when adding macros to the GSAK macro library. They should always include the "MacFileName =" keyword, otherwise the incorrect file name may be added to the macro library when downloading the macro file via a web browser. That is, when you click on a web link your browser downloads the file to you temporary Internet files folder before passing it to "open with". The problem is that if a file by that name already exists in the temporary Internet files your browser automatically adds a number to the file name and now this is the file it downloads. So the actual file that GSAK gets is the file with the appended number regardless what the original file was called. This means that the file you download may not always have the same name as the original file. I guess it is the browsers way of "protecting" you from overwriting files with the same name. By using the "MacFileName =" keyword you make sure the file name that GSAK installs is always correct.
 

#***********************
# MacVersion = 1.1
# MacDescription = Hello world test macro
# MacAuthor = Clyde
# MacFileName = Hello.gsk
# MacUrl = http://gsak.net/.......

 

These keywords can be placed anywhere in the macro code, but must be macro comments (line begins with #)
Copyright 2004-2011 CWE Computer Services  
Privacy Policy Contact