View source for Template:Links to/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

{{tl|Links to}} lists all pages that link to a section,
and shows a snippet from each page, with the link highlighted.
It uses the linksto search parameter to find the pages,
and from that a regexp search to find the section's incoming links.
(Note that the input to {{tl|links to}} is a section,
while the input to the search parameter ''linksto'' 
is a [[wp:pgn|fullpagename]].)

== Purpose ==

Use {{tl|links to}} to help decide about changing or removing [[MOS:HEADINGS|section headings]], 
{{tl|anchor}}s, or "span id=" (HTML) tags.
* Manage anchors.  Assess and delete excess anchors. Move and replace anchors.
* Manage section headings. Delete section headings. Rename section headings.
This template lists all the wikilinks to a section
that are found in the wikitext as:
#<kbd>[<nowiki/>[ ''fullpagename''#''section'' ]]</kbd>
#<kbd>{<nowiki/>{ section link | ''section''}}</kbd>
#<kbd>{<nowiki/>{ slink|''section''}}</kbd>
These are all the usual-style wikilinks,
and the search links produced by this template are
definitive concerning the sections of most pages.<ref name=notfound>
There may exist ''additional'' wikilinks (internal links) to a given section.
These are not currently listed:
# [[H:L|Web links]] made with URL-style syntax. 
# wikilinks or {{tl|Section link}}'s placed on a page by a transclusion.
</ref>

