Title

hhelp -- Open the online HTML version of help document for specific command

Syntax

hhelp command_name [,
markdown
txt
ms
texfull
latex
format(#)
clipoff]

Format provide web link to online help document and automatically copy to the clipboard
markdown in markdown format

txt in plain text format, which can be pasted into the dialog box of Facebook or WeChat for Chinese users.

ms copy rich text punctuated with links to clipboard, which can be pasted into MicroSoft documents.

texfull in LaTeX full syntax format

latex in LaTeX compact format

format(#) in preset formats, including three modes

clipoff do not copy the link to the clipboard

Description

hhelp can quickly open the online HTML version of official Stata help files. As a simplification of wwwhelp, it allows faster access to the HTML version without any options.

For example, wwwhelp xtreg, web is equivalent with hhelp xtreg.

Options

provide web links to the HTML version of online help files, which can be put into specific format and automatically copied to the clipboard

markdown displaying the web link in Markdown format. For example, hhelp regress, markdown displays the text in the following format:

[**[R]** regress](https://www.stata.com/help.cgi?regress)

It can be copied to a Markdown file and displayed as a clickable link: [R] regress

txt displaying the web link in text (command:URL) format. For example, hhelp regress, txt displays the text in the following format:

[R] regress: https://www.stata.com/help.cgi?regress

It can be copied to the dialog box of Facebook or WeChat for Chinese users.

ms sends a rich text punctuated with links to the clipboard, which can be pasted easily to the MicroSoft Word. For example, hhelp regress, ms, When pressing ’Command+V’ in the MicroSoft Word, the text will appear as a clickable
link. [R] regress

However, this option has some limitations. It requires Stata 16 or newer versions of Stata to be installed as well as python, because the commands call the Windows API through Stata's interaction with Python; and it is currently only available for Windows systems. Otherwise, it will automatically switch to the txt option, which displays a plain text with links. (command:URL)

texfull displaying the web link in full TeX text format. For example, hhelp regress, texfull displays the text in the following format:

\href//www.stata.com/help.cgi?regress{\bfseries{[\MakeUppercase] regress}}

It can be inserted into a .tex document, which will displayed as a clickable link in the PDF file when compiled using a TeX editor: [R] regress

latex displaying the web link in Latex format. For example, hhelp regress, latex displays the text in the following format:

\stwwwhelp[r]

It can be inserted into a .tex document, which will displayed as a clickable link in the PDF file when compiled using a TeX editor: [R] regress

Note: Since \stwwwhelp is a new user-defined command, it needs to be defined by adding the following to the introductory section of the .tex document.

\newcommand{\stwwwhelp}[2][r]{

\href//www.stata.com/manuals/#1#2.pdf{\bfseries{[\MakeUppercase{#1}] #2}}

}

format(#) displaying web links in three supporting Markdown preset formats.

format(1) is rendered in Markdown as [R] regress. The text displayed is formatted as follows:

[**[R]** regress](https://www.stata.com/help.cgi?regress)

format(2) is rendered in Markdown as regress. The text displayed is formatted as follows:

[regress](https://www.stata.com/help.cgi?regress)

format(3) is rendered in Markdown as help regress. The text displayed is formatted as follows:

[help regress](https://www.stata.com/help.cgi?regress)

clipoff deselect copying to the clipboard

Examples

* Basic use: open help document

. hhelp pwcorr

. hhelp mata function

. hhelp sum

* Auxiliary use: provide web link

. hhelp twoway scatter, m

. hhelp import excel, w web

. hhelp xtreg, latex

. hhelp xtreg, tex

. hhelp xtreg, f(2)

. hhelp xtreg, f(3) clipoff

Stored results

You can view the stored results through return list (see return) after using hhelp:

. r(link) web links (URLs) to PDF help documents

. r(link_web) web links (URLs) to web versions of help documents

. r(link_m) markdown formatted web link text

. r(link_txt) command:URL formatted web link text

. r(link_l1) LaTeX raw formatted web link text

. r(link_l2) LaTeX custom-formatted web link text

. r(link_f1) first pre-formatted web link text

. r(link_f2) second pre-formatted web link text

. r(link_f3) third pre-formatted web link text

Author

Yujun,Lian* (连玉君)

. Lingnan College, Sun Yat-Sen University, China.

. E-mail: arlionn@163.com

. Blog: https://www.lianxh.cn.

Yongli,Chen (陈勇吏)

. Antai College of Economics and Management, Shanghai Jiao Tong University, China.

. E-mail: yongli_chan@163.com

Also see

Online: help, wwwhelp