URL parameters and document metadata

MDN的Kuma Wiki平台没有中央API. 相反,我们的通用方法是提供将人类可访问的资源转换为机器友好的数据的方法.

URL GET parameters

当通过HTTP GET获取或在浏览器中查看时,我们在每个Kuma Wiki文档URL上都支持几个有用的查询参数选项.

多个查询参数用代替,而不是初始的 . (请参见宏示例.)

summary

指示Kuma仅返回页面摘要. 如果页面上标有" SEO摘要"类的内容,则返回该内容. 如果没有这样的内容,则返回标题为"摘要"的部分的内容. 如果失败,则返回第一个块的内容.

错误通知:如果您未指定raw参数,则当前存在一个错误,该错误会导致summary参数返回整个文档. 请注意,您还可以使用$json替代视图从返回的JSON获取摘要.
raw
指示Kuma返回页面的原始内容,而没有任何皮肤材料,例如页眉,页脚等. 这不会执行模板或脚本,这对于构建编辑器很方便.
Example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5?raw
macros
指示Kuma执行页面中的所有模板. 当与?raw结合使用时,它将提供完全渲染的MDN内容,而无需站点包装. 默认为不带?raw打开(即在正常的网站浏览期间),默认为不带?raw关闭.
Example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5?raw&macros
nomacros
指示Kuma不要执行页面中的KumaScript模板. 由于?macros在普通站点视图中默认为" on",因此此选项将其关闭.
Example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5?nomacros
include
告诉Kuma删除所有包含noinclude类的块. 这对于获得输出结果很有用,因为它包含在另一个页面(而不是独立页面)中时会出现. 通常,这将删除示例代码等(尽管并非总是如此).
Example: https://developer.mozilla.org/en-US/docs/XUL/Attribute/align?raw&macros&include
section=id
指示Kuma仅从具有指定锚点名称的部分返回内容.
Example:
错误通知:如果您也未指定raw参数,则当前存在一个错误,该错误会导致section参数返回整个文档.
expand

结合$children视图,它扩展了JSON响应,每个子页面都有详细信息. 每个子页面上的工作方式类似于$children$json的组合. 这样,就可以了解子页面的标签.

Example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5$children?expand

Document metadata resources

除了用于调整文档URL响应的参数外,还存在一些由URL后缀指定的文档替代视图:

$toc
告诉Kuma仅返回HTML页面的目录. 它以有序列表(即<ol> )形式返回.
Example: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters$toc
$json
告诉Kuma在JSON对象中描述页面. 这个对象本质上与使用KumaScript例程wiki.getPage()会得到的对象相同.
Example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5$json
$children
告诉Kuma在JSON中列出页面的主题子级. 这个对象本质上与使用KumaScript例程pages.subpages()会得到的对象相同.
Example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5$children.
(可以与?expand参数一起使用,以获得更详细的响应.)
$compare
显示所需查询参数?from?to指定的修订版本之间的源文本行差异.
Example: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters$compare?to=911697&from=911067
$edit
编辑给定文档的当前修订,而不显示它.
Example: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters$edit
$history
显示给定文档的最新十个修订的修订历史,而不是其内容. 可以使用?limit=all查询参数值来请求完整的历史记录.
Example: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters$history?limit=all
$revision
显示必须在" / "分隔符之后指定的文档修订号.
Example: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters$revision/915141