help wwwhelp English version

标题

wwwhelp -- 在浏览器窗口显示帮助文档（HTML简易版或PDF详细版），并提供帮助文档的网页链接

语法

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

web 打开 HTML 简易版在线帮助文档，默认打开 PDF 详细版

格式 提供帮助文档的网页链接，并自动复制到剪切板
markdown 以 Markdown 格式提供网页链接

txt 以 纯文本 格式提供网页链接，可以复制到微信的对话框中

ms 以富文本格式提供网页链接，可以复制到 MicroSoft Word 中呈现为带链接的文本

texfull 以 LaTeX原始 格式提供网页链接

latex 以 LaTeX 格式提供网页链接

format(#) 以预设格式提供网页链接，包括三种预设格式

clipoff 取消复制到剪切板

简介

wwwhelp 用于打开 Stata 官方命令的在线帮助文件。官方命令 help 可以打开内置的帮助文档，但只能在 Stata 窗口阅读，不利于传播和分享。wwwhelp 填补了这一空白，使得帮助文件可以独立于 Stata 阅读和使用。

只需要在 help 之前添加一个 www，将其转换为 wwwhelp，所有使用 help cmd 命令可以直接打开内置帮助文件的官方命令，
也都可以使用 wwwhelp cmd 打开其在线版本，包括详细的 PDF 版本和简单的 HTML 版本。

为了方便引用，wwwhelp 命令还设置了一系列格式选项，包括 markdown、txt、ms、latex、texfull 和 format(#)。这些选项考虑了不同文本编辑器（比如 TeXLive、Markdown）的语法差异，
使得用户可以根据需要，获取特定格式的在线帮助文件链接，并自动复制到剪贴板。

此外，wwwhelp 还可以处理命令缩写问题，并在缩写无法唯一识别官方命令时，列出所有可能的相似命令。

选项

主要选项

web 快速打开 HTML 简易版在线帮助文档，默认打开 PDF 详细版

格式选项：提供帮助文档的网页链接，并自动复制到剪切板，支持多种呈现格式。

markdown 以 Markdown 形式显示网页链接，比如 wwwhelp regress, markdown 显示的文本格式如下：

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

将其复制到 Markdown 中会显示为可点击的链接：[R] regress

txt 以文本（命令:URL）形式显示网页链接，比如 wwwhelp regress, txt 显示的文本格式如下：

[R] regress: https://www.stata.com/manuals/rregress.pdf

可以将其复制到微信的对话框中

ms 以富文本形式将链接复制到剪切板，该链接可以粘贴到 MicroSoft Word 中，呈现为带链接的文本。比如 wwwhelp regress, ms 后，按 Ctrl+V 粘贴到 Word，将显示为：[R] regress

需要注意的是，该功能存在一些局限：（1）只能在 Windows 系统中使用；（2）只适用于 Stata 16 或更高版本；（3）需要安装 Python。若不满足上述条件，则会自动切换为 txt 选项，生成文本（命令:URL）形式的网页链接。

texfull 以完整的 TeX 文本形式显示网页链接，比如 wwwhelp regress, texfull 显示的文本格式如下：

\href//www.stata.com/manuals/rregress.pdf{\bfseries{[\MakeUppercase] regress}}

可以将其插入到 .tex 文档中，使用 TeX 编辑器编译后会显示为 PDF 文件中的可点击的链接：[R] regress

latex 以 Latex 形式显示网页链接，比如 wwwhelp regress, latex 显示的文本格式如下：

\stwwwhelp[r]

可以将其插入到 .tex 文档中，使用 TeX 编辑器编译后会显示为 PDF 文件中的可点击的链接：[R] regress

注意：由于 \stwwwhelp 是一个用户定义的新命令，需要在 .tex 文档的导言区中加入下述内容来定义该命令：

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

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

}

format(#) 以预设格式提供网页链接，支持三种 Markdown 的预设格式：

format(1) 在 Markdown 中呈现为 [R] regress，显示的文本格式如下：

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

format(2) 在 Markdown 中呈现为 regress，显示的文本格式如下：

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

format(3) 在 Markdown 中呈现为 help regress，显示的文本格式如下：

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

clipoff 取消复制到剪切板

举例

* 基本功能：打开帮助文档

. wwwhelp pwcorr

. wwwhelp clip(), web

. wwwhelp mata function

. wwwhelp twoway scatter, web

. wwwhelp sum

* 辅助功能：提供网页链接

. wwwhelp twoway scatter, m

. wwwhelp import excel, txt web

. wwwhelp xtreg, latex

. wwwhelp xtreg, tex

. wwwhelp xtreg, f(2)

. wwwhelp xtreg, f(3) clipoff

存储结果

可以通过 return list 查看 wwwhelp 后的存储结果 (参见 return):

. r(link) PDF帮助文档的网页链接（URL）

. r(link_web) 网页版帮助文档的网页链接（URL）

. r(link_m) Markdown格式的网页链接文本

. r(link_txt) 命令:URL 格式的网页链接文本

. r(link_l1) LaTeX原始形式的网页链接代码

. r(link_l2) LaTeX自定义形式的网页链接代码

. r(link_f1) 第一种预设格式的网页链接文本

. r(link_f2) 第二种预设格式的网页链接文本

. r(link_f3) 第三种预设格式的网页链接文本

作者

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

引用

Chen Yongli, Yujun Lian. Browse and cite Stata manuals easily: the
wwwhelp command. The Stata Journal, 2024, forthcoming, --PDF--.

Also see

Online: help, hhelp