Template Header for Igor Pro Procedure Files for Packages

Thu, 08/14/2025 - 09:40 am

As I am (re)developing packages for public consumption, I have decided to standardize how I present the header information in each procedure file. I take inspiration from Tony's Package Updater as well as from comments after running ipt lint.

I propose this as a template for others who are or who are considering the development of packages that will be posted for others, and I invite suggestions for improvements.

// Primary Common Header
#pragma rtGlobals=3
#pragma rtFunctionErrors=1
#pragma IgorVersion=9
#pragma TextEncoding="UTF-8"
#pragma hide=1  // remove this line to show in the procedures menu
 
// Procedure Loader Hide
// remove the above line to include the procedure file in the Project Loader list
 
// Project Updater Header 
// include these lines to sponsor the project on IgorExchange (for Procedure Loader)
Static Constant kProjectID=...
Static Strconstant ksShortTitle=...
 
// Package Information
// include these lines for your internal management
// static are local to procedure
// non-static are global to all procedures
#pragma version=...
StrConstant k_...PackageFolder = "root:Packages:..."
Static Constant kVersion=...
Static StrConstant kAuthor="Jeffrey J Weimer"
Static StrConstant kAuthorEmail="Jeffrey.Weimer@UAH.edu"
Static StrConstant kWebPage="https://www.wavemetrics.com/project/..."
 
// Independent Module and/or Module Definitions
#pragma IndependentModule=...
#pragma ModuleName=...
 
// Parameters Specific to This Procedure
#pragma DefaultTab={3,20,4}
#pragma ...
Static Constant k_...=
Static StrConstant k_...=
 
// Additional Packages
#include "Some Other Package"
#include "Yet Another Package"
...