Template:Documentation subpage/doc: Difference between revisions

Latest revision as of 16:49, 2 August 2024

This is the documentation page for Template:Documentation subpage.

When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

Marks a page as documentation subpage to a template. It should be applied to all /doc pages for templates.

All pages marked with this template are placed in the template documentation category.

The template documented should include the corresponding documentation template.

The template must be placed inside <noinclude></noinclude> tags to avoid transcluding categories into the template.

<noinclude>{{documentation subpage}}</noinclude>

This is the documentation page for Template:Documentation subpage.

When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

Optionally, the name of the page documented by the article can be specified.

<noinclude>{{documentation subpage|[[:Template:documentation subpage]]}}</noinclude>

This is the documentation page for Template:documentation subpage.

When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation subpage}}</noinclude>
 Marks a page as documentation subpage to a template. It should be applied to all /doc pages for templates.
+All pages marked with this template are placed in the [[:Category:template documentation|template documentation]] category.
 The template documented should include the corresponding [[:Template:documentation|documentation]] template.
-==Examples==
+==Usage==
-{{tlx|documentation subpage}}
+The template must be placed inside <code><nowiki><noinclude></noinclude></nowiki></code> tags to avoid transcluding categories into the template.
+<code><nowiki><noinclude></nowiki>{{tlx|documentation subpage}}<nowiki></noinclude></nowiki></code>
 {{documentation subpage|inhibit=yes}}
 Optionally, the name of the page documented by the article can be specified.
-{{tlx|documentation subpage|<nowiki>[[:Template:documentation subpage]]</nowiki>}}
+<code><nowiki><noinclude></nowiki>{{tlx|documentation subpage|<nowiki>[[:Template:documentation subpage]]</nowiki>}}<nowiki></noinclude></nowiki></code>
 {{documentation subpage|[[:Template:documentation subpage]]|inhibit=yes}}