Template:Single namespace/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
VisualWikitext
meta>Varnent
No edit summary
m (13 revisions imported)
 
(10 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Substitution|not}}


This is the documentation for {{tl|shortcut}} and its sister templates.
== Usage ==
The ''[[WikiQueer:Shortcut|shortcut]]'' family of templates is put into context here, but they each have their own documentation pages, [[#See also|see below]].
This is a meta-template; it should only be used within other templates. It is used for [[Wikipedia:Namespace|namespace]] detection as a simplification of <code><nowiki>{{Foo other|Example|{{Incorrect namespace|foo}}}}</nowiki></code>.  If the template is transcluded in the Foo namespace, it will transclude "Example"; if not, it will transclude {{tl|Incorrect namespace}}. Note that {{tl|Incorrect namespace}} does not work in the template namespace.


A shortcut template is similar to the {{tl|anchor}} template, but it adds a visual ''box'' graphic to the rendered page, as well as providing an alternative name. Creating a redirect page is a requirement to fulfill the shortcut mechanism.
The first parameter is necessary. It defines which namespace is the correct namespace for the template.


=== Usage ===
The second parameter is optional. It allows something (usually a category) to be transcluded in the correct namespace.
The characteristics of the ''box'' graphic are determined by which of the family of shortcut templates are chosen. For example, the ''policy shortcut'' box has the word ''policy'' on it for use on policy pages. The graphic alignment of the box depends on the whether it's a ''shortcut'' or a ''shortcut-l'':
*{{tl|shortcut}} – right-aligned box
*{{tl|shortcut-l}} – left aligned box
*{{tl|policy shortcut}} – ''shortcut'' that also says "policy"
*{{tl|Ombox/Shortcut}} – ''shortcut'' that embeds into message boxes


This template is not normally used for articles in the main namespace, because the graphic produces an avoidable [[WQ:SELF|self-reference]].
== Examples ==


# Insert the shortcut template.
=== Correct namespace ===
# Create a redirect page with the {{tl|R from shortcut}} template suffixed to the redirect. Name the page after your shortcut name.  Include the namespace name in both the shortcut name and the redirect page name. For example, substitute your own shortcut name as the title of the page, and substitute the proper namespace, then add the following as the top-line on your redirect page:
<code><nowiki>{{Single namespace|Template|This text is only displayed in the Template namespace}}</nowiki></code>
#:<nowiki>#REDIRECT [[</nowiki>''Namespace'':''Title of page with''#''Optional very long section name'']] <nowiki>{{</nowiki><tt>R from shortcut</tt>}}
# Verify operation.  Note that shortcut templates should display in all capitals, but operate without all capitals.


; Notes
{{Single namespace|Template|This text is only displayed in the Template namespace}}
These templates are mainly used on user pages and talk pages in reference to the WikiQueer, Help, and Portal namespaces. These templates inform about the shortcuts available to the page they are on. For example, [[WQ:SHORT]] redirects to [[WikiQueer:Shortcut]] and therefore, WikiQueer:Shortcut renders a shortcut box listing WQ:SHORT.  It is a self-reference that is normally avoided in the main article namespace.


The point of these templates is not to list every single redirect for a page (indeed, that's what "[[Special:WhatLinksHere|What links here]]" is for). Instead, they should list only one or two common and easily-remembered redirects.
=== Incorrect namespace ===
<code><nowiki>{{Single namespace|Category|This text is only displayed in the Category namespace}}</nowiki></code>


The ''shortcut'' template can take up to five (5) shortcuts as parameters.  
<!--not using actual template because {{Incorrect namespace}} won't display in the Template namespace-->
{{Mbox | type = content | image = [[File:Stop hand orange.svg|50px]] | text = {{Error|The above template should only be transcluded in the ''Category'' namespace(s).}} }}


For policy pages, one can use the {{tl|policy shortcut}} template, which takes up to ten (10) shortcuts as parameters. Be careful not to use a ''policy template'' on a guideline or essay.
== Supporting templates  ==
{{flatlist|indent=0.5|class=nowraplinks|
* {{tl|Incorrect namespace}}
* {{tl|Book other}}
* {{tl|Category other}}
* {{tl|Draft other}}
* {{tl|File other}}
* {{tl|Help other}}
* {{tl|Main other}}
* {{tl|Module other}}
* {{tl|Portal other}}
* {{tl|Talk other}}
* {{tl|Template other}}
* {{tl|User other}}
* {{tl|Wikipedia other}}
}}


=== Examples ===
== See also ==
{| class="wikitable"
* [[Template:Category handler]]
! Code
* [[Template:Namespace detect]]
! Result
|-
| valign="top" | {{tlc|{{BASEPAGENAME}}|WQ:SHORT}}
| {{{{BASEPAGENAME}}|WQ:SHORT}}
|-
| valign="top" | {{tlc|{{BASEPAGENAME}}|WQ:V|WQ:VERIFY|WQ:SOURCE}}
| {{{{BASEPAGENAME}}|WQ:V|WQ:VERIFY|WQ:SOURCE}}
|}


=== Anchors ===
<includeonly>{{Sandbox other||
These templates automatically add [[HTML element#Anchor|anchors]]. If a shortcut box with the shortcut [[WQ:SHORT]] is placed on the page [[WikiQueer:Shortcut]], then the link [[WikiQueer:Shortcut#WQ:SHORT]] will take you to the position in the page where that shortcut box is placed.
<!-- Categories here; interwikis in Wikidata -->
[[Category:Template namespace templates]]


For instance, try this link: [[#WQ:SHORT]]
}}</includeonly>
 
Thus, if you make a shortcut for a section of a page, then you can use the anchor in the shortcut redirect itself. Like this:
 
:<code><nowiki>#REDIRECT [[Pagename#WQ:SHORT]] {{R from shortcut}}</nowiki></code>
 
=== Positioning ===
This template is usually placed below the section header or at the top of a page.
 
Before July 26, 2010, when the anchor was inside the box, this caused the section header to scroll above the page window. Fixes for this issue included:
* Placing the shortcut above the section header; a bit confusing when editing
* Creating the redirect to the section header, not the shortcut; this would break if the section header was renamed
* Placing an {{tl|anchor}} in the section header that duplicated the shortcut
 
These fixes are no longer needed, but do not break the current implementation.
 
=== See also ===
* [[WikiQueer:Shortcut]] – The how-to guide and guideline about how and when to create shortcuts and shortcut boxes. A must-read for anyone handling shortcuts.
* {{tl|Anchor}} – a way to overcome the otherwise permanent fact that section titles are the only way to link to a section
* {{tl|Ombox/Shortcut}} – for embedding into message boxes
* {{tl|Policy shortcut}} – for shortcuts to sections of policy pages
* {{tl|R from shortcut}} – for placement on the redirect page
* {{tl|Shortcut-l}} – for left aligned normal shortcuts
* {{tl|Template shortcut}} – used for shortcuts/redirects to a template page
 
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:WikiQueer header templates|{{PAGENAME}}]]
 
[
</includeonly>

Latest revision as of 23:05, 3 September 2020

Usage

This is a meta-template; it should only be used within other templates. It is used for namespace detection as a simplification of {{Foo other|Example|{{Incorrect namespace|foo}}}}. If the template is transcluded in the Foo namespace, it will transclude "Example"; if not, it will transclude {{Incorrect namespace}}. Note that {{Incorrect namespace}} does not work in the template namespace.

The first parameter is necessary. It defines which namespace is the correct namespace for the template.

The second parameter is optional. It allows something (usually a category) to be transcluded in the correct namespace.

Examples

Correct namespace

{{Single namespace|Template|This text is only displayed in the Template namespace}}

This text is only displayed in the Template namespace

Incorrect namespace

{{Single namespace|Category|This text is only displayed in the Category namespace}}

Supporting templates

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Single_namespace/doc&oldid=117892"