While editing a section, you decide to rename its heading.
Or you want to restructure an article.
But [[MOS:HEADINGS|it might break a link]]. And you're not sure about adding {{tl|anchors}}.
* "'''[[Help:What links here|What links here]]'''" does not report links by ''section name''. 
* This template, {{tl|links to}}, reports sections but does not report ''redirects''. 
* "'''Show redirects only'''" ''does'' report redirects to sections names. (It's on the '''What links here''' page).
Using these three tools, the incoming wikilinks to a section can be known.<ref name=notfound/>

== Usage ==

{{notice|You must enter the name of the section as the parameter.  If you see <nowiki>{{{1}}}</nowiki>, that search has failed to inform you of any links to that section.}}

Work from the edit page {{mdash}} going from it and back to it {{mdash}} while finding all links and redirects.<ref>
It is safe to navigate away from an edit page,
for example to test a wikilink in the preview.
It is safe also to activate a search link, for the same reasons.
(To open a new tab or window instead, 
press {{key press|Ctrl}} or {{key press|Shift}} while following a link.)</ref> 
When entering  a <kbd>{<nowiki/>{links to{{!}}''section''}}</kbd>
copy any [[WP:ANCHOR|section name]] exactly as it appears in the wikitext:
* <code>== ''section heading'' ==</code> <kbd>{<nowiki/>{links to|''section heading''}}</kbd> or
* <code>{<nowiki/>{anchor | ''anchor'' }}</code>  <kbd>{<nowiki/>{links to|''anchor''}}</kbd> or
* {{tag|span|params=id="''span id''"}}  <kbd>{<nowiki/>{links to|''span id''}}</kbd> 
The spacing ''outside'' the name is not important, but
the markup and spacing ''inside'' the name is important.<ref>
The actual query, seen on the search results page,
for sections with space characters in them,
replaces every space with a <code>"[ _]"</code>.
This mirrors the behavior of the wikilinks.</ref>
The most common mistake is wrong capitalization.

Should you change or removed a section name, 
then for each incoming wikilink or redirect it had,
you must edit that page, even if it is a [[wp:user page|user page]].
Use an [[Help:edit summary|edit summary]] like "fixing changed section name".

=== Links ===

'''[[Help:Link#Report links to and from a page|Links]]'''.
Taken altogether, the search links generated by this template 
will list all wikilinks to a section ''name'' of a page ''name''.
* '''#Links'''{{middot}}Finds <code>#''section''</code> used in wikilinks (and URL-style links).
* '''&sect;Links'''{{middot}}Finds <code>{<nowiki/>{ [[Template:Section link|Section link]] | ''fullpagename'' | ''section'' }}</code>. (uncommon)
The results do not overlap and are guaranteed links to that section.

=== Redirects ===
'''[[wp:redirects|Redirects]]'''.
Use the "Tool" '''[[Help:What links here|What links here]]'''. (Its on every page and every edit page.)
Once there, immediately activate the "external tool" '''Show redirects only'''.
If your section name is shown, your redirects are reported.
Just find the wikilinks to them using '''What links here''', and you're done.
If your section is not shown in the report, no redirect at all links to your section.

These normally report zero results (or fewer than ten).

=== Basic ===

:{<nowiki/>{ [[Help:Searching#linksto:|links to]] | ''section'' }}

Links to creates a pink box with search links inside:
one to find wikilinks, one to find templates ({{tl|Section link}}).

# On an edit page enter a {<nowiki/>{links to}}.
# [[wp:preview|{{key press|Preview}}]] the edit. A pink box appears with search links inside.
# Visit each of them while learning how to proceed.<ref> 
To get an edit tag for each search result,
add this to your custom javaScript:
<pre>
$( function() {
	'use strict';
	if ( mw.config.get( 'wgCanonicalSpecialPageName' ) === 'Search' ) {
		$( '.mw-search-result-heading a' ).each( function() {
			$( this ).after( '<span class="searchedit">[<a href="' + $( this ).attr( 'href' ) + '?action=edit">edit</a>]</span>' );
		} );
	}
} );
</pre>
Until it is an official user preference, the code may be susceptible to malcontents.
</ref>
# Go back to your edit page.
# Visit the redirects report.
# Go back to your edit page and proceed.

=== Advanced ===

:{<nowiki/>{ [[Help:Searching#linksto:|links to]] | ''section'' | ''[[wp:pgn|fullpagename]]'' }}
:{<nowiki/>{ [[Help:Searching#linksto:|links to]] | ''section'' | ''[[wp:pgn|fullpagename]]'' | ''[[wp:namespace|namespace]]'' }}

Links to outputs a single line starting with the fullpagename, and followed by the search links.
This style is fit for collaboration or storage for [[wp:wikiprojects|wikiprojects]].

Just add the ''fullpagename'' of the page of interest in parameter two.
(The {<nowiki/>{FULLPAGENAME}}, before {{tl|DISPLAYTITLE}} or the like may have applied.)<ref name=ipad>
It's the canonical name, not the redirect.
It's ''the title line exactly'', but the title line should begin with a capital letter.
If there are any questionable aspects to the title's appearance, 
go to that page and render {<nowiki/>{FULLPAGENAME}} in a temporary preview.</ref>

To limit search results to a namespace instead of all namespaces, use parameter three.
This is necessary for a highly linked-to page like the Manual of Style (over a million links to it).
This is useful to try when a search takes around twenty seconds and returns with zero results.
(Search silently fails, with no indication of an HTML timeout.)

== Parameters ==
{{more|Help:Template#Parameters}}

Spacing does not matter ''around'' the input.

{<nowiki/>{ links to | '''1<sup>st</sup>''' | '''2<sup>nd</sup>''' | '''3<sup>rd</sup>''' }}

'''1<sup>st</sup>'''{{space|5}} ''[[WP:ANCHORS|Section]]''. Case sensitive.  Matches wikitext character-wise.

'''2<sup>nd</sup>'''{{space|5}} ''[[WP:pgn|Fullpagename]]''. Case sensitive. First letter capitalized.<ref name=ipad/>

'''3<sup>rd</sup>'''{{space|5}} ''[[wp:namespace|namespace]]''.  Defaults to all. <!--prefix-->Accepts [[wp:ns#Aliases|aliases]].

== Examples ==
<!-- 
1) The wikilink [[../|Go up]] below is
so that template links to finds this subpage search-links to it.
The examples only work from ../Template:Links to, see?
2) Also for the search-insourse regexp part, we need: #Usage#Examples.
(See the testcases for an alternative explanation of these two workings.)
--> 

{|class=wikitable
|-
|+ Inside an edit session of this section
!What you type
!What you get
!Description
|-
|style=white-space:nowrap|<nowiki>{{ links to | Examples }}</nowiki>
|{{ links to | Examples }}
<noinclude>This is /{{SUBPAGENAME}}. [[../|Go up]] to test this.</noinclude>
|Find all links to this section.
|-
|<nowiki>{{ links to | Usage }}</nowiki>
|{{ links to | Usage }}
<noinclude>This is /{{SUBPAGENAME}}. [[../|Go up]] to test this.</noinclude>
|Find all links to this page's Usage section.
|}

{| class=wikitable
! '''What you type:'''
! '''What you get:'''
|-
||<kbd>{<nowiki/>{ links to | Linux | Operating system }}</kbd>
|{{ links to | Linux | Operating system }}
|-
||<kbd>{<nowiki/>{ links to | Registers | Javanese language }}</kbd>
|{{links to | Registers | Javanese language }}
|-
||<kbd>{<nowiki/>{ links to | Different functions of "to be" | E-prime }}</kbd>
|{{links to | Different functions of "to be" | E-prime }}
|-
||<kbd>{<nowiki/>{ links to | Projects | Mediawiki | <mark>talk</mark> }}</kbd>
|{{ links to | Projects | Mediawiki | talk }}
|-
||<kbd>{<nowiki/>{ links to | Projects | Mediawiki | user talk }}</kbd>
|{{ links to | Projects | Mediawiki | user talk }}
|}

<poem>
Reordering. If you used ''natural'' instead of ''most-requested'' order, you can number them.
'''What you type:'''<s><kbd><nowiki>
{{ links to | Wikipedia:Manual of Style | Section headings  }}
{{ links to | WP | Wikipedia:Manual of Style | Section management }}</nowiki></kbd></s><kbd><nowiki>
{{ links to | 2= Wikipedia:Manual of Style | 1=Section headings }}
{{ links to | 3= WP | 2= Wikipedia:Manual of Style | 1= Section management }}</nowiki></kbd>
'''What you get:'''
{{ links to | 2=Wikipedia:Manual of Style | 1=Section headings  }}
{{ links to | 2=Wikipedia:Manual of Style | 1=Section management | 3= WP }}
</poem>

== See also ==

* [[Help:Linking#Link reports]]
* {{ti|linksearch}} the edit link shows the code
* [[mw:Help:Linksearch#Linksearch and sections]]
* {{phab|T121379}} about finding external links
* {{edit|template:links to|Self-documention of this template's code}}. Previous versions searched for external links to sections.

{{search templates}} <!-- Just a link to the category page, not an actual categorization -->

== Notes and references ==
{{reflist}}
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- Includeonly tags put content onto the page that transcludes this page.
This document page is only trancluded onto the template.
Putting a category here marks the template page.-->
[[Category:Search templates]] 
}}</includeonly>