以编程方式链接到特定的(非功能的)文档页面
Linking to a specific (non-function's) documentation page programmatically
作为为我的代码编写一些文档的一部分,我想包含一个可运行的命令,它会向用户显示我想到的一些来自 MATLAB 文档的特定文档页面。
当所需页面属于功能或工具时,这很容易做到,例如
doc cftool
或者如果可能有歧义,也可以指定 folder/package 名称:
doc curvefit\cftool
(注意:我对the documentation of doc
的理解是.
应该可以做到,但这似乎行不通。挖掘后在 doc.m
中我看到了使用 /
或 \
的技巧...)
但是,我正在尝试 link 到 "package-level" 文档页面,例如Evaluating Goodness of Fit 其 "help path" 为 curvefit/evaluating-goodness-of-fit
,但以下命令不起作用:
doc curvefit/evaluating-goodness-of-fit
问题:如何在 MATLAB 中以编程方式成功打开特定的、非(函数|
class)相关的文档页面?
P.S。
我宁愿避免硬编码 MATLAB 文件夹中帮助页面的 .html
路径。
在文档浏览器中打开相关页面,右键单击页面任意位置并选择 "Get Page Address"。这将打开一个对话框,其中包含本地文档页面的位置和在线网页的 URL。
你可以看到给定的本地命令是如何直接调用HTML文件来显示在嵌入式帮助浏览器中的。
所以从 MathWorks 获取队列并通过从您的程序中以编程方式调用它来做同样的事情:
>> web(fullfile(docroot, 'curvefit/evaluating-goodness-of-fit.html'))
作为为我的代码编写一些文档的一部分,我想包含一个可运行的命令,它会向用户显示我想到的一些来自 MATLAB 文档的特定文档页面。
当所需页面属于功能或工具时,这很容易做到,例如
doc cftool
或者如果可能有歧义,也可以指定 folder/package 名称:
doc curvefit\cftool
(注意:我对the documentation of doc
的理解是.
应该可以做到,但这似乎行不通。挖掘后在 doc.m
中我看到了使用 /
或 \
的技巧...)
但是,我正在尝试 link 到 "package-level" 文档页面,例如Evaluating Goodness of Fit 其 "help path" 为 curvefit/evaluating-goodness-of-fit
,但以下命令不起作用:
doc curvefit/evaluating-goodness-of-fit
问题:如何在 MATLAB 中以编程方式成功打开特定的、非(函数|
class)相关的文档页面?
P.S。
我宁愿避免硬编码 MATLAB 文件夹中帮助页面的 .html
路径。
在文档浏览器中打开相关页面,右键单击页面任意位置并选择 "Get Page Address"。这将打开一个对话框,其中包含本地文档页面的位置和在线网页的 URL。
你可以看到给定的本地命令是如何直接调用HTML文件来显示在嵌入式帮助浏览器中的。
所以从 MathWorks 获取队列并通过从您的程序中以编程方式调用它来做同样的事情:
>> web(fullfile(docroot, 'curvefit/evaluating-goodness-of-fit.html'))