User Manual for Hyperwag

Running Hyperwag:

In order to run hyperwag, simply type "hyperwag [infile] [outfile]" at the command prompt, where "infile" is the input file you wish to read and "outfile" is the file you wish to write to. If you do not use the above format, the program will remind you of the format and return you to the command prompt.

Using Hyperwag:

To use hyperwag you must start with a Week at a Glance input file in one of two formats, WAGalang or WAGML. The two are explained below:

WAGalang format:

day(s) starttime,endtime description
#comment

example:
mwf 10, 12 cps108
th 9-10 sleep

WAGML format:

<appt
day="DAY_NAME"
time="TIME_RANGE"
subject="ANY_TEXT"
/>
<! Comment />

example:
<appt
day="monday"
time="9,10"
subject="sleep"
/>

Files must be in one of these two languages. White space and blank lines are allowed. In fact, it must separate the 3 columns in wagalang from each other, the individual fields in wagML from each other, and the closing '/>' tag from whatever precedes it.

Outputting Format:
There are two possible output formats, text and HTML. If the program detects a ".html" termination to your output file name it will write in HTML output, otherwise it will write in text. Look for the output file in the directory that hyperwag is contained in.

Hyperwag Execution

Procedure:
After giving hyperwag and input and an output file, it will read in the input file. If there are any conflicts in the file, such as appointments occurring at the same time on the same day, the program will alert you and change the description of the appointment to "conflict: lunch and sleep" for example. In HTML output mode, the color of the conflicting appointment will show up as red.

Interactive commands:
Hyperwag will prompt you to select from a variety of filters that can be applied to the complete list of appointments in the input file. Each filter needs additional input from you to determine exactly what it will filter. For example, you could filter descriptions by "sleep" to view all the time slots allocated for shut-eye.

Errors:
If something goes wrong with your input file, such as an invalid or unrecognized language, the program will alert you and then terminate. Fix the source files and try again. Errors during the programs operation will also be shown below the command line. Please contact your developers for any crashes that occur.

We hope you enjoy Hyperwag!


Back to HyperWag