| Dictionary of ODS Language Statements |
Syntax |
| ODS MARKUP <(<ID=>identifier)> <action>; |
| ODS MARKUP <(<ID=>identifier)> <option(s)><TAGSET=tagset-name> <action>; |
An action is one of the following:
closes the destination and any files that are associated with it.
| Tip: | When an ODS destination is closed, ODS does not send output to that destination. Closing an unneeded destination conserves system resources. |
| Feature in: | All examples |
excludes one or more output objects from the destination.
| Default: | NONE |
| Restriction: | A destination must be open for this action to take effect. |
| Main discussion: | ODS EXCLUDE Statement |
selects output objects for the specified destination.
| Default: | ALL |
| Restriction: | A destination must be open for this action to take effect. |
| Main discussion: | ODS SELECT Statement |
writes the current selection or exclusion list for the destination to the SAS log .
| Restriction: | A destination must be open for this action to take effect. |
| See also: | ODS SHOW Statement |
| Tip: | If the selection or exclusion list is the default list (SELECT ALL), then SHOW also writes the entire selection or exclusion list. For information about selection and exclusion lists, see Selection and Exclusion Lists. |
| Options |
| Task | Option | |
|---|---|---|
| Specify a unique base name for the anchor tag that identifies each output object in the current body file. |
ANCHOR= |
|
| Specify which applet to use to view ODS HTML output. |
ARCHIVE= |
|
| Specify attributes to write between the tags that generate dynamic graphics output. |
ATTRIBUTES= |
|
| Specify text to use as the first part of all links and references that ODS creates in output files. |
BASE= |
|
| Open a markup family destination and specify the file that contains the primary output that is created by the ODS statement. |
BODY= |
|
| Specify the character set to be generated in the META declaration for the HTML output. |
CHARSET= |
|
| Open the HTML destination and specify that the file that contains relevant style information. |
CODE= |
|
| Create a file path that can be used by the GOPTIONS devices. |
CODEBASE= |
|
| Open the HTML destination and specify the file that contains a table of contents for the output. |
CONTENTS= |
|
| Override the encoding for input or output processing (transcodes) of external files. |
ENCODING= |
|
| Specify an event and the value for event variables that is associated with the event. |
EVENT= |
|
| Specify the file that integrates the table of contents, the page contents, and the body file. |
FRAME= |
|
| Control the location where footnotes are printed in the graphics output. |
GFOOTNOTE
| NOGFOOTNOTE |
|
| Specify the location for all graphics output that is generated while the destination is open. |
GPATH= |
|
| Control the location where titles are printed in the graphics output. |
GTITLE
| NOGTITLE |
|
| Specify HTML tags to place between the <HEAD> and </HEAD> tags in all the files that the destination writes to. |
HEADTEXT= |
|
| Open multiple instances of the same destination at the same time. |
ID= |
|
| Specify the image resolution for graphical output. |
IMAGE_DPI
= |
|
| Specify HTML code to use as the <META> tag between the <HEAD> and </HEAD> tags in all the HTML files that the destination writes to. |
METATEXT= |
|
| Create a new body file at the specified starting point. |
NEWFILE= |
|
| Open the HTML destination and specify the file that contains a description of each page of the body file, and contains links to the body file |
PAGE= |
|
| Write the specified parameters between the tags that generate dynamic graphics output. |
PARAMETERS= |
|
| Specify the location of an external file or a SAS catalog for all HTML files. |
PATH= |
|
| Specify an alternative character or string to separate lines in the output files. |
RECORD_SEPARATOR= |
|
| Specify a style definition to use in writing output files. |
STYLE= |
|
| Open the HTML destination and place style information for output into an external file, or read style sheet information from an existing file. |
STYLESHEET= |
|
| Specify a keyword value for a tagset. A tagset is a template that defines how to create a markup language output type from a SAS format. |
TAGSET= |
|
| Insert text into your document. |
TEXT= |
|
| Insert into the metadata of a file, a text string that you want to specify as the text to appear in the browser window title bar. |
TITLE= |
|
| Specify a translation table to use when transcoding a file for output. |
TRANTAB= |
|
specifies a unique base name for the anchor tag that identifies each output object in the current body file.
Each output object has an anchor tag for the contents, page, and frame files 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.
is the base name for the anchor tag that identifies each output object in the current body file.
ODS creates unique anchor names by incrementing the name that you specify. For example, if you specify ANCHOR= 'tabulate', then ODS names the first anchor tabulate. The second anchor is named tabulate1; the third is named tabulate2, and so on.
The ARCHIVE= option is valid only for the GOPTIONS java device. The ARCHIVE= option enables you to specify which applet to use in order to view the ODS HTML output.
The string must be one that the browser can interpret. For example, if the archive file is local to the computer that you are running SAS on, you can use the FILE protocol to identify the file. If you want to point to an archive file that is on a web server, use the HTTP protocol .
writes the specified attributes between the tags that generate dynamic graphics output.
specifies the name and value of each attribute. attribute-pair has the following form:
| 'attribute-name'= 'attribute-value' |
| Requirement: | You must enclose attribute-name and attribute-value in quotation marks. |
Specifies the text to use as the first part of all links and references that ODS creates in the output files.
is the text that ODS uses as the first part of all links and references that ODS creates in the file.
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.
| Requirement: | You must enclose base-text in quotation marks. |
opens a markup family destination and specifies the file that contains the primary output that is created by the ODS statement. These files remain open until you do one of the following:
close the destination with either an ODS Markup-family-destination CLOSE statement or ODS _ALL_ CLOSE statement.
open the same destination with a second markup family statement. This closes the first file and opens the second file.
specifies the file, fileref, or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| Restriction: | The BODY=fileref option cannot be used in conjunction with the NEWFILE= option. |
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
specifies an entry in a SAS catalog to write to.
| Interaction: | If you specify an entry name, you must also specify a library and catalog. See the discussion of the PATH= option. |
specifies one or more suboptions in parentheses. Suboptions are instructions for writing the output files. For a list of suboptions, see Suboptions.
Note: For some values
of TAGSET=, this output will be an HTML file, for other TAGSET= values, the
output will be an XML file, and so on. ![[cautionend]](../../../../common/61925/HTML/default/images/cautend.gif)
| Alias: | FILE= |
| Interaction: | If you use the BODY= option in an ODS markup family statement that refers to an open ODS markup destination, the option will force ODS to close the destination and all files associated with it, and then to open a new instance of the destination. For more information see Opening and Closing the MARKUP Destination. |
| Featured in: | All examples |
specifies the character set to be generated in the META declaration for the HTML output.
| See: | For information about the CHARSET option, see SAS National Language Support (NLS): Reference Guide. |
opens a markup family destination and specifies the file that contains relevant style information, such as XSL (Extensible Stylesheet Language). These files remain open until you do one of the following:
close the destination with either an ODS Markup-family-destination CLOSE statement or ODS _ALL_ CLOSE statement.
open the same destination with a second markup family statement. This closes the first file and opens the second file.
specifies the file, fileref, or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
specifies an entry in a SAS catalog to write to.
| Interaction: | If you specify an entry name, you must also specify a library and catalog. See the discussion of the PATH= option. |
specifies one or more suboptions in parentheses. Suboptions are instructions for writing the output files. For a list of suboptions, see Suboptions.
specifies the location of the executable Java applet or the ActiveX control file. string is specified as a pathname or as a URL. The CODEBASE file path option has two definitions, depending on the GOPTIONS device used.
If you use the ActiveX device driver with ODS to generate output containing an ActiveX control, then specify the location and version of the .exe file with the CODEBASE= option on the ODS statement.
| Tip: | You do not need to specify the CODEBASE= option with the DEVICE=ACTIVEX option unless the users that view your output do not have the ActiveX control installed on their machine. |
| See also: | SAS/GRAPH Software: Reference, Volumes 1 and 2 |
If you use the Java device driver with ODS to generate output containing a SAS/GRAPH applet, specify the path to the .jar file with the CODEBASE= option on the ODS statement.
| Tip: | By default, the location of the SAS Java archive files is specified by the APPLETLOC= system option. This value is the default value of the CODEBASE= parameter. If the default location is accessible by users who will be viewing your Web presentation, and the SAS Java archive is installed at that location, then you do not need to change the value of the CODEBASE= parameter. |
| Tip: | Specify only the directory of the .jar file. |
| See also: | SAS/GRAPH Software: Reference, Volumes 1 and 2 |
opens a markup family destination and specifies the file that contains a table of contents for the output. These files remain open until you do one of the following:
close the destination with either an ODS Markup-family-destination CLOSE statement or ODS _ALL_ CLOSE statement.
open the same destination with a second markup family statement. This closes the first file and opens the second file.
specifies the file, fileref, or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
specifies an entry in a SAS catalog to write to.
| Interaction: | If you specify an entry name, you must also specify a library and catalog. See the discussion of the PATH= option. |
specifies one or more suboptions in parentheses. Suboptions are instructions for writing the output files. For a list of suboptions, see Suboptions.
specifies a cascading style sheet to apply to your output.
specifies a file, fileref, or URL that contains CSS code..
file-specification is one of the following:
is the name of the external file.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
is a URL to an external file.
| Requirement: | You must enclose external-file in quotation marks. |
specifies one or more media blocks that corresponds to the type of media that your output will be rendered on. CSS uses media type blocks to specify how a document is to be presented on different media: on the screen, on paper, with a speech synthesizer, with a braille device, etc.
The media block is added to your output in addition to the CSS code that is not contained in any media blocks. By using the media-type suboption, in addition to the general CSS code, you can import the section of a CSS file intended only for a specific media type.
| Default: | If no media-type is specified in your ODS statement, but you do have media types specified in your CSS file, then ODS uses the Screen media type. |
| Range: | You can specify up to ten different media types. |
| Requirement: | You must enclose media-type in parentheses. |
| Requirement: | You must specify media-type next to the file-specification specified by the CSSSTYLE= option. |
| Tip: | If you specify multiple media types, all of the style information in all of the media types is applied to your output. However, if there is duplicate style information in different media blocks, then the styles from the last media block are used. |
| Interaction: | If both the STYLE= option and the CSSSTYLE= option are specified on an ODS statement, the option specified last it the option that is used. |
| Requirement: | CSS files must be written in the same type of CSS produced by the ODS HTML statement. Only class names are supported, with no IDs and no context based selectors. To view the CSS code that ODS creates, you can specify the STYLESHEET= option, or you can view the source of an HTML file and look at the code between the <STYLE> </STYLE> tags at the top of the file. For an example of a valid for ODS CSS file, see Applying a CSS File to ODS Output. |
| Featured in: | Applying a CSS File to ODS Output |
specifies the image resolution for graphical output.
overrides the encoding for input or output processing (transcodes) of external files.
| See: | For information about the ENCODING= option, see SAS National Language Support (NLS): Reference Guide. |
specifies an event and the value for event variables that are associated with the event.
triggers one of the known types of output files that correspond to the BODY=, CODE=, CONTENTS=, FRAME=, PAGES=, and STYLESHEET= options.
triggers the finish section of an event.
| See: | For information about events, see Understanding Events. |
specifies the value for the LABEL event variable.
| Requirement: | variable-value must be enclosed in quotation marks. |
| See: | For information about the LABEL event variable, see Event Variables. |
specifies the value for the NAME event variable.
| Requirement: | variable-value must be enclosed in quotation marks. |
| See: | For information about the NAME event variable, see Event Variables. |
triggers the start section of an event.
| See: | For information about events, see Understanding Events. |
specifies a style element.
| See: | For information about style elements, see Style Attributes and Their Values. |
specifies the value for the TARGET event variable.
| Requirement: | variable-value must be enclosed in quotation marks. |
| See: | For information about the TARGET event variable, see Event Variables. |
specifies the value for the TEXT event variable.
| Requirement: | variable-value must be enclosed in quotation marks. |
| See: | For information about the TEXT event variable, see Event Variables. |
specifies the value for the URL event variable.
| Requirement: | variable-value must be enclosed in quotation marks. |
| See: | For information about the URL event variable, see Event Variables. |
| Default: | (FILE='BODY') |
| Requirement: | The EVENT= option's suboptions must be enclosed in parenthesis. |
opens a markup family destination and, for HTML output, specifies the file that integrates the table of contents, the page contents, and the body file. If you open the frame file, then you see a table of contents, a table of pages, or both, as well as the body file. For XLM output, FRAME= specifies the file that contains the DTD. These files remain open until you do one of the following:
close the destination with either an ODS Markup-family-destination CLOSE statement or ODS _ALL_ CLOSE statement.
open the same destination with a second markup family statement. This closes the first file and opens the second file.
specifies the file, fileref, or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
specifies an entry in a SAS catalog to write to.
| Interaction: | If you specify an entry name, you must also specify a library and catalog. See the discussion of the PATH= option. |
specifies one or more suboptions in parentheses. Suboptions are instructions for writing the output files. For a list of suboptions, see Suboptions.
| Restriction: | If you specify the FRAME= option, then you must also specify the CONTENTS= option, the PAGE= option, or both. |
| Featured in: | Creating an XML File and a DTD |
controls the location where footnotes are printed in the graphics output.
prints footnotes that are created by SAS/GRAPH, which appear inside the graph borders.
prints footnotes that are created by ODS, which will appear outside the graph borders.
specifies the location for all graphics output that is generated while the destination is open.
specifies the file or SAS catalog to write to. 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 about how ODS names catalog entries and external files, see SAS/GRAPH Software: Reference, Volumes 1 and 2. file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref. For information about the FILENAME statement, see SAS Language Reference: Dictionary.
| Interaction: | If you specify a fileref in the GPATH= option, then ODS does not use information from the GPATH= option when it constructs links. |
specifies a URL for file-specification.
is the URL you specify. ODS uses this URL instead of the filename in all the links and references that it creates to the file.
| Requirement: | You must enclose Uniform-Resource-Locator in quotation marks. |
specifies that no information from the GPATH= option appears in the links or references.
| Default: | If you omit the GPATH= option, then ODS stores graphics in the location that is specified by the PATH= option. If you do not specify the PATH= option, then ODS stores the graphics in the current directory. For more information, see the PATH= option. |
controls the location where titles are printed in the graphics output.
prints the title that is created by SAS/GRAPH, which will appear inside the graph borders
prints the title that is created by ODS, which will appear outside the graph borders.
specifies markup tags to place between the <HEAD> and </HEAD> tags in all the files that the destination writes to.
is the markup tags to place between the <HEAD> and </HEAD> tags.
| Requirement: | You must enclose markup-document-head in quotation marks. |
enables you to run multiple instances of the same destination at the same time. Each instance can have different options.
specifies another instance of the destination that is already open. identifier is numeric or a series of characters that begin with a letter or an underscore. Subsequent characters can include letters, underscores, and numeric characters.
| Restriction: | If identifier is numeric, it must be a positive integer. |
| Requirement: | The ID= option must be specified immediately after the ODS MARKUP/TAGSET statement keywords. |
| Tip: | You can omit the ID= option, and instead use a name or a number to identify the instance. |
| Featured in: | Opening Multiple Instances of the Same Destination at the Same Time |
specifies HTML code to use as the <META> tag between the <HEAD> and </HEAD> tags of all the HTML files that the destination writes to.
specifies the HTML code that provides the browser with information about the document that it is loading. For example, this attribute could specify the content type and the character set to use.
| Requirement: | You must enclose metatext-for-document-head in quotation marks. |
creates a new body file at the specified starting-point.
is the location in the output where you want to create a new body file.
ODS automatically names new files by incrementing the name of the body file. In the following example, ODS names the first body file REPORT.XML. Additional body files are named REPORT1.XML, REPORT2.XML, and so on.
BODY= 'REPORT.XML'
starting-point is one of the following:
starts a new body file for each output object. For SAS/GRAPH this means that ODS creates a new file for each SAS/GRAPH output file that the program generates.
| Alias: | TABLE |
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.
starts a new body file each time that you start a new procedure.
| See: | GFOOTNOTE | NOGFOOTNOTE options |
| See: | GTITLE | NOGTITLE options |
opens a markup family destination and specifies the file that contains a description of each page of the body file, and contains links to the body file. ODS produces a new page of output whenever a procedure requests a new page. These files remain open until you do one of the following:
close the destination with either an ODS Markup-family-destination CLOSE statement or ODS _ALL_ CLOSE statement.
open the same destination with a second markup family statement. This closes the first file and opens the second file.
specifies the file, fileref, or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
specifies an entry in a SAS catalog to write to.
| Interaction: | If you specify an entry name, you must also specify a library and catalog. See the discussion of the PATH= option. |
specifies one or more suboptions in parentheses. Suboptions are instructions for writing the output files. For a list of suboptions, see Suboptions.
writes the specified parameters between the tags that generate dynamic graphics output.
specifies the name and value of each parameter. parameter-pair has the following form:
| 'parameter-name'= 'parameter-value' |
| Requirement: | You must enclose parameter-name and parameter-value in quotation marks. |
specifies the location of an external file or a SAS catalog for all markup files.
specifies the file or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
specifies a SAS catalog to write to.
| See: | For information about the LIBNAME statement, see SAS Language Reference: Dictionary. |
specifies a URL for the file-specification.
is the URL you specify. ODS uses this URL instead of the filename in all the links and references that it creates to the file.
specifies that no information from the PATH= option appears in the links or references.
specifies an alternative character or string that separates lines in the output files.
Different operating environments use different separator characters. If you do not specify a record separator, then the files are formatted for the environment where you run the SAS job. However, if you are generating files for viewing in a different operating environment that uses a different separator character, then you can specify a record separator that is appropriate for the target environment.
represents one or more characters in hexadecimal or ASCII format. For example, the following option specifies a record separator for a carriage return character and a linefeed character for use with an ASCII file system:
RECORD_SEPARATOR= '0D0A'x
Operating Environment Information: In a mainframe environment, the option that specifies a record separator for a carriage return character and a linefeed character for use with an ASCII file system is:
RECORD_SEPARATOR= '0D25'x
| Requirement: | You must enclose alternative-separator in quotation marks. |
produces the markup language that is appropriate for the environment where you run the SAS job.
Operating Environment Information: In a mainframe environment, by default, ODS produces a binary file that contains embedded record separator characters. This binary file is not restricted by the line-length restrictions on ASCII files. However, if you view the binary files in a text editor, then the lines run together.
If you want to format the files so that you can read
them with a text editor, then use RECORD_SEPARATOR= NONE. In this case, ODS
writes one line of markup language 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 the logical
record length of the file is not long enough, then the markup language might
wrap to another line at an inappropriate place. ![[cautionend]](../../../../common/61925/HTML/default/images/cautend.gif)
| Alias: |
|
specifies the style definition to use in writing the output files.
describes how to display the presentation aspects (color, font face, font size, and so on) of your SAS output. A style definition determines the overall appearance of the documents that use it. Each style definition consists of style elements.
| Main discussion: | For a complete discussion of style definitions, see TEMPLATE Procedure: Creating a Style Definition. |
| Interaction: | The STYLE= option is not valid when you are creating XML output. |
opens a markup family destination and places the style information for markup output into an external file, or reads style sheet information from an existing file. These files remain open until you do one of the following:
close the destination with either an ODS Markup-family-destination CLOSE statement or ODS _ALL_ CLOSE statement.
open the same destination with a second markup family statement. This closes the first file and opens the second file.
specifies the file, fileref, or SAS catalog to write to.
file-specification is one of the following:
is the name of an external file to write to.
| Requirement: | You must enclose external-file in quotation marks. |
is a file reference that has been assigned to an external file. Use the FILENAME statement to assign a fileref.
| See: | For information about the FILENAME statement, see SAS Language Reference: Dictionary. |
specifies an entry in a SAS catalog to write to.
| Interaction: | If you specify an entry name, you must also specify a library and catalog. See the discussion of the PATH= option. |
specifies one or more suboptions in parentheses. Suboptions are instructions for writing the output files. For a list of suboptions, see Suboptions.
Note: By default, if you
do not specifically send the information to a separate file, then the style
sheet information is included in the specified HTML file. ![[cautionend]](../../../../common/61925/HTML/default/images/cautend.gif)
| Featured in: | Including Multiple Cascading Style Sheets in One HTML Document |
specifies a keyword value for a tagset. A tagset is a template that defines how to create a markup language output type from a SAS format. Tagsets produce markup output such as Hypertext Markup Language (HTML), Extensible Markup Language (XML), and LaTeX.
An alternate form for specifying a tagset is as follows:
|
| Alias: | TYPE= |
| Default: | If you do not specify a TAGSET= value, then the ODS MARKUP statement defaults to XML output. |
| Interaction: | If you use the TAGSET= option in an ODS markup family statement that refers to an open ODS markup destination, then the option will force ODS to close the destination and all files associated with it, and then to open a new instance of the destination. For more information, see Opening and Closing the MARKUP Destination. |
| Tip: |
SAS provides a set of tagset
definitions. To get a list of the tagset names that SAS supplies, plus any
tagsets that you created and stored in the SASUSER.TMPLMST template store,
submit the following SAS statements:
proc template; list tagsets; run; |
| See also: | For additional information about specifying tagsets, see TEMPLATE Procedure: Creating Markup Language Tagsets. |
| Featured in: |