A (Standard) Way to Get Help on and Remove Packages

// OPTIONAL IGOR PRO INFORMATION
 
#pragma rtGlobals=1
#pragma IgorVersion=6.10
 
// DEFINED PACKAGE INFORMATION
// package name and version number
// substitute the name of your package for "MyPackage"
// also define a version number for your package
 
#pragma ModuleName=MyPackage
#pragma version=1.0
 
// OPTIONAL HIDE PARAMETER
// hides your package from the procedure windows list
// this parameter is not needed when your package is also an IndependentModule
 
#pragma hide=1
 
// DEFINED PACKAGE STRING CONSTANTS
// When you have none of these, you must still define them but set them blank
// ie Static StrConstant theProcedureFile = ""
// thePackage - name of your package
// thePackageFolder - where you store your package values
// theProcedureFile - the (main) procedure file associated with your package
// hasHelp - 0: no help provided; 1 - help file (appropriately named by package name) is provided
 
Static StrConstant thePackage="MyPackage"
Static StrConstant thePackageFolder="root:Packages:MyPackage"
Static StrConstant theProcedureFile = "MyPackage.ipf"
Static Constant hasHelp = 1
 
// OPTIONAL LANGUAGE LOCALIZATION
// Otherwise remove this and the next optional part
 
#define English
 
// OPTIONAL STRING CONSTANTS
// example shown on how to use language localization
// otherwise substitute an actual string for KillMeRequest in the RemoveMe() function
 
#ifdef English
Static StrConstant KillMeRequest="Do you really want to remove MyPackage?"
#endif
#ifdef Deutsch
Static StrConstant KillMeRequest="Soll MyPackage wirklich entfernt werden?"
#endif
 
// START DEFINED PACKAGE FUNCTIONS
// (start) put your definitions, includes, functions, macros, and other components in this section
 
 
// (end) put your definitions, includes, functions, macros, and other components in this section
// END DEFINED PACKAGE FUNCTIONS
 
// DEFINED HELP FUNCTION
// call with topic = "topic string" to get specific help on a particular topic string
 
Static Function Help([topic])
      string topic
 
       string HelpStr = ""
 
    if (!hasHelp)
               sprintf HelpStr, "NO HELP FOR PACKAGE %s!", thePackage
        DoAlert 0, HelpStr
        return 0
    endif
 
    if (strlen(thePackage)!=0)
                if (ParamIsDefault(topic))
                 DisplayHelpTopic/K=1 thePackage
                else
                         sprintf HelpStr, "%s[%s]" thePackage, topic
                 DisplayHelpTopic/K=1 HelpStr
                endif
    else
        DoAlert 0, "NO PACKAGE NAME FOR HELP!"
        return -1
    endif
    return 0
end
 
// DEFINED REMOVEME FUNCTION
// Remove Me
// quiet (optional): 0 (default) - prompt to remove; anything else - no prompt
 
Static Function RemoveMe([quiet])
    variable quiet
    
    if (ParamIsDefault(quiet) || (quiet == 0))
        DoAlert 1, KillMeRequest    
        if (V_flag == 2)
            return 0
        endif
    endif
        
    if (strlen(thePackageFolder)!=0)
        KillDataFolder/Z $thePackageFolder
    endif
    
    string theCmd
    if (strlen(thePackage)!=0)
        sprintf theCmd "DELETEINCLUDE \"%s\"" thePackage
        Execute/P/Z/Q theCmd
    endif
    if (strlen(theProcedureFile)!=0)
        sprintf theCmd "CloseProc/NAME=\"%s\"" theProcedureFile 
        Execute/P/Z/Q theCmd
    endif
    
    return 0
end