File: parms.readme.txt

  Parms - Open Source JavaScript Custom Parameters

  parms.readme.txt
    getting started with Parms

  Author: Randal Allen Anderson III
          rational_ape@hotmail.com
  Web: http://raa3enterprises.com/parms
  Copyright (c) 2013 RAA3 Enterprises, Inc.
  GNU General Public License - http://www.gnu.org/licenses/gpl.html


Double click on the file "Parms.test.html" to run a test of the parms. This will open up a window in your default browser. Press the "F2" key to see the log.

The parms test should run as expected. To incorporate custom parameters in your application, include and use the "parms.js" file. See the "parmstest.js" file for examples of how to use the custom parameters.

Custom Parameters uses logging to show warnings and errors encountered in their usage. Two loggers have been included in this project that can be used or you can use another. The logger will need to have the following functions defined:  log.severe(message) log.error(message) log.warn(message) log.info(message) log.trace(message) log.debug(message).

To use the jraLogger, copy the jraLoggerFiles directory and the "logging.css" file to an appropriate location in your project. Then include the "logging.css" and "jraLoggerFiles/jraLogger.css" and "jraLoggerFiles/jraLogger.js" in your web page. Then from Javascript, call any of the logging functions: log.severe(message) log.error(message) log.warn(message) log.info(message) log.trace(message) log.debug(message).

To use the Blackbird logger, copy the blackbirdFiles directory to an appropriate location in your project. Then include the "blackbirdFiles/blackbird.css" and "blackbirdFiles/blackbird.js" in your web page. The "logger.css" file contains styling for the buttons used on the test pages. If you want similar styling then also include this file in your web page.