Diferencia entre revisiones de «Plantilla:Documentation»

Revisión actual - 18:04 26 dic 2022

Template documentation

Plantilla:Lua <translate> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate> <translate> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>

Usage

Customizing display

Overrides exist to customize the output in special cases: </translate>

{{documentation|heading=}} - <translate> change the text of the "documentation" heading.</translate> <translate> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>

Rationale

</translate> <translate> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories.</translate> <translate> It also reduces server resources by circumventing a technical limitation of templates (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>

@@ Línea 1: / Línea 1: @@
-{{documentation subpage}}
+<noinclude>
-This template is mostly for inclusion in the "References" section of article, giving detailed description of [[US patent]]: the inventor, title, and link to find full text in US patent office database.
+<languages/>
+</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
+{{documentation|content=
-== Usage ==
+{{Lua|Module:Documentation}}
+<translate><!--T:12--> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate>
+<translate><!--T:13--> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>
-<pre>
+<translate>
-{{US patent reference
+==Usage== <!--T:2-->
- | number =
- | y =
- | m =
- | d =
- | inventor =
- | title =
-}}</pre>
-* '''number''' (required) is a patent number, without leading "US" letters, but with leading "D" letter if patent number contains it, and is required.
+===Customizing display=== <!--T:3-->
-* '''y''', '''m''', '''d''' (optional) are the year, month and day of issuing (granting). Four digits are required for the year, and two for the month and day ''even if the first digit is zero''.
-* '''inventor''' (optional) is a name of inventor; it can be a wiki-link, of course.
-* '''title''' (optional) is the title of the patent.
-== Sample rendering ==
+<!--T:4-->
+Overrides exist to customize the output in special cases:
+</translate>
+* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate><!--T:5--> change the text of the "documentation" heading.</translate> <translate><!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>
-<pre>
+<translate>
-{{US patent reference
+==Rationale== <!--T:6-->
- | number = 5285709
+</translate>
- | y = 1994
+<translate><!--T:7--> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories.</translate>
- | m = 02
+<translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate>
- | d = 15
- | inventor = John D. Grant
+<translate>
- | title = Machine head for tuning a stringed instrument, especially a guitar or the like
+==See also== <!--T:9-->
-}}
+</translate>
-</pre>
+* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
+* {{tim|Documentation}}
+* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
-<blockquote>
-{{US patent reference
- | number = 5285709
- | y = 1994
- | m = 02
- | d = 15
- | inventor = John D. Grant
- | title = Machine head for tuning a stringed instrument, especially a guitar or the like
 }}
-</blockquote>
+[[Category:Formatting templates{{#translation:}}|Template documentation]]
+[[Category:Template documentation{{#translation:}}| ]]
-Preferably, after inclusion of this template in "references", one should give less formal and more reader-friendly explanation of what this patent is all about.
+</noinclude><includeonly>{{#if:{{{content|}}}|
+[[Category:Template documentation pages{{#translation:}}]]
-==COinS==
+}}</includeonly>
-{{UF-COinS}}
-== See also ==
-Other templates that may be applicable for other uses (i.e. in-line inclusion) include:
-* {{tl|Citation/patent}}
-* {{tl|Cite patent}}, creates links to US and other patents on the espacenet database
-* {{tl|Citeref patent}}, for an inline citations to a patent bibliography
-* {{tl|EPO Application}}, to include a link to the European Patent Application entry of a European patent application
-* {{tl|EPO Register}}, to include a link to the European Patent Register entry of a European patent or patent application
-* {{tl|Patent}}, a generic template for general use referring to world's patent offices
-* {{tl|Ref patent}}, similar to {{tl|US patent reference}}, but using espacenet with more details than {{tl|Cite patent}}
-* {{tl|US patent}}, to include a link to a US patent
-* {{tl|US patent application}}, to cite a US patent application as a reference in "references" section
-* {{tl|US patent reference}}, to cite a US patent as a reference in "references" section
-* {{tl|USPTO Application}}
-* {{tl|USPTO Patent}}
-<includeonly>
-[[Category:U.S. Government external link templates|{{PAGENAME}}]]
-[[Category:Law citation templates|{{PAGENAME}}]]
-[[Category:Patent law templates|{{PAGENAME}}]]
-[[Category:United States law templates|{{PAGENAME}}]]
-[[ja:Template:US patent reference]]
-[[ms:Templat:Rujukan paten AS]]
-[[zh:Template:US patent reference]]
-</includeonly>