{smcl}
{* 17Nov2023}{...}
{cmd:help ihelp {stata "help ihelp_cn": 中文版}}{right: }
{hline}

{title:Title}

{p2colset 5 16 18 2}{...}
{p2col:{hi:ihelp} {hline 2}} Open the online HTML or PDF manual help document for specific command using the default browser{p_end}
{p2colreset}{...}


{title:Syntax}

{p 8 16 2}
{cmd:ihelp} {cmd:}{it:command_name} [{cmd:,}
{opt w:eb}
{opt m:arkdown}
{opt txt}
{opt ms}
{opt tex:full}
{opt l:atex}
{opt f:ormat}{cmd:(}#{cmd:)}
{opt c:lipoff}]

{synoptset 17 tabbed}{...}
{synopthdr}
{synoptline}
{synopt:{opt w:eb}}quickly open a simple HTML version, which by default open a detailed PDF document{p_end}

{col 5}{cmd:Format}{col 19}provide web link to online help document and automatically copy to the clipboard
{synopt:{opt m:arkdown}} in markdown format{p_end}
{synopt:{opt txt}}   in plain text format, which can be pasted into the dialog box of Facebook or WeChat for Chinese users.{p_end}
{synopt:{opt ms}}  copy rich text punctuated with links to clipboard, which can be pasted into MicroSoft documents.{p_end}
{synopt:{opt tex:full}}  in LaTeX full syntax format{p_end}
{synopt:{opt l:atex}}    in LaTeX compact format{p_end}
{synopt:{opt f:ormat(#)}} in preset formats, including three modes{p_end}
{synopt:{opt c:lipoff}}  do not copy the link to the clipboard{p_end}
{synoptline}
{p2colreset}{...}
{p 4 6 2}


{title:Description}

{pstd}
{cmd:ihelp} provides a quick and convenient way of opening online HTML or PDF version of {Stata}'s official help files. Since the built-in file opened with the official command {help help:help} can only be read through the Stata interface, which is not conducive to sharing and dissemination. {cmd:ihelp} fill this gap by allowing help files to be read and used independent of Stata. The only thing needed to be done is adding a {it:www} before the {cmd:help} to turn it into {cmd:ihelp}, then the documents that can be opened directly using {it:help cmd} command can also be opened online using {it: ihelp cmd}, including both detailed PDF versions and simple HTML versions. 

{pstd}
To enhance the convenience of citation, the {cmd:ihelp} command also incorporates various formatting options, including {it:markdown}, {it:txt}, {it:ms}, {it:latex}, {it:texfull}, and {it:format(#)}, enabling users to access web links to the online help files in their desired format, which will be automatically copied to the clipboard. Moreover, {cmd:ihelp} can also deal with the command abbreviation problems and list commands similar to the specified command when abbreviation can not be uniquely identified.

{pstd}
In brief, just add a {it:www} before {cmd:help}, and you are enjoying Stata's powerful and desirable help.


{title:Options}

{phang}{ul:Main Options}

{phang2}{opt web} quickly open a simple HTML version, which by default open a detailed PDF document

{phang}{ul:Formatting Options}：provide web links to online help documents, which can be put into specific format and automatically copied to the clipboard{p_end}

{phang2}{opt markdown} displaying the web link in Markdown format. For example, {ul:ihelp regress, markdown} displays the text in the following format:{p_end}

{pmore3} [**[R]** regress](https://www.stata.com/manuals/rregress.pdf) {p_end}

{phang3}It can be copied to a Markdown file and displayed as a clickable link: {browse `"https://www.stata.com/manuals/rregress.pdf"':[R] regress}{p_end}

{phang2}{opt txt} displaying the web link in text (command:URL) format. For example, {ul:ihelp regress, txt} displays the text in the following format:{p_end}

{pmore3}[R] regress: https://www.stata.com/manuals/rregress.pdf {p_end}

{phang3}It can be copied to the dialog box of Facebook or WeChat for Chinese users as 

{pmore3}[R] regress: {browse "https://www.stata.com/manuals/rregress.pdf":https://www.stata.com/manuals/rregress.pdf}{p_end}

{phang2}{opt ms} sends a rich text punctuated with links to the clipboard, which can be pasted easily to the MicroSoft Word. For example, {ul:ihelp regress, ms}, When pressing ’Command+V’ in the MicroSoft Word, the text will appear as a clickable
link.  {browse `"https://www.stata.com/manuals/rregress.pdf"':[R] regress}{p_end}

{phang3} 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 {opt txt} option, which displays a plain text with links. (command:URL) {p_end}

{phang2}{opt texfull} displaying the web link in full TeX text format. For example, {ul:ihelp regress, texfull} displays the text in the following format:{p_end}

{pmore3} \href{https://www.stata.com/manuals/rregress.pdf}{\bfseries{[\MakeUppercase{r}] regress}}  {p_end}

{phang3} 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: {browse `"https://www.stata.com/manuals/rregress.pdf"':[R] regress}{p_end}

{phang2}{opt latex} displaying the web link in Latex format. For example, {ul:ihelp regress, latex} displays the text in the following format:{p_end}

{pmore3}\stihelp[r]{regress} {p_end}

{phang3} 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: {browse `"https://www.stata.com/manuals/rregress.pdf"':[R] regress}{p_end}

{pmore3}Note: Since {it:\stihelp} is a new user-defined command, it needs to be defined by adding the following to the introductory section of the .tex document.{p_end}
{pmore3} \newcommand{\stihelp}[2][r]{  {p_end}
{pmore3}{space 4}	 \href{https://www.stata.com/manuals/#1#2.pdf}{\bfseries{[\MakeUppercase{#1}] #2}}  {p_end}
{pmore3} }  {p_end}

{phang2}{cmd:format(#)} displaying web links in three supporting Markdown preset formats.

{phang3}format(1) is rendered in Markdown as {browse `"https://www.stata.com/manuals/rregress.pdf"':[R] regress}. The text displayed is formatted as follows:{p_end}

{pmore3}[**[R]** regress](https://www.stata.com/manuals/rregress.pdf)

{phang3}format(2) is rendered in Markdown as {browse `"https://www.stata.com/manuals/rregress.pdf"':regress}. The text displayed is formatted as follows:{p_end}

{pmore3}[regress](https://www.stata.com/manuals/rregress.pdf)

{phang3}format(3) is rendered in Markdown as {browse `"https://www.stata.com/manuals/rregress.pdf"':help regress}. The text displayed is formatted as follows:{p_end}

{pmore3}[help regress](https://www.stata.com/manuals/rregress.pdf)

{phang2}{cmd:clipoff} deselect copying to the clipboard


{title:Examples}

{phang}* {ul:Basic use}: open help document

{phang2}{inp:.} {stata "ihelp pwcorr":ihelp pwcorr}{p_end}
{phang2}{inp:.} {stata "ihelp clip(), web":ihelp clip(), web}{p_end}
{phang2}{inp:.} {stata "ihelp mata function":ihelp mata function}{p_end}
{phang2}{inp:.} {stata "ihelp twoway scatter, web":ihelp twoway scatter, web}{p_end}
{phang2}{inp:.} {stata "ihelp sum":ihelp sum}{p_end}

{phang}* {ul:Auxiliary use}: provide web link

{phang2}{inp:.} {stata "ihelp twoway scatter, m":ihelp twoway scatter, m}{p_end}
{phang2}{inp:.} {stata "ihelp import excel, w web":ihelp import excel, w web}{p_end}
{phang2}{inp:.} {stata "ihelp xtreg, latex":ihelp xtreg, latex}{p_end}
{phang2}{inp:.} {stata "ihelp xtreg, tex":ihelp xtreg, tex}{p_end}
{phang2}{inp:.} {stata "ihelp xtreg, f(2)":ihelp xtreg, f(2)}{p_end}
{phang2}{inp:.} {stata "ihelp xtreg, f(3) clipoff":ihelp xtreg, f(3) clipoff}{p_end}


{title:Stored results}

{pstd}
You can view the stored results through {stata "return list": return list} (see {help return}) after using {cmd:ihelp}:

{synoptset 15 tabbed}{...}
{synopt:{cmd:. r(link)}}web links (URLs) to PDF help documents{p_end}
{synopt:{cmd:. r(link_web)}}web links (URLs) to web versions of help documents{p_end}
{synopt:{cmd:. r(link_m)}}markdown formatted web link text{p_end}
{synopt:{cmd:. r(link_txt)}}command:URL formatted web link text{p_end}
{synopt:{cmd:. r(link_l1)}}LaTeX raw formatted web link text{p_end}
{synopt:{cmd:. r(link_l2)}}LaTeX custom-formatted web link text{p_end}
{synopt:{cmd:. r(link_f1)}}first pre-formatted web link text{p_end}
{synopt:{cmd:. r(link_f2)}}second pre-formatted web link text{p_end}
{synopt:{cmd:. r(link_f3)}}third pre-formatted web link text{p_end}


{title:Author}

{pstd} {cmd:Yujun,Lian* (连玉君)}{p_end}
{pstd} . Lingnan College, Sun Yat-Sen University, China. {p_end}
{pstd} . E-mail: {browse "mailto:arlionn@163.com":arlionn@163.com} {p_end}
{pstd} . Blog: {browse "lianxh.cn":https://www.lianxh.cn}.{p_end}

{pstd} Yongli,Chen (陈勇吏) {p_end}
{pstd} . Antai College of Economics and Management, Shanghai Jiao Tong University, China.{p_end}
{pstd} . E-mail: {browse "mailto:yongli_chan@163.com":yongli_chan@163.com}{p_end}


{title:Citation}

{pstd} Chen Yongli, Yujun Lian. Browse and cite Stata manuals easily: the
wwwhelp command. {bf:The Stata Journal}, 2024, forthcoming, {browse "https://file-lianxh.oss-cn-shenzhen.aliyuncs.com/Refs/LianPub/Chen-Lian-2024-SJ-wwwhelp-ihelp.pdf":--PDF--}.


{title:Also see}

{pstd} Online: {helpb help}, {helpb wwwhelp} (same as {helpb ihelp}){p_end}