WardInfo - Syntax

The syntax for the WardInfo program may be seen at any time by using the WardInfo program with no options.  This will produce a syntax listing which is broken into screens of 20 to 24 lines.

Syntax Summary

 

WardInfo /UnitName="Unit Name" [optional parameters]

  Optional parameters:

      /[No]ChurchLocations[="file-name"]

      /[No]Directory[="file-name"]

      /[No]FamilyLocations[="file-name"]

      /History=months[:MinEntries[:MaxEntries]]

      /IncludeFacility="facility-name"

      /IncludeTypeFacility=type

      /InfoD=Yes|No InfoE=Yes|No ... /InfoY=Yes|No /InfoZ=Yes|No

      /InputDirectory=directory

      /LocalChurchFacilityRadius=Distance-in-miles

      /LocalInfoFile=file-name

      /[No]Members[="file-name"]

      /Mode=mode-name[:custom-name]

      /Neighbors=number

      /NoHistory

      /NoNotes

      /NoPictures

      /NoSpreadsheets

      /NotesDirectory=directory

      /OutputDirectory=directory

      /Override=option

      /PictureDirectory=directory

      /PictureSize=width[,height]

      /TelephoneDisplayFormat=format

      /UpdateChurchLocations[=filename]

      /Verbose[=options]

      /[No]YouthTempleTrip[="file-name"]

 

   All switches (/something) and parameters (=something) may be shortened as

   long as they are unique.

 

 

 

Required Syntax

 

WardInfo /UnitName="Unit Name" [options]

 

/UnitName="Unit Name" is the ward or branch name.  It may not be abbreviated.  If using the ChurchLocations.Xls spreadsheet, the Unit Name must be the same as what is entered in the spreadsheet.  Note that Unit Name must be enclosed in quotes such as “Riverside Ward”.

 

Optional Syntax

 

/ChurchLocations="file-name" indicates the name of the excel spreadsheet that contains church facility address, location, and contact information.  The default location is the current directory and the default name is ChurchLocations.Xls.  /NoChurchLocations says to not use this spreadsheet at all, even if it is present.

 

/Directory="file-name" indicates the name of the excel spreadsheet that contains supplimental entries for the directories of WardInfo.  The default location is the current directory and the default name is Directory.Xls.  /NoDirectory says to not use this spreadsheet at all, even if it is present.

 

/FamilyLocations="file-name" indicates the name of the excel spreadsheet that holds family information, including last address, phone, and location.  The default location is the current directory and the default name is FamilyLocations.Xls.  /NoFamilyLocations says to not use this spreadsheet at all, even if it is present.

 

/History=[months[:MinEntries[:MaxEntries]]] specifies how many months of history of member changes to include in output (default is 2 months).  One can (in addition) specify the minimum number of entries (default is all), and a maximum number of entries (default is all).  /NoHistory says to not include a history of member changes at all

 

/IncludeFacility="facility-name" includes a church facility by name in the output.  'all' or '*' includes all facilities in the spreadsheet.

 

/IncludeTypeFacility="facility-name" includes a church facility by type in the output.  Types are found in the ChurchLocations.Xls spreadsheet in column 'I'.   'all' or '*' includes all facilities.

 

/InfoD=Yes|No to /InfoZ=Yes|No allows or disallows inclusion of columns D through Z from the Members.Xls spreadsheet in the output.

 

/InputDirectory=directory specifies where the spreadsheets and MIS or MLS files are found.  The default is the current directory.

 

/LocalChurchFacilityRadius=distance sets the maximum distance from this unit that another unit can be and still be in the 'Local Church Facilities' page.  The default distance is 150 miles.

/LocalInfoFile=file-name specifies where an optional html information file is located.  If this parameter is included, the specified file is included in the distribution, and has a link on the master index page.

 

/Members="file-name" indicates the name of the excel spreadsheet that contains customizable supplimentary information about members. The default location is the current directory and the default name is Members.Xls.  /NoMembers says to not use this spreadsheet at all, even if it is present.

 

/Mode=mode-name[:custom-name] sets the output mode as desired.  Mode names are:

1)      Bishopric

2)      PriesthoodLeader

3)      ReliefSocietyLeader

4)      YouthLeader

5)      Leader

6)      Member

The optional custom-name allows the advanced user to design a custom output mode and incorporate information from appropriately formatted columns in the Members.Xls spreadsheet.

 

/Neighbors=number tells how many 'nearest neighbors' should be reported for each family.  This option only applies when latitude and longitude information has been entered for each family in the FamilyLocations.Xls spreadsheet.

 

/NoHistory says to not provide any history information at all..

 

/NoNotes says to not provide links to note files in the family and individual info pages.

 

