imported>AReaderOutThataway: documenting

2018-11-06T23:06:51Z

documenting

New page

{{Documentation subpage}}

{{Template shortcut|Xref-print|Crossref-print}}

This (probably best used by its shortcuts {{tlx|xref-print}} and {{tlx|crossref-print}}) is a convenience and "code mess reduction" template wrapper for {{tlx|crossreference|<nowiki>{{{1}}}</nowiki>|printworthy{{=}}yes}}.

== Usage ==
This accepts the following parameters:
* Unnamed first parameter, or named as {{para|text}} or {{para|content}} – The cross-reference text (required). While the explicit naming of this parameter with <code>1=</code>, <code>text=</code>, or <code>content=</code> is not required, it is always safest to use it this way, since any <code>=</code> character in the text will break the template if the parameter is unnamed.
* {{para|class}} or {{para|extraclasses}} any extra CSS classes to be added. This should not normally be used.

=== Intended uses ===
* This is primarily intended for use in disambiguation pages, set index articles, portals, and other "user-facing content but not really an article" places where an inter-page explicit Wikipedia self-reference should be printable because the page in question would not be useful if printed with these links suppressed as self-refs.
* It should be used for cross-references in regular articles that are to another section {{em|at the same page}}; we have no reason to suppress those.
* It can also be used in lists when the cross-reference is to a separate article but this topic also has an entry in the list at the same name as that external article (i.e., the cross-reference will still be useful if the material is being read offline).
* It can also be used in internal Wikipedia pages like guidelines, where we have no need to suppress self-refs (all guideline material and the like is one giant self-ref).

It's for things like the following, i.e. cases of "Wikipedia interrupting to directly address the reader" – but {{strong|only}} A) on pages where these instructive comments must be printable for the page to be useful because of the kind of page it is, or B) because the specific cross-reference is to more content in the same page:
* {{tlc|crossref-print|(See <nowiki>[[Early life of Foo of Baria]]</nowiki> for more detail.)}}
* {{tlc|crossref-print|This list does not include doodas or deedas, which are covered at <nowiki>[[Doodalidae]] and [[List of doodalids]]</nowiki>.}}
* <code><nowiki>* '''Baz Quuxians''': {{crossref-print|See [[#Quux Bazians|Quux Bazians]]}}</nowiki></code> – in any page, since this is a cross-reference to the same page.
* <code><nowiki>* '''Baz Quuxians''': {{crossref-print|See [[Quux Bazians]]}}</nowiki></code> – in a list that also has a [[WP:SUMMARY|summary-style]] entry by this name: <code><nowiki>* '''Quux Bazians''': ...</nowiki></code>

=== Do not use for ... ===
*General wikilinks (as in <code>She has been the CEO of <nowiki>[[XYZ124 Ltd]]</nowiki> since 2005</code>); those are always printable.
*Self-references in regular articles that point to other pages. Use {{tlx|Crossreference}} (AKA {{tlx|xref}}, {{tlx|crossref}}) for that – it's what that template was created for. Example: <code><nowiki>...after the end of the war. {{crossref|(See [[Aftermath of the Foo–Bar War of 1817]].)}}</nowiki></code>. Inter-article cross-references {{em|should}} be suppressed, because our article content is intended to stand alone as plain text if printed; any kind of "dependency" on some other page which cannot be accessed except when you're right here at Wikipedia is hidden from printed versions (and anything else that makes use of the printworthiness classes to "clean" the content for [[Wikipedia:Reusing Wikipedia content|reuse]]).

== Redirects ==
The following alternative names redirect to this template:
* {{tlx|xref-print}}
* {{tlx|crossref-print}}
* {{tlx|cross-ref print}}
* {{tlx|cross-reference printworthy}}

<includeonly>{{sandbox other||

[[Category:Cross-reference templates|{{PAGENAME}}]]
[[Category:Inline hatnote templates|{{PAGENAME}}]]
}}</includeonly>

Template:Crossreference printworthy/doc - Revision history

imported>AReaderOutThataway: documenting