{smcl}
{* 8jan2010}{...}
{cmd:help html}
{hline}

{title:Title}

{pstd}{cmd:html} {hline 2} Combine output in an html file

{title:Syntax}

{phang2}{cmdab:html page} [{cmd:create}] [{cmd:,} {opt p:age(pageid)}]

{phang2}{cmdab:html page clear} [{cmd:,} {opt p:age(pageid)}]

{phang2}{hline 10}

{phang2}{cmdab:html buttons} {it:button_values}{cmd:, }{opt n:ame(string)} {opt i:nit(initial value)} [{it:options}]

{phang2}{cmdab:html boxes} {it:labels}{cmd:, } {opt n:ames(strings)} {opt i:nit(initial values)} [{it:options}]

{phang2}{cmdab:html add,} [{opt t:ext(text)}] [{it:options}]

{phang2}{cmdab:html image} { {it:graph name}|{it:file path} } [{cmd:, }{opt width(pixels)} {it:options}]

{phang2}{cmdab:html printer} [{cmd:pagebreak}] [{cmd:,} {it:options}]

{phang}where [{it:options}] are:

{phang3}{{cmd:top}|{cmd:left}|{opt div(cssid)}} {opt scheme(schemename)} {opt class(css class)} {opt showif(condition)} {opt p:age(pageid)}

{phang2}{hline 10}

{phang2}{cmdab:html write} [{cmd:using}] [{cmd:,} {opt s:cheme(schemename)} {cmd:ms} {opt p:age(pageid)}]

{title:Description}

{pstd}This suite of commands is for incorporating multiple data displays into a single (html) document. Any command that uses the {help outopt:out option} can have its output included, but the most likely choice is {help tlist},
because it will display any tabular data.

{pstd}In general, a series of {cmd:html} and other (data display) commands would be used in sequence to compile an html document. Eg:

{synoptset}{...}
{synopt :{cmd:html page create}}to set up a spot in memory{p_end}
{synopt :{cmd:html buttons}}and...{p_end}
{synopt :{cmd:html boxes}}to act as controls for the data display{p_end}
{synopt :{cmd:tlist}}{p_end}
{synopt :{cmd:tlist}}{p_end}
{synopt :{cmd:tlist}}to add the data{p_end}
{synopt :{cmd:html write}}to save the html file to disk{p_end}
{synopt :{cmd:html page clear}}to free up the memory used for the page in stata{p_end}

{title:Options}

{phang}{opt page(pageid)} specifies which html page (in memory) to act upon. It is only needed if one is compiling more than one page at a time. If no {it:pageid} is specified, the default value {cmd:pg1} is used.

{phang}{cmd:ms} does two separate tasks: If there are images on the page, it writes an "mht" file instead of an html file; that makes the images readable by Internet Explorer 7, and also by Office 2007 apps.
Whether or not there are images present, it also re-formats the style information so that it is interpretable by Word, Excel, etc.

{phang}{cmd:top}, {cmd:left}, and {opt div(cssid)} specify subdivisions of the page where the content should be placed. {cmd:top} and {cmd:left} are intended to function like {it:navbars};
they are fixed in a portion of the window, with the rest of the content scrolling.

{pmore}{opt div(cssid)} has no built-in functionality; it simply places the content in an html {cmd:<div id="}{it:cssid}{cmd:">} which could be used with a custom stylesheet to implement other behaviors.

{phang}{opt scheme(schemename)} specifies style information, either for one element or the whole page. The information is taken from a standard CSS file (though with a {it:tab} between the {it:selector} and {it:declaration};
ie, between the style name and description).
The file must be in the {help sysdir:ado-path}, and named {cmd:html_}{it:schemename}{cmd:.css}.

{phang}{opt showif(condition)} specifies the conditions under which the element will be visible. {it:condition} is a stata logical expression, which would include references to {bf:buttons} and {bf:boxes} on the page.
A {bf:button} reference would be similar to:

{pmore2}{cmd:controls.}{it:button_name}{cmd:=="}{it:button_value}{cmd:"}

{pmore}where any logical operator could substitute for {cmd:==}. A {bf:box} reference would be similar to:

{pmore2}{cmd:controls.}{it:box_name}{cmd:=="yes"}

{pmore}{bf:Boxes} can take on the values {cmd:"yes"} or {cmd:"no"}.

{pmore}{it:condition} can be a complex expression referring to many controls; eg:

{phang3}{cmd:showif(controls.year<"2009" & contols.color=="yellow" | controls.override=="yes")}

{title:Also see}


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