You are looking at the manual for Wusage 7.1. This product is three years old! Check out Wusage 8.0 and its remarkable new features.
Wusage 7.1 Manual
Report Macro Language
The report macro language is designed to be simple and straightforward, but most users will not need to fully understand it in order to make useful changes, such as translation or aesthetic improvement. Complete understanding of the report macro language is only necessary for those who wish to reorganize the reports in dramatic ways.
"How do I get started?"A collection of standard report macros are used to generate all of the normal HTML and email reports of Wusage 7.0 and above. Normally, these macros are fetched from an internal copy. However, users who wish to do so can easily replace them.
You can also create customized macros for individual report directories by placing those macro files directly in the report directory itself. As a rule, if a report macro file can be found in the report directory, that file is used instead of the
Unix UsersBeginning with Wusage 7.1, you can simply copy the
.rmcfiles provided in the
macrossubdirectory of the Wusage distribution into a subdirectory of your home directory called
wusage-macros. For instance, if you run the Wusage program under the Unix account
httpd, the subdirectory containing your customized macros will typically be called
wusage-macrosdirectory. If a report macro file cannot be found in either location, the built-in version is used.
Once you have copied the
.rmc files, you can immediately
begin making changes. You may freely change any English text you encounter,
and you can change the HTML tags as well, although it is recommended that you
become familiar with HTML before doing so.
As a general rule, if you prefer not to learn the report
macro language, don't change any portion of the
file that you do not understand. And, of course, keep the
.rmc files around as a backup. These simple
rules will keep you out of trouble!
"How does the report macro language work?"Anything that appears in a
.rmcfile is considered to be HTML (or EML for email reports), and is output directly as part of the report, unless it appears between the
"What can appear between
The following commands can appear immediately following
[@sequence. Anything else that appears immediately after
[@is the name of a macro, and should be immediately followed by
@]. That macro will be expanded and inserted into the report at that point. Any additional macro commands in the body of the macro will then be expanded in turn.
Note to advanced users: macro
names, as used in the
can themselves be the result of a macro expansion. However, the macro expansion
should result in a single word without spaces. Filenames
for use by the
openfile command can also be the
result of a macro expansion. However, the filename given to the
include command cannot be the result of a macro expansion.
||Sets the named macro to the specified value. The value
can extend for as many lines as the author desires. Once a
macro has been set, it can be expanded using the syntax
||Unsets the named macro. The macro no longer has a value.
||If the named macro is set, then the text will be inserted
into the report. The text can extend for as many lines as desired.
If the macro has been unset using the
||The specified file is created, and all subsequent report
text is written to that file instead of to the original report file,
||Closes a report file opened by
||Reads additional text and/or macros from the specified file, exactly as if the contents of the file appeared at this point in the original report macro file. This facility provides a way to break up a complicated report macro file into several files.|
||Inserts the literal characters
||Inserts the literal characters
Next: Email Markup Language (EML)
Table of Contents
Topical Configuration Editor Reference
Alphabetical Configuration Editor Reference
Alphabetical Configuration File Reference
Glossary of Frequently Used Terms