Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove transclusion from meta documentation #15906

Merged
merged 2 commits into from
May 12, 2022
Merged

Remove transclusion from meta documentation #15906

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a24775
Remove transclusion from meta documentation
teoli2003 May 11, 2022
2973945
I forgot a bit!
teoli2003 May 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions files/en-us/mdn/structures/macros/other/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,39 +35,6 @@ We have macros specifically designed to create [quicklinks](/en-US/docs/MDN/Stru
- [`QuickLinksWithSubpages`](https://github.com/mdn/yari/blob/main/kumascript/macros/QuickLinksWithSubpages.ejs) creates a set of quicklinks comprised of the pages below the current page (or specified page, if one is given).
Up to two total levels of depth are generated.

### Transclusion

**Transclusion** is the embedding of part or all of one page into another.

> **Warning:** Do not use this feature/macro.
> We are in the process of removing it from MDN.

Exercise caution when using this macro, to ensure that the transcluded content makes sense in the context of the page it is embedded into.

[`page`](https://github.com/mdn/yari/blob/main/kumascript/macros/page.ejs) lets you embed some or all of a specific page into a document. It accepts five parameters:

1. The URI of the page to transclude. For example, "/en-US/docs/MDN/About".
2. The name of the section within the page to transclude. This can be specified either as the title string or as the ID of a block to copy over. If not specified, the entire article is transcluded. {{optional_inline}}
3. The revision number of the page version to transclude. This feature is not currently implemented, but would allow including text from specific versions of an article. {{unimplemented_inline}}
4. A Boolean value indicating whether or not to show the heading of the top-level section being transcluded. This is useful if you wish to specify your own heading. The default value is false, meaning the heading is not included by default. {{optional_inline}}
5. The heading level to use as the top heading level. This adjusts the outermost first-discovered level of the transcluded content to the specified number, and all other headings correspondingly. This lets you include content that has its own headings but adjust them to match the heading level at which you're including them. If you don't specify this value, the headings are not adjusted. {{unimplemented_inline}}

#### Example without heading

\\{{Page("/en-US/docs/MDN/About", "How you can help")}}

Result:

{{Page("/en-US/docs/MDN/About", "How you can help")}}

#### Example with heading

\\{{Page("/en-US/docs/MDN/About", "How you can help", 0, 1)}}

Result:

{{Page("/en-US/docs/MDN/About", "How you can help", 0, 1)}}

## Deprecated

These macros have been replace by other ways of doing the same thing, and should no longer be used. If you find them in existing articles, please replace them.
Expand Down