| To do this ... |
Use this option |
| Specify the base name for the HTML anchor tag that identifies
each output object in the current body file |
ANCHOR= |
| Specify a string to use as the first part of all links
and references that ODS creates in the HTML files |
BASE= |
| Control the destination of the footnotes that are defined
by the graphics program that generates the HTML output |
GFOOTNOTE | NOGFOOTNOTE |
| Specify the destination for all graphics output that
is generated while the HTML destination is
open |
GPATH= |
| Control the destination of the titles that
are defined by the graphics program that generates the HTML output |
GTITLE | NOGTITLE |
| Specify HTML to place between the <HEAD> and
</HEAD> tags
in all the HTML files that the HTML destination writes to |
HEADTEXT= |
| Specify HTML to use as the <META> tag inside the <HEAD>
and
</HEAD> tags
of all the HTML files that the HTML destination writes to |
METATEXT= |
| Create a new body file at the specified starting-point |
NEWFILE= |
| Specify the location (an external file or a SAS catalog)
for all HTML files |
PATH= |
| Specify an alternative record separator for the HTML
files |
RECORD_SEPARATOR |
| Specify the style definition to use in writing the HTML
files |
STYLE= |
| Translate the HTML files to the requested represention |
TRANTAB= |
-
ANCHOR='anchor-name'
- specifies the base name for the HTML anchor
tag that identifies each output object in the current body file. Each output
object must have an anchor tag for the contents, page, and frame files to
link to or to reference. The links and references, which are automatically
created by ODS, point to the name of an anchor. Therefore, each anchor name
in a file must be unique.
ODS creates unique anchor names by incrementing the
name that you specify. For example, if you specify ANCHOR='tabulate', ODS
names the first anchor tabulate. The second
anchor is named tabulate1; the third is named tabulate2, and so on.
You can change anchor names as often as
you like by
submitting the ANCHOR= option in an ODS HTML statement anywhere in your program.
Once you have specified an anchor name, it remains in effect until you specify
a new one.
| Default: |
IDX |
| Interaction: |
If you open an HTML
file to append to it, be sure to specify a new anchor so that you don't write
the same anchors to the file again. ODS cannot know about anchors that are
already in a file when it opens the file. |
| Tip: |
Specifying new anchor names
at various points in your program is useful when you want other web pages
to link to specific parts of your HTML output. Because you can control where
the anchor name changes, you know ahead of time what the anchor name will
be at those points. |
| See also: |
How ODS Constructs Links and References |
| Featured
in: |
Appending to HTML Files |
-
BASE='string'
- Specifies a string to use as the first part
of all links and references that ODS creates in the HTML files. Consider this
specification:
BASE='http://www.your-company.com/local-url/'
In this case,
ODS creates links that begin with the string http://www.your-company.com/local-url/. The appropriate anchor-name
completes the link.
-
GFOOTNOTE | NOGFOOTNOTE
- controls the destination of the footnotes
that are defined by the graphics program that generates the HTML output. GFOOTNOTE
includes all the currently defined footnotes within the graphics output (the
GIF file) that is called by the body file. NOGFOOTNOTE suppresses all the
currently defined footnotes from appearing in the GIF files. Instead, they
become part of the body file.
| Default: |
GFOOTNOTE |
| Restriction: |
Footnotes that are
displayed by ODS HTML support most SAS/GRAPH FOOTNOTE
statement options. The font must be valid for the browser. Options that ODS
cannot handle, such as height and text angle specifications, are ignored.
For details, see "TITLE, FOOTNOTE, and NOTE Statements" in "SAS/GRAPH Statements"
in SAS/GRAPH Software: Reference. |
| Restriction: |
This option applies
only to SAS programs that produce one or more GIF files. |
-
GPATH=file-specification <(url='Uniform-Resource-Locator' | NONE)>
- specifies the destination for all graphics
output that is generated while the HTML destination is open.
- file-specification
- identifies the file or SAS catalog to write
to. If you specify a file, it should be an aggregate storage location, such
as a directory or partitioned data set. Each output object that ODS places
in the file is named automatically using the SAS/GRAPH catalog
entry name as the base name and incrementing the name as necessary. For more
information on how ODS names catalog entries and external files, see "ODS
HTML Statement" in "SAS/GRAPH Statements" in SAS/GRAPH Software: Reference.
file-specification can
be one of the following:
- 'external-file'
- is the name of an external file to write
to.
- fileref
- is a fileref that has been assigned to an
external file. Use the FILENAME statement to assign a fileref. (For information
on the FILENAME statement, see the section on statements in SAS Language Reference: Dictionary).
- libref.catalog
- specifies a SAS catalog to write to.
-
URL='Uniform-Resource-Locator' | NONE
- provides a URL for file-specification. ODS uses this URL instead of the file name in all the links
and references that it creates to the file. If you specify the keyword NONE,
no information from the GPATH= option appears in the links or references.
| Default: |
If you omit GPATH=,
ODS stores graphics in the location that is specified by PATH=. (See the discussion
of PATH=.) If you do not specify PATH=, ODS stores the graphics in the current
directory. |
-
GTITLE | NOGTITLE
- controls the destination of the titles that
are defined by the graphics program that generates the HTML output. GTITLE
includes all the currently defined titles within the graphics output that
is called by the body file. NOGTITLE suppresses all the currently defined
titles from appearing in the graphics output. Instead, they become part of
the body file.
| Default: |
GTITLE |
| Restriction: |
Titles that are
displayed by ODS HTML support most SAS/GRAPH TITLE
statement options. The font must be valid for the browser. Options that ODS
cannot handle, such as height and text angle specifications, are ignored.
For details, see "TITLE, FOOTNOTE, and NOTE Statements" in "SAS/GRAPH Statements"
in SAS/GRAPH Software: Reference. |
| Restriction: |
This option applies
only to SAS programs that produce one or more GIF files. |
-
HEADTEXT='HTML-for-document-head'
- specifies HTML to place between the <HEAD> and </HEAD> tags
in all the HTML files that the HTML destination writes to. Use HEADTEXT= to
define programs (for example, java scripts) that you can use later in the
file.
| Tip: |
ODS cannot parse the HTML
that you supply. It should be well-formed HTML that makes sense in the context
of the <HEAD> and </HEAD> tags. For information on HTML, refer to one
of the many reference books that are available on the subject. |
-
METATEXT='HTML-for-document-head'
- specifies HTML to use as the <META> tag
between the <HEAD> and </HEAD> tags of all the HTML files that the HTML
destination writes to. This HTML provides the browser with information about
the document that it is loading. This information could include things like
the content-type and the character set to use. For information on HTML, refer
to one of the many reference books that are available on the subject.
| Default: |
If you do not specify
METATEXT=, ODS writes a simple <META> tag, which includes the content-type
of the document and the character set to use, to all the HTML files that it
creates. |
| Tip: |
ODS cannot parse the HTML
that you supply. It should be well-formed HTML that makes sense in the context
of the <HEAD> tags. If you are using METATEXT= as it is intended, your
HTML should look like this:
<META your-metatext-which-could-be-very-long> |
-
NEWFILE=<starting-point>
- creates a new body file at the specified starting-point. ODS automatically names new files by incrementing
the name of the body file. For example, if you specify BODY='REPORT.HTML',
ODS names the first body file REPORT.HTML. Additional body files are named
REPORT1.HTML, REPORT2.HTML, and so forth. If you end the file name with a
digit, ODS begins incrementing with that digit. For instance, if you specify
BODY='MAY5.HTML', ODS names the first body file MAY5.HTML. Additional body
files are named MAY6.HTML, MAY7.HTML, and so forth.
starting-point can be one
of the following:
- NONE
- writes all output to the body file that
is currently open.
- OUTPUT
- starts a new body file for each output object.
For SAS/GRAPH this means that ODS creates
a new file for each GRSEG or GIF file that the program generates.
- PAGE
- starts a new body file for each page of
output. A page break occurs when a procedure explicitly starts a new page
(not because the page size was exceeded) or when you start a new procedure.
- PROC
-
starts a new body file each time that you start a new
procedure.
- NOGFOOTNOTE
- See the discussion of GFOOTNOTE |
NOGFOOTNOTE.
- NOGTITLE
- See the discussion of GTITLE |
NOGTITLE.
-
PATH=file-specification<(URL='Uniform-Resource-Locator' |
NONE)>
- specifies the location (an external file
or a SAS catalog) for all HTML files.
- file-specification
- identifies the file or SAS catalog to write
to. If you specify a file, it should be an aggregate storage location, such
as a directory or partitioned data set.
file-specification can
be one of the following:
- 'external-file'
- is the name of an external file to write
to.
- fileref
- is a fileref that has been assigned to an
external file. Use the FILENAME statement to assign a fileref. (For information
on the FILENAME statement, see the section on statements in SAS Language Reference: Dictionary).
- libname.catalog
- specifies a SAS catalog to write to.
- URL='Uniform-Resource-Locator' |
NONE
- provides a URL for file-specification. ODS uses this URL instead of the file name in all the links
and references that it creates to the file. If you specify the keyword NONE,
no information from the PATH= option appears in the links or references.
-
RECORD_SEPARATOR='string' |
NONE
- specifies an alternative record separator
for the HTML files. A record separator is the character or string that separates
lines in the HTML files.
Different operating environments use different separator
characters. If you don't specify a record separator, the HTML files are formatted
for the environment that you run the SAS job in. However, if you are generating
files in one operating environment for viewing in another operating environment
that uses a different separator character, you can specify a record separator
that is appropriate for the target environment.
- 'string'
- is the hexadecimal representation of one
or more characters. For example, the following option specifies a record-separator
of a carriage-return character and a linefeed character (on an ASCII file
system):
RECORD_SEPARATOR='0D0A'x
- NONE
- produces HTML that is appropriate for the
environment that you run the SAS job in. In many operating environments, using
a value of NONE is the same as omitting the RECORD_SEPARATOR option. However,
in mainframe operating environments, it is not.
Operating Environment Information: In a mainframe environment, by default, ODS produces
a binary file that contains embedded record-separator characters. While this
approach means that the file is not restricted by the line-length restrictions
on ASCII files, it also means that if you view the file in an editor, the
lines all run together.
If you want to format the HTML files so that you can
read them with an editor, use RECORD_SEPARATOR=NONE. In this case, ODS writes
one line of HTML at a time to the file. When you use a value of NONE, the
logical record length of the file that you are writing to must be at least
as long as the longest line that ODS produces. If it isn't, the HTML may wrap
to another line at an inappropriate place. ![[cautionend]](../common/images/cautend.gif)
-
STYLE='style-definition'
- specifies the style definition to use in
writing the HTML files. For more information, see Style Definitions, Style Elements, and Style Attributes.
-
TRANTAB='translation-table'
- translates the HTML files to the requested
represention. This option is particularly useful if you are creating files,
for example, on an EBCDIC-based operating system and if the files are destined
for an ASCII-based web server. If you use TRANTAB=, you can transfer the files
in binary mode because they are already in the appropriate representation.
(SAS facilities for changing translation tables are much more flexible than
those of FTP, for example.)
translation-table can be
any translation table that SAS provides or any user-defined translation table.
| See also: |
For information on
translation tables, see the documentation of the TRANTAB= system option in
the section on system options in SAS Language Reference: Dictionary.
For information on creating, editing, and displaying
customized translation tables, see "The TRANTAB Procedure" in SAS Procedures Guide.
You can also use PROC TRANTAB to view and modify translation tables that are
supplied by SAS Institute. |
![[arrow]](../common/images/arrow.gif){kind=icon}