Difference between revisions of "Template:Noprint/doc"
Shawndouglas (talk | contribs) (Created as needed.) |
Shawndouglas (talk | contribs) m (Created as needed.) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
=== Usage === | |||
This template excludes text from an article when it is rendered into a digital document such as a PDF or DjVu file, or printed, either through the "Printable version" or the "[[Help:Books|Create a book]]" links on the side bar. It is used to hide elements that make no sense in print such as "Click the name of a town on the map for more details". | |||
< | Where possible you can also use <code>class="noprint"</code> to any HTML block element, or <code>span class="noprint"</code> to an inline element, in order to hide that content from printing. This template is actually a shorthand for the latter option. | ||
< | |||
}}</includeonly> | *'''DO NOT''' use this on templates. Templates that need to be hidden from printing should be added to [[:Category:Exclude in print]] instead. | ||
*'''DO NOT''' use this on large sections that include headings (<nowiki>==This is a heading==</nowiki>). This will cause the edit link next to the heading to disappear. | |||
Keep in mind that one of the stated goals of the project is to allow for pages to be printed and used by travelers while they are traveling. This template should only be used in cases, such as the example above, where leaving content in would cause confusion. | |||
===Examples=== | |||
{| style="border:solid;border-width:1px;border-color:grey" | |||
|<code><nowiki>{{noprint|text to be hidden}}</nowiki></code> | |||
|} | |||
<br /> | |||
{| style="border:solid;border-width:1px;border-color:grey" | |||
|<code><nowiki>{{noprint|1=text to be hidden}}</nowiki></code> | |||
|} | |||
<br /> | |||
If the content that is being hidden contains an equals (=) sign, you will have to use <code>noprint|1=</code> instead of <code>noprint|</code>. Otherwise there is no difference between using and not using the 1= after the vertical line. | |||
=== See also === | |||
* {{tl|Unprintworthy-inline}} a.k.a. {{tl|Nomirror}} | |||
* {{tl|Hide in print}} | |||
* {{tl|Only in print}} | |||
<includeonly> | |||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | |||
[[Category:Collection documentation]] | |||
</includeonly> | |||
Revision as of 21:58, 23 January 2015
 |
This is a documentation subpage for Template:Noprint. It contains usage information, categories, interlanguage links, and other content that is not part of the original template page. |
Usage
This template excludes text from an article when it is rendered into a digital document such as a PDF or DjVu file, or printed, either through the "Printable version" or the "Create a book" links on the side bar. It is used to hide elements that make no sense in print such as "Click the name of a town on the map for more details".
Where possible you can also use class="noprint" to any HTML block element, or span class="noprint" to an inline element, in order to hide that content from printing. This template is actually a shorthand for the latter option.
- DO NOT use this on templates. Templates that need to be hidden from printing should be added to Category:Exclude in print instead.
- DO NOT use this on large sections that include headings (==This is a heading==). This will cause the edit link next to the heading to disappear.
Keep in mind that one of the stated goals of the project is to allow for pages to be printed and used by travelers while they are traveling. This template should only be used in cases, such as the example above, where leaving content in would cause confusion.
Examples
{{noprint|text to be hidden}}
|
{{noprint|1=text to be hidden}}
|
If the content that is being hidden contains an equals (=) sign, you will have to use noprint|1= instead of noprint|. Otherwise there is no difference between using and not using the 1= after the vertical line.
See also
- {{Unprintworthy-inline}} a.k.a. {{Nomirror}}
- {{Hide in print}}
- {{Only in print}}
