Template:Deeplink needed/doc

This is a documentation subpage for Template:Deeplink needed.
It contains usage information, categories and other content that is not part of the original template page.

This template aids in the maintenance of inks and redlinks to the titles of sub-works, chapters, anchors and similar specific references, and should be used in the Page namespace to mark citations requiring deeper linking than currently available, though it can be used in any namespace but Main. The template will not be visible in Mainspace, though links and redlinks it is used on will be visible as normal.

This template can also be used if a citation is already linked to a seemingly specific target, but the target appears to be misplaced, thus 'needing a different deeplink' to match the author's stated citation.

Usage

Parameters

This template takes a single optional parameter, which should be the citation being tagged for deeper linking.

Linking guidelines

There is no official Wikisource policy at this time, but generally:

Titles of referenced works and chapters linked to the most specific available page in Mainspace, using anchors as appropriate.
Authors' names can be linked to Author pages.
Publishers may also be linked to Portal pages (individuals who worked as "publishers" but also were authors should link to an Author page, but otherwise a Portal with their name).

Any of these may be carefully redlinked, if and as appropriate, using a best guess as to how the target will be named when it is added according to naming guidelines.

With this template, please link directly to the most specific available cited page in the work. Be sure to verify that the citation is the correct target, keeping in mind possible differences in, for example, editions under the same title.

Work titles should only be linked to Mainspace, never to Page, Index, Author, Portal, etc. Links to these attached to titles of works can be useful within these other namespaces, but such links should not be transcluded into Mainspace.
Excepting the author's name and other similar details, link the entire referenced title, including chapter number/name and page name. Specifically, do not over-link by linking each individual element to each specific successive type of page (EG, don't link the title to the root page, then the volume number to a subpage, then yet another link for the pagenumber to a page reference).
(Example § Fully deeplinked.)
If the citation specifies a specific section of the work, and this section heading is present in the available text, edit the page of the cited work to place an {{anchor}} or {{anchor+}}, and link to this anchor at its transcluded location in Mainspace.
(Example § Partially deeplinked.)
If the citation specifies a page number, and this page number is available for linking, use a pagenumber reference to the appropriate page anchor.
(Example § Partially deeplinked.)
If the cited work exists in Mainspace but has no page number references due to lacking an associated scan, link as closely as possible, such as to the appropriate section or chapter.
(Example § Partially deeplinked.)
If the cited work does not even exist by a general title in Mainspace, meaning there is no available appropriate target for the citation, then consider adding a redlink to the general title. Follow naming guidelines and only add a redlink if the cited work is likely to fit within Wikisource inclusion criteria (don't redlink, for example, if the work is known or likely to be copyright restricted).
(Example § Redlinked.)
If a page already exists but it is a list of works, or by a different author, the wrong translation, the wrong edition or some other mismatch, see Help:Disambiguation. Basically:
- If it is a versions or translations page, and you are certain that the cited work is suitable for inclusion on that page, you can choose whether to link to it or redlink a disambiguated title.
- If it is a disambiguation page, listing unrelated works under the same title, or if it is itself an unrelated work, do not link to it; redlink to a disambiguated title.
- As with author and portal pages, consider listing the needed additional title on the mismatched page (see note below on missing works).
If you are linking a missing work, consider listing this work and the standard information on it to the respective author and publisher pages, if they exist. This will make it more apparent that this work is needed, both by prominent mention, and from Special:WhatLinksHere. Even better if on these author and publisher pages, you emphasize its potential using {{External scan link}} or, for works already uploaded to Commons, {{Small scan link}}.
If there is some non-obvious reason for using this template, consider adding a  to note these reasons to other editors. For example, if you've linked a work by the same title and author, but it appears to be the incorrect edition of that work.

Removal

Once the link for the citation is as specific as it can possibly be, requiring no further deeper linking, verify again that the target is the correct one for the citation, then remove this template.

Examples

Redlinked

Linksworth (1886). So Many Books, So Little Time: The Story of Wikisource, Chapter III: The Case of the Missing Chapter.
Linksworth (1886). So Many Books, So Little Time: The Story of Wikisource, Chapter III: The Case of the Missing Chapter.^{[deeplink needed]}
[[Author:Wiki Linksworth|Linksworth]] (1886). {{Deeplink needed|[[So many books, so little time|''So Many Books, So Little Time: The Story of Wikisource'', Chapter III: The Case of the Missing Chapter]].}}

Partially deeplinked

Linksworth's "Still not quite there," in The Journal of Transcriptionist Mental Health, Vol. IX, issue dated June 23, 1905.
Linksworth's "Still not quite there," in The Journal of Transcriptionist Mental Health, Vol. IX, issue dated June 23, 1905.^{[deeplink needed]}
[[Author:Wiki Linksworth|Linksworth]]'s {{Deeplink needed|[[Journal of Transcriptionist Mental Health/Volume 09|"Still not quite there," in ''The Journal of Transcriptionist Mental Health'', Vol. IX, issue dated June 23, 1905]].}}

Fully deeplinked

Craik. Hist. Brit. Com., ii, p. 29.
Craik. Hist. Brit. Com., ii, p. 29.
[[Author:George Lillie Craik|Craik]]. [[The History of British Commerce/Volume 2/Chapter 7#pagenumber_29|''Hist. Brit. Com.'', ii, p. 29]].

TODO: add example for citations referencing multiple chapters or pages.

Categorisation

This template adds pages to Category:Pages needing deeplinks.