/NoSpreadsheets says to not use any spreadsheets in generating the output.  This is useful when excel is not present or not compatable with WardInfo.

 

/NotesDirectory=directory specifies where the notes file may be found.  Notes are referenced in WardInfo by Last_First labels in the WI-Notes.htm file.  The WardInfo notes file may be used to store information about a family or individual.  Note that this directory specifies where the notes file is relative to the eventual location that the WardInfo file reside, so it must be a relative location.  The default notes file is '..\WI-Notes.htm'.

 

/OutputDirectory=directory specifies where the output files will be placed (defaults to the current directory with an appropriate subdirectory).

 

/Override=option:value enables or disables specific features of the output.  To show option names, use 'WardInfo /ShowOutputModes=Names'. The /Override=option:value switch may be used multiple times.  Values are either 0 (disabled) or something else (enabled).

 

/PictureDirectory=directory specifies where the pictures of families and members can be found.

 

/PictureSize=width[,height] specifies the width (or minimun width if height

      is also specified) and minimum height of pictures for this format.

 

/TelephoneDisplayFormat="format" specifies how to display phone numbers.  Format options may not be abbreviated and are:

1)      (xxx)xxx-xxxx

2)      xxx-xxx-xxxx

3)      xxx-xxxx

4)      xxx.xxx.xxxx

5)      xxx.xxxx

If this option is not specified, the telephone numbers are displayed as received from the MIS or MLS input files.  When telephone numbers are formatted for output by WardInfo, they must also be in the MIS or MLS input files in a telephone number format that it recognizes.  If WardInfo can not recognize the telephone number from one of the formats listed above in 1) through 5), it will not reformat the telephone number, and will display the original string as present in the MIS or MLS input files.

 

/UpdateChurchLocations[=filename] will read in a text file of information that has been extracted from the Church Organization Information program and enter that information info the excel spreadsheet ChurchLocations.Xls.  If not specified, the filename used is ‘ChurchLocations.Txt’.

 

/Verbose[=level] sets the verbosity of the output messages.  Levels may be abbreviated and are case-insensitive:

1)      None – all messages, including reports of fatal errors suppressed.

2)      Low – only critical status messages displayed.

3)      Medium – verbose enough to tell what is going on, but not so verbose as to fill multiple screens every minute.

4)      High – displays more messages than you will want to see, mostly having to do with internal WardInfo states and transitions that will not be interesting.

5)      Extreme – displays every message that could be generated in every debug mode that exists in WardInfo.  Too much information, not at all helpful.

 

/YouthTempleTrips="file-name" indicates the name of the excel spreadsheet that contains dates and attendance records of the youth temple trips.  The default location is the current directory and the default name isYouthTempleTrips.Xls.  /NoYouthTempleTrips says to not use this spreadsheet at all, even if it is present.

 

Alternate Syntax Forms:

 

WardInfo /CheckForNewVersion

 

Executes a special program mode that checks on the internet if a new version of the WardInfo program is available, and supplies contact information if there is a new version.

 

WardInfo /CreateSA9ChurchImportFiles

 

Executes a special program mode to generate a file containing street addresses of  LDS chapels and other units that may be imported into the Delorme Street Atlas program.  The file is in the format to be used with the Street Atlas 9.0 'File/Import Address Book' menu option.  If these imported points are then exported from the Street Atlas program, they may be used to generate the latitude and longitude fields of the ChurchLocations.Xls spreadsheet.  See Advanced Features for more about using Street Atlas and obtaining latitude and longitude coordinates.

 

 

 

WardInfo /CreateSA9FamilyImportFiles

 

Executes a special program mode to generate a file containing family street addresses that may be imported into the Delorme Street Atlas program.  The file is in the format to be used with the Street Atlas 9.0 'File/Import Address Book' menu option.  If these imported points are then exported from the Street Atlas program, they may be used to generate the latitude and longitude fields of the FamilyLocations.Xls spreadsheet.  See Advanced Features for more about using Street Atlas and obtaining latitude and longitude coordinates.

 

WardInfo /CreateSpreadSheets[=Replace]

 

Executes a special program mode to create empty versions of the Excel spreadsheets that are used by the WardInfo program.  If the 'replace' option is used, old spreadsheets will be renamed to <something>.OLD.  This program mode should be used to generate the initial versions of the WardInfo spreadsheets because column headers and cell formatting are supplied.

 

WardInfo /ShowOutputModes[=Names]

 

Executes a special program mode that shows what each output mode displays.  Use this command without the ‘=names’ value to show the difference between (for example) Bishopric and Members output modes.

 

This mode may also be used to confirm customized output settings. 

 

WardInfo /ShowOutputModes=Names will show the names of each item that can be enabled or disabled individually.  This mode truncates the normal output of the /ShowOutputModes option to allow the full name to be seen.