URL parameters
We support several useful query parameter options on every Kuma wiki document URL, when fetched via HTTP GET or viewed in a browser. Multiple query parameters are separated by & instead of the initial ? (see macros example):
summary
- Directs Kuma to return only the page summary. If there is content on the page marked with the class "SEO summary", that content is returned. If there is no such content, the contents of a section entitled "Summary" are returned. Failing that, the contents of the first block are returned.
raw
- Instructs Kuma to return the raw content of the page, without any of the skin material, such as the headers, footers, and so forth. This does not execute templates or scripts, which is handy for building editors. For example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5?raw
macros
- Instructs Kuma to execute all the templates in the page. When combined with
?raw
, this offers fully-rendered MDN content without the site wrapper. Defaults to on without ?raw
(ie. during normal site views), defaults to off when ?raw
is present. For example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5?raw¯os
nomacros
- Instructs Kuma not to execute the KumaScript templates in the page. Since
?macros
defaults to "on" during a normal site view, this option turns it off. For example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5?nomacros
include
- Tells Kuma to strip out any blocks that have the class "noinclude" on them. This is useful to get the output as it would appear when included in another page, rather than as a standalone page. Often this will remove sample code and the like (although not always). For example: https://developer.mozilla.org/en-US/docs/XUL/Attribute/align?raw¯os&include
section=id
- Instructs Kuma to return the content from only the section with the specified anchor name. For example:
https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters?raw§ion=params and the more interesting https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters?raw¯os§ion=params
This parameter only works in tandem with raw
; this is technically a bug but unlikely to be an actual problem.
expand
-
Combined with the $children
view, it expands the JSON response with detailed information per subpage. It works like a combination of $children
and $json
on each subpage. This way, one can learn about the tags for a subpage. For example: https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5$children?expand