Chapter 2. Reference For apps.xml

Table of Contents

@wuiPageRef(NAME, URL, [ONAME], [ATTRS])
@wuiRefPhpMyAdmin([ONAME], [ATTRS])

@wuiPageRef(NAME, URL, [ONAME], [ATTRS])

Reference to a NST WUI page.

The following parameters are recognized:

NAME

Default name of application (to appear in body of text and default tool tip).

URL

URL to jump to when user clicks (must be properly escaped).

[ONAME]

If not blank, will be inserted in the body of text shown to the user, but not included in the default tool tip.

[ATTRS]

Allows one to override the default "tooltip" attribute. You may also specify any other <a> attributes you want here (other than "href" and "class").

This macro is used to form other macros. It is intended for links to NST WUI pages which you would like to appear in a consistent manner within the main body of text (typically used within paragraphs).

Example of using the macro:

@appRefExt("Inprotect","@topDir()/php/networking/Inprotect.php")
@appRefExt("Nessus","@topDir()/cgi-bin/networking/nessus.cgi","try the Nessus interface","@htmlAttr("title","Go check it out")@htmlAttr("style","font-size: 200%")")

Assuming the com.ccg.macros.at.All class is within your CLASSPATH and the config/apps.at macros file has been generated (Hint: run make atmacros in the wui directory), a developer should be able to run the above example by copy/pasting from below:

[root@probe root]# java com.ccg.macros.at.All <<EOF
@include("config/apps.at",,"d")

@appRefExt("Inprotect","@topDir()/php/networking/Inprotect.php")
@appRefExt("Nessus","@topDir()/cgi-bin/networking/nessus.cgi","try the Nessus interface","@htmlAttr("title","Go check it out")@htmlAttr("style","font-size: 200%")")

EOF

This macro is defined as:

<a
   @htmlAttr("class","appExtRef")@ifEqual("@param(3)",,"
   @htmlAttr("title","Open the '@param(0)' page")","
   @param(3)")
   @htmlAttr("href","@param(1)")>@fnb("@param(2)","@param(0)")</a>