{smcl}
{* 7oct2009}{...}
{cmd:help out option}
{hline}

{title:Title}

{pstd}{cmd:Output format and destination}

{title:Syntax}

{pmore}{it:command}{cmd:,} {it:options} {cmd:out(}[{it:type}] [{it:modifiers}]{cmd:)}

{pstd}where {it:type} is {bf:one} of

{pmore}{opt s:tata}

{pmore}{opt v:iew} or {opt v:iew(destination)}

{pmore}{opt hy:brid} or {opt hy:brid(destination)}

{pmore}{opt ht:ml} or {opt ht:ml(destination)}

{pstd}and {it:modifiers} are

{pmore}{opt sch:eme(schemename)}

{pmore}{opt ap:pend}

{pmore}{opt showif(condition)}

{pmore}{ {opt top} | {opt left} | {opt div(cssid)} }

{pmore}{cmd:ms}

{title:Description}

{pstd}{opt out()} specifies where & how the output from its command appears.

{title:Options - {it:type}}

{phang}{opt s:tata} specifies ordinary Stata output. This is the default if no {it:type} is specified.

{phang}{opt v:iew} sends the output to a Stata view window, instead of the results window.

{phang}{opt hy:brid} is essentially for email. The output will be nearly identical to Stata format, and can be cut & pasted from a browser into any HTML capable email, and will appear just the same in the email.

{phang}{opt ht:ml} specifies a standard HTML table, viewed in a browser. This format can potentially take full advantage of HTML/CSS.
It cannot be directly pasted into an email, but it can be opened in a word processor or spreadsheet with styling intact.

{pstd}A {it:destination} can optionally be specified for output other than {opt s:tata}.

{phang2}For {opt v:iew}, {it:destination} is the name of a viewer window.

{phang2}For {opt hy:brid} or {opt ht:ml}, if {it:destination} matches an existing {cmd:html} {it:pageid} (see {help html}), it will be interpreted as such; otherwise, it will be the filename of an html file.

{title:Options - {it:modifiers}}

{phang}{opt scheme(schemename)} be used with any {it:type}. It specifies style information, such as fonts, colors, lines, etc. {it:schemename} references a file which contains the relevant details. See Remarks, below.

{pmore}As of 9 Dec 2010, there is one globally available scheme besides the defaults: It is a {cmd:hybrid} scheme named {cmd:pr} that creates output with a white background, suitable for monochrome printing (though colored on-screen).

{phang}{opt showif(condition)}, and {cmd:top}/{cmd:left}/{opt div(cssid)} can be used with {it:type}s {opt ht:ml} and {opt hy:brid}, but they are only relevant in conjunction with the {help html} command, and they are documented there.

{phang}{opt append} can be used with {it:type} {opt v:iew}. It will append output to a window instead of over-writing it. However, realistically, you can only append to the most recent window.
This is becuase the same physical file is re-used for all views. Could be changed if it seems important enough.

{pmore}*Note that {opt hy:brid} and {opt ht:ml} output can be compiled on a single page using the {help html} command.

{phang}{cmd:ms} can be used with {it:type} {opt ht:ml}. It processes the final file so that Word, Excel, etc., read the style information properly.
When adding material to an {help html} page, this option has no effect. The ms-readability of the output will be determined by the {opt ms} option of the {help html:html write} command.

{title:Remarks}

{pstd}The {opt scheme(schemename)} option is exactly analogous to the {opt scheme(schemename)} option for graphs. {it:schemename} references a file that contains the details.

{pstd}{it:Type}s {opt s:tata} and {opt v:iew} use files named like {cmd:tscheme-sta-}{it:schemename}{cmd:.tscheme}. When no {opt scheme()} is specified, they use the default file {cmd:tscheme-sta.tscheme}.

{pstd}{it:Type} {opt hy:brid} uses {cmd:tscheme-hyb-}{it:schemename}{cmd:.tscheme}. When no {opt scheme()} is specified, it uses the default file {cmd:tscheme-hyb.tscheme}.

{pstd}The format of the {cmd:.tscheme} files is not documented, but the default files and {cmd:tscheme-hyb-pr.tscheme} are available as examples...

{pstd}{it:Type} {opt ht:ml} uses (nearly) standard CSS files as schemes. The filenames are like {cmd:html_}{it:schemename}{cmd:.css}. For more info, see the {help html} command.

{title:Also see}

{pstd}Contact: {browse "mailto:elliott.lowy@va.gov":Elliott Lowy}