Template talk:Documentation

This is the talk page for discussing improvements to the Documentation template.

Put new text under old text. Click here to start a new topic.
New to Wikipedia? Welcome! Learn to edit; get help.

Archives: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10: 3 months

Template:Documentation is permanently protected from editing because it is a heavily used or highly visible template. Substantial changes should first be proposed and discussed here on this page. If the proposal is uncontroversial or has been discussed and is supported by consensus, editors may use {{edit template-protected}} to notify an administrator or template editor to make the requested edit. Usually, any contributor may edit the template's documentation to add usage notes or categories.

Any contributor may edit the template's sandbox. Functionality of the template can be checked using test cases.

To help centralize discussions and keep related topics together, all talk pages of subtemplates, and Module talk:Documentation, redirect here

Text has been copied to or from this page; see the list below. The source pages now serve to provide attribution for the content in the destination pages and must not be deleted as long as the copies exist. For attribution and to access older versions of the copied text, please see the history links below.

Copied Template:Documentation (oldid, history) → incubator:Template:Wp/nod/Documentation (diff)
Copied Template:Documentation (oldid, history) → incubator:Template:Wp/nod/documentation (diff)
Copied Module:Documentation/config (oldid, history) → incubator:Module:Wp/nod/Documentation/config (diff)

Hiding templates in documentation

Is it possible to hide templates in the documentation, so that the user sees a ready-made template that will be specified in the documentation? For example: Template link from Kazakh Wiktionary. This has the template at the bottom, and I tried Help:Transclusion, but nothing worked. I tried <inlcudeonly> but there is a space that brings the text down. And other templates are attached to it.

The same problem: https://kk.wikipedia.org/wiki/Үлгі:Аралас_стильдегі_жауынгер Murat Karibay (talk) 17:23, 24 January 2025 (UTC)[reply]

Template documentation generally displays a sample ready-made template. See the documentation for Infobox person. Is that what you were looking for? — GhostInTheMachine ^{talk to me} 20:53, 24 January 2025 (UTC)[reply]

Actually no I wanted to hide the infobox or other templates from the documentation. For example, I specified a template with an example in the documentation, but at the end of the documentation is the template itself, I would like to hide it, but if you use <includeonly> then in articles appears a space that interferes. Example Murat Karibay (talk) 21:11, 28 January 2025 (UTC)[reply]

Murat Karibay, see Template:Human history for an example of not seeing the template below or above the documentation. Two notes:

On English Wikipedia, by convention, the code of the template goes first, then the documentation in a <noinclude>...</noinclude> block
It's important to have zero line breaks between <includeonly>...</includeonly> and <noinclude>...</noinclude>.

Here's the relevant bit of wikitext of Template:Human history for reference:

}}</includeonly><noinclude>
{{documentation|content=

The closing tag }} and </includeonly> are the last pieces of wikitext of the template itself. <noinclude> and {{documentation are the first lines of the documentation's wikitext. There is zero whitespace between the two. For more details, see Wikipedia:Template documentation § Put documentation in the template. —⁠andrybak (talk) 23:31, 28 January 2025 (UTC)[reply]

Thanks, that helped. But there are spaces down when viewing from a smartphone browser.

Murat Karibay (talk) 16:03, 30 January 2025 (UTC)[reply]

"T:DOC" listed at Redirects for discussion

The redirect T:DOC has been listed at redirects for discussion to determine whether its use and function meets the redirect guidelines. Readers of this page are welcome to comment on this redirect at Wikipedia:Redirects for discussion/Log/2025 February 13 § T:DOC until a consensus is reached. Utopes _{(talk / cont)} 13:14, 13 February 2025 (UTC)[reply]

Template-protected edit request on 10 March 2025

This edit request to Module:Documentation has been answered. Set the |answered= or |ans= parameter to no to reactivate your request.

On line 229, please change the function to this:

	function envFuncs.templateTitle()
		--[[
		-- The template (or module, etc.) title object.
		-- Messages:
		-- 'sandbox-subpage' --> 'sandbox'
		-- 'testcases-subpage' --> 'testcases'
		--]]
		local subjectSpace = env.subjectSpace
		local title = env.title
		local subpage = title.subpageText
		if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') or (subpage == message('doc-subpage') and mw.title.getCurrentTitle().namespace == env.docSpace) then
			return mw.title.makeTitle(subjectSpace, title.baseText)
		else
			return mw.title.makeTitle(subjectSpace, title.text)
		end
	end

This will make the doc environment behave correctly, giving the actual template name on the doc page rather than the name of the "doc" subpage. Aasim (話す（はなす）) 00:17, 10 March 2025 (UTC)[reply]

Completed. P.I. Ellsworth , ed. ^{put'er there} 03:39, 12 March 2025 (UTC)[reply]

Heading displays wrongly in mobile view

In mobile but not desktop view, there is no space between Documentation and the first link: for example I see

Documentation[view] [edit] [history] [purge]

instead of

Documentation [view] [edit] [history] [purge]

This is true both on the mobile webpage and in the Android app, but the desktop view is fine. Using |heading=Documentation  as a workaround produces the correct appearance on mobile, but the extra space is then visible in desktop view. Musiconeologist (talk) 12:35, 21 March 2025 (UTC)[reply]