Table of Contents
ID, [EXPANDED], [ATTRS], [SHOW])ID, [PARAMS], [FITMODE], [FILENAMETITLE])[ATTRS], [DELAY_HEADER])TYPE, ID, TEXT, [ATTRS])TEXT, [Caution Title])TEXT)ID, [TITLE], [Hn], [INITSTATE], [ImgScale], [ANCHOR])ID, [TITLE], [Hn], [INITSTATE])COLOR, BACKGROUND_COLOR, BORDER_COLOR, BORDER_WIDTH)REL_FILE_PATH, [DISP])TITLE, URL, [SHOW], [ATTRS])IMG, [TITLE])FILENAME, [ATTRS])[INDICATOR], [COLOR])TOOLTIP, SUPER)URL, SUPER)ANAME, LABEL, TEXT)ACTION, [ID], [ATTRS], FORCE_METHOD)TEXT)TEXT)[TITLE], [ADD_STD_INCLUDES], [SOURCE_FILE], [ATTRS], [HTML_ATTRS])NAME, [VALUE])ENTITY, [TEXT], [ATTR])[MIME_TYPE], [RFC_2822_DATE])ID)[IP])IP, [ATTRS])IP)CODE)CODE, LABEL, [TITLE], [ATTRS])CODE, LABEL, [TITLE], [ATTRS])TEXT)TEXT, [COLOR])TEXT, [COLOR])TEXT, COLOR)TEXT, [COLOR], [ID])TEXT)TEXT)TEXT)TEXT)TEXT, CLASS)PROGRAM, [LABEL], [TITLE], [ATTRS])PROGRAM, [LABEL], [PAGESECTION], [MANSECTION])ID, HEIGHT_PIXELS)TYPE, ID, TEXT)TEXT, [Note Title], [Note Title Space], [Fieldset Attrs])TEXT, [HEADERTAG])INTERFACE, [SHOW], [ATTRS])INTERFACE, ID)URL, TITLE)[MODE])[ANAME], [TEXT])URL, IMGSRC, TEXT, [WIDTH], [HEIGHT])NAME, [TEXT])NAME)PAGE_NAME, SHOW, ATTRS)PAGE_NAME, SHOW, ATTRS, CLASS)[ANAME], [TEXT])URL)TEXT, [URL])TEXT, [URL])TEXT, [URL])TEXT, [URL])TEXT, [URL])[RETURNLABEL])[RETURNLABEL])[RETURNLABEL])[RETURNLABEL])ABS_FILE_PATH, [DISP])FSNAME, [SHOW], [ATTRS])TEXT)[LABEL], [ATTRS])REL_FILE_PATH, [DISP])FILE, [LINES], [LABEL], [RETURN], [RETURN_LABEL], [TEXT_MODE], [DISPLAY_WIDTH], [LINE_NUMBER])TEXT, [TIPTITLE])HEADER, [ATTRIBUTES])DATA, [ATTRIBUTES])HEADER, DATA, [HEADER_ATTR], [DATA_ATTR])HEADER, DATA, [HEADER_ATTR], [DATA_ATTR])HEADER, [ATTRIBUTES])[ATTRIBUTES])DATA, [ATTRIBUTES])HEADER, DATA, [HEADER_ATTR], [DATA_ATTR])HEADER, DATA, [HEADER_ATTR], [DATA_ATTR])[TITLE], [WIDTH])TH_TEXT, TD_TEXT, [TD_TEXT_QUOTE])TH_TEXT, TD_TEXT, [TD_TEXT_QUOTE])TEXT)ACRONYM)ACTION, [SINGLE_QUOTE])CMD, [AFTER_COLON])TEXT, [SINGLE_QUOTE])TEXT, [SINGLE_QUOTE])TEXT, [SINGLE_QUOTE])TEXT, [SINGLE_QUOTE])TEXT, [SINGLE_QUOTE])TEXT, [SINGLE_QUOTE])TEXT, [SINGLE_QUOTE])PAGE)SITE)VALUE, [DOUBLE_QUOTE])VALUE, [DOUBLE_QUOTE])VALUE, [DOUBLE_QUOTE])VALUE, [DOUBLE_QUOTE])TEXT, [DOUBLE_QUOTE])TEXT, [DOUBLE_QUOTE])[VERSION])COLSPAN, [LINEHEIGHT], [SEPARATORCOLOR], [TEXTLABEL])[TEXT])TEXT, [Warning Title])[ID], [LABEL], [TITLE], [ATTRS], [CONFIRM])[ID], [LABEL], [TITLE], [ATTRS], [RANDOMCONFIRM])[URL], [LABEL], [HIDDEN], [TITLE], [ATTRS])FILE, [LABEL], [TITLE], [MIMETYPE], [NAME], [BUTTONATTRS])FORM ID, FIELD, LOAD, [DISPLAY], [URL], [TITLE], [VALIDATE])FORM ID, FIELD, APPEND, [DISPLAY], [URL], [TITLE], [VALIDATE])CMD, FILENAME, LABEL, [MIME], [TITLE])[ANCHOR], [TEXT], [Hn], [ImgScale], [ANCHOR])[ANCHOR], [TEXT], [Hn])[MODE])TITLE, URL, SRC, [HEADER])IP, [LABEL], [RETURN], [TITLE])JUMP_TO_URL, RETURN_TO_URL, LABEL, [HIDDEN])URL, [LABEL], [ATTRBUTES])URL, [LABEL], [ATTRBUTES], [WIDTH])NAME, [VALUE], [TITLE], [ATTRS])NAME, [VALUE], [TITLE], [ATTRS])ONCLICKHANDLER, [VALUE], [TITLE], [ATTRS])NAME, [VALUE], [DISPLAY], [checked], [TITLE])NAME, [VALUE], [TITLE])NAME, [SIZE], [ATTRS])NAME, VALUE, [ATTRS])TEXT, [LABEL], LABELWIDTH, TEXTWIDTH)NAME, [VALUE], [MAXLENGTH], [SIZE], [TITLE])NAME, [VALUE], [MAXLENGTH], [SIZE], [TITLE], [CLASS])NAME, [VALUE], [DISPLAY], [checked], [TITLE])NAME, [VALUE], [LABEL], [RATTRS])NAME, [VALUE], [TITLE])TEXT, [TITLE], [ATTRS])[LABEL], [TITLE], [ATTRS])NAME, [VALUE], [MAXLENGTH], [SIZE], [TITLE])NAME, [VALUE], [ROWS], [COLS], [TITLE], [CLASS], [ATTRIBUTES])NAME, [VALUE], [MAXLENGTH], [SIZE], [TITLE], [CLASS])JAVASCRIPT, LABEL, [TITLE], [ATAGATTRS], [STYLEATTRS])ISO_DISTRO_VER, [SRCNAME], [SRCURL], [XML], [NSTWUIBUILDDATE])[NAME_IP], [DATE_TIME], [UP_TIME], [LOAD_AVG], [NOFRAMES_URL], [XML])SCRIPT_NAME, [TEXT], [TITLE])SCRIPT_NAME, [TEXT])SCRIPT_NAME, [TEXT])COUNT, TYPE, ATTR)XAPP, LABEL, [RETURN], [TITLE], [SYNCKEY], [RETURN_FROM], [RETURN_LABEL], [ATTRS])REL_FILE_PATH, [DISP])XML, XSL, [LABEL], [MIME_TYPE], [TITLE], [FORMATTRS], [XSLTPROC_PARAMS], [BUTTONATTRS])XML, XSL, [LABEL], [MIME_TYPE], [TITLE], [XSLTPROC_PARAMS], [BUTTONATTRS], [PAGE_TITLE])ID, [WIDTH], [HEIGHT])PATH, [SHOW])PATH, [SHOW], [ATTRS])ID)CMD, [FILENAMEPREFIX], [ID], [FCPARAMS], [COPARAMS], [PROGRESSTEXT])CMD, [FILENAMEPREFIX], [ID], [FCPARAMS], [COPARAMS], [PROGRESSTEXT])JSCMDARRAY, [FILENAMEPREFIX], [ID], [FCPARAMS], [COPARAMS])JSCMDARRAY, [FILENAMEPREFIX], [ID], [FCPARAMS], [COPARAMS], [PROGRESSTEXT])SERVICES)SERVICES, HREF)IPv4ADDRESS, [ATTRS])HOSTNAME, [ATTRS])IPv46ADDRESSORHOSTNAME, [ID], [ATTRS])MACADDRESS, [ATTRS])RFC)Reference to a acronym.
The following parameters are recognized:
The acronym ID (often the acronym itself) to use.
The expanded version of the acronym (what it stands for).
Allows one pass optional attributes to the <acronymn> entity.
The value to show for the acronym (only needed if ID won't work).
This macro is used to reference a macro defined in: "include/data/acronyms-db.xml". It is typically used in by macros prefixed by "acro" (like @acroCPU()). It is intended to form acronyms which are used throughout the NST documentation. NOTE: One should NOT use this macro directly (update the acronym database which then uses this macro).
Example of using the macro:
@acronym("NST","Network Security Toolkit")
Assuming the com.ccg.macros.at.All
class is within your CLASSPATH and the
config/html.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/html.at",,"d")@acronym("NST","Network Security Toolkit")EOF
This macro is defined as:
<a @htmlAttr("class","acronymLink")
@htmlAttr("target","_blank")@ifEqual("@param(2)",,"
@htmlAttr("onmouseover","NstAcro.ttActivate(this, event, '@param(0)', @ifEqual("@param(2)",,"null","'@param(2)'"));")")><acronym @htmlAttr("class","acronymLink")>@fnb("@param(3)","@param(0)")</acronym></a>