set command_format_procs "/neowebscript/commands/command_include.nws"
load_virtual $command_format_procs
##############################
#
#
# Begin variables - start editing with new info
#
#
##############################
set command_name "escape_attribute"
set title_name "ESCAPE_ATTRIBUTE"
set package_name "Neowebscript"
set short_description "Escapes reserved SGML characters."
set synopsis {
escape_attribute ?-option? string
}
set description {
Replaces special characters in string that are usually reserved in
HTML document character set. The following special characters are replaced
with the following named character entities:
Character: | Replacement: |
& | & |
< | < |
> | > |
" | " |
|
|
' | ' |
The -option specifies the character used for padding string
(the default is -noquotes).
Option: | Character: |
-doublequotes | " |
-singlequotes | ' |
-noquotes | |
The command is targetted to INPUT variables within FORM documents, and may be
used in general to safely escape special characters in any attribute within
an HTML element. However, anchor links or any attribute containing a
relative or absolute URI should be escaped using quote_string.
}
##############################
#
#
# End variables - do not edit past this point
#
#
##############################
emit_command_page