Module: Mesquite (manual)

Full package name: mesquite.Mesquite
Duty: Root module for Mesquite system (mesquite.lib.MesquiteTrunk)

Module Explanation

This is the central module for the Mesquite system. In it is the main method that starts up the Mesquite application. This module loads information for all of the other modules, and hires FileCoordinator modules as needed to deal with open files. Thus, in the tree of employees that active modules make, this module is at its root.

Author(s): Wayne P. Maddison and David R. Maddison
Version 3.70

Commands of Mesquite

setConfig
- Explanation: Sets the packages of modules loaded at startup, using a configuration file
defineConfig
- Explanation: Defines a set of packages to be loaded at startup, using a configuration file
deleteConfig
- Explanation: Brings up a dialog box by which user-defined configuration files can be deleted
editMacroInfo
- Explanation: Brings up a dialog box to change name and explanation of user-saved macros
showMacros
- Explanation: Brings up a dialog box to examine macro files
crash
- Explanation: Crashes with a NullPointerException
checkNotices
- Explanation: Checks for notices or installs at the location specified
deleteAutoMacros
- Explanation: Brings up a dialog box by which automatically-defined macros files can be deleted
redirectLog
- Explanation: Redirects log saving to the given filename
- Parameters: [filename]
renameLog
- Explanation: Changes the current log file's name
- Parameters: [filename]
setConfigAll
- Explanation: Indicates that all installed modules are to be loaded at startup
openFile
- Explanation: Opens file on disk. The file will be opened as a separate project (i.e. not sharing information) from any other files currently open.
- Parameters: [name and path of file] - if parameter absent then presents user with dialog box to choose file
openURL
- Explanation: Opens file on web server. The file will be opened as a separate project (i.e. not sharing information) from any other files currently open.
- Parameters: [URL of file] - if parameter absent then presents user with dialog box to enter URL
openGeneral
- Explanation: Opens module for project reading or making.
- Parameters: [module]
closeProjectByID
- Explanation: Closes file and any other files linked to it (i.e. closes the project)
- Parameters: [ID number of project]
newProject
- Explanation: Makes a new file (as a new project)
newEmptyProject
- Explanation: Makes a new file (as a new project)
resetMenus
- Explanation: Forces a reset of the menus.
showLicense
- Explanation: Shows the GNU Lesser General Public License.
currentCommand
- Explanation: Shows the currently executing command and offers to stop it.
pendingCommands
- Explanation: Shows the list of pending commands and offers some to be suspended.
reportMemory
- Explanation: Reports memory status, for debugging of memory leaks. Static boolean checkMemory needs to have been set first.
quit
- Explanation: Quits Mesquite
exit
- Explanation: Quits Mesquite
goAwayForceQuit
- Explanation: Force Quit Mesquite (data may be lost) via click go-away
forceQuit
- Explanation: Force Quit Mesquite (data may be lost)
vanish
- Explanation: Closes down all threads and modules, but doesn't stop JVM
showAllWindows
- Explanation: Brings all windows to front
closeAllProjects
- Explanation: Closes all current projects and files
saveAllProjects
- Explanation: Saves all current projects and files
keywordSearch
- Explanation: Performs keyword search to find module with particular function.
webSearch
- Explanation: Searches the internet for user-provided terms.
mesquiteFAQ
- Explanation: Opens the Mesquite FAQ in a web browser
showModules
- Explanation: Shows web page of installed and loaded modules
showPackageInfo
- Explanation: Shows web page introducing a package of installed modules
showCommands
- Explanation: Shows web page of available commands for scripting
showHomePage
- Explanation: Shows home page of Mesquite
showSupport
- Explanation: Shows Support page of Mesquite manual
windowAutoShow
- Explanation: Sets whether the Mesquite window appears automatically when no windows are showing
- Parameters: [on or off]
getWindowAutoShow
- Explanation: Returns string ("on", "off") whether the Mesquite window appears automatically when no windows are showing
dumpEmployeeTree
- Explanation: Dumps the entire employee tree to the log
showStatistics
- Explanation: Shows some statistics that might be of interest to developers
dumpSubstantivePrerelease
- Explanation: Dumps to the log a list of those modules that are substantive and (prerelease or without citations)
dumpAllPrerelease
- Explanation: Dumps to the log a list of those modules that are prerelease
dumpEN
- Explanation: Dumps to the log a list of modules, their names and explanations, and their needs
dumpNewModules
- Explanation: Dumps to the log a list of those modules that are new to this version
dumpNextReleaseModules
- Explanation: Dumps to the log a list of those modules that are new to the next release version
dumpAllModules
- Explanation: Dumps to the log a list of all modules installed
showWebPageAllModules
- Explanation: Shows a web page of all modules installed
dumpAllModuleClasses
- Explanation: Dumps to the log a list of all modules installed
testError
- Explanation: Sends Error to Server
showAbout
hideAbout
projects
explainNoSave
gp
logLastResultString
- Explanation: Logs last result string
getLastResultString
- Explanation: Returns last result string
getLastResult
- Explanation: Returns last MesquiteNumber result