Template talk:Documentation

Sandbox documentation

The documentation often includes calls to the template as a way to demonstrate the output. When testing a change to the template in the sandbox, the sandbox template includes the live documentation which then displays the sample output from the live template. It is possible to clone the documentation under the sandbox and alter the sandbox template to be explicit about including the sandbox version of the documentation. This however has the danger that when the sandbox template is published to live, the documentation fudge will not be undone and the live template will end up with documentation showing the sandbox template. Setting up a testcase sub-page is probably the "correct" way around all this, but is there another / simpler way? Could this template test for being in the sandbox and default to the sandbox version of the documentation? — GhostInTheMachine ^{talk to me} 19:50, 20 January 2025 (UTC)

You should almost never need a sandbox page of documentation. If the documentation changes between versions, just update it when you sync the templates. If you want to test changes to how the template looks, that is what /testcases is for. Gonnym (talk) 11:02, 21 January 2025 (UTC)

I assumed so. It is just that having a sandbox version of the documentation allowed for a simple "live" preview during editing — GhostInTheMachine ^{talk to me} 11:33, 21 January 2025 (UTC)

You can still do that with /testcases. At the bottom of a template in editing mode, you have "Preview page with this template", put the /testcases page there and you can view it with your changes without saving them. Gonnym (talk) 11:35, 21 January 2025 (UTC)

True, and I guess that setting up /testcases is probably simpler than creating /sandbox/doc. Kinder on the next editor too ... — GhostInTheMachine ^{talk to me} 11:39, 21 January 2025 (UTC)

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)

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)

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)

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

1. On English Wikipedia, by convention, the code of the template goes first, then the documentation in a <noinclude>...</noinclude> block
2. 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)

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

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

"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)

Template-protected edit request on 10 March 2025

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)

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

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)