Template:Page-multi/doc

This is a documentation subpage for

Template documentation

This box: view • talk • edit

Template:Terminate sentence ensures a sentence ends with a specified terminator (default: a period). It avoids adding duplicate terminators and can optionally trim trailing spaces. It attempts to ignore trailing closing quotes or brackets when deciding whether a terminator is already present.

Usage

Basic:

{{Terminate sentence|This is a sentence}}
→ This is a sentence.

Named parameters:

{{Terminate sentence
 |text=He said "Hello"
 |term=.
}}
→ He said "Hello".

Custom terminator:

{{Terminate sentence|text=Warning|term=!}}
→ Warning!

Avoid duplicate terminator:

{{Terminate sentence|text=Already done.|term=.}}
→ Already done.

Trim trailing spaces:

{{Terminate sentence|text=Ends with space   |trim=yes}}
→ Ends with space.

Skip processing:

{{Terminate sentence|text=No changes here|skip=yes}}
→ No changes here

Append a note:

{{Terminate sentence|text=Complete|note=(source: 2025)}}
→ Complete. (source: 2025)

Parameters

1 / text: The input text to terminate.
term: The terminator to enforce at the end. Default is .. Common choices: !, ?.
trim: If yes/true/1, strips trailing spaces before checking.
skip: If yes/true/1, returns text unchanged (still appends note if provided).
allowdup: If yes/true/1, allows duplicate terminators (e.g., ellipses). Default disallows duplicates.
note: Optional text appended after a space, unaffected by termination logic.

Behavior details

Terminator detection attempts to ignore trailing closing quotes/brackets (", ', ”, ), ], }).
If the last visible character equals term, no extra terminator is added unless allowdup=yes.
If trim=yes, trailing spaces are removed before detection.
If note is present, it is added with a leading space after the final text.

Examples

Quotes:

{{Terminate sentence|text=He whispered "hush"|term=.}}

 → He whispered "hush".

Parentheses:

{{Terminate sentence|text=Complete (verified)|term=.}}

 → Complete (verified).

Exclamation:

{{Terminate sentence|text=Alert|term=!}}

 → Alert!

Ellipsis (allow duplicates):

{{Terminate sentence|text=Wait...|term=.|allowdup=yes}}

 → Wait....

Best practices

Prefer using term that matches the sentence intent (., !, ?).
For complex punctuation, consider the Lua-powered variant below.
Document usage in your template’s /doc page where you incorporate this helper.

Lua-powered variant (optional)

For more robust detection (including multilingual quotes and punctuation), create Module:TerminateUtil with:

-- Module:TerminateUtil
local M = {}

local closing = {
  [")"] = true, ["]"] = true, ["}"] = true,
  ['"'] = true, ["'"] = true, ["”"] = true, ["’"] = true, ["»"] = true, ["›"] = true
}

local function trimRight(s)
  return (s:gsub("%s+$",""))
end

function M.lastVisibleChar(args)
  local s = args.s or ""
  s = trimRight(s)
  local i = #s
  while i > 0 do
    local c = s:sub(i,i)
    if closing[c] then
      i = i - 1
    else
      return c
    end
  end
  return ""
end

return M

Then update the template to call:

{{#invoke:TerminateUtil|lastVisibleChar|s=text}}

This improves detection for closing quotes and brackets.

Usage

Standalone usage

{{page-multi|code 1|code 2|code 3|...|page=pagename}}

Parameters

1, 2, 3, ... n: these parameters specify what links to display in the template. See the code table below for valid input codes.
page: the pagename. An error is returned if this is omitted.
separator: the separator to use in between links. Valid values are dot( · ), comma(, ), pipe( | ), and tpt-languages(⧼tpt-languages-separator⧽). If not specified, then dot is the default.
small: if this parameter exists, fonts will be displayed at 90% of the normal size.
sup: if this parameter exists, links will be displayed in superscript.
doc: this parameter is only available on template pages, using the /template sub-template. If set to yes, it will automatically generate documentation for that template.
date: if specified, the page view statistics will display for the 30 days prior to the given date (otherwise it's 60 days prior to the current date). The date string should either start with the format YYYY-MM-DD or YYYYMMDD (you can use {{subst:CURRENTTIMESTAMP}} to insert the current date).
demo: if this parameter is set to yes, the template will not output any categories.

Codes

Here is a list of currently supported link codes:

Code	Preview
t	talk
wlh	links
rc	related
edit	edit
h	history
w	watch
tl	logs
efl	abuse filter log
vlm-sgs	stats
pv	stats
h500	long history

Examples

Code	Output
`{{page-multi\|page=Example\|t\|wlh}}`	Example (talk · links)
`{{page-multi\|page=Example\|wlh\|vlm-sgs}}`	Example (links · stats)

Errors

In certain circumstances, the template will generate errors. This is a list of all the error messages that the template might generate, and how users can resolve them.

Not a valid link code

Page-multi error: "xyz" is not a valid link code.

This error is generated if an invalid link code is specified. For a list of valid link codes, see the code list above.

No link type specified

Page-multi error: no link type specified.

This error is only generated when using Module:PageLinks directly to create a single link. The link code must be in the first positional parameter, like this: {{#invoke:PageLinks|single||}}.

Function did not return a string value

Page-multi error: the function for code "xyz" did not return a string value.

This is an error in the software generating the links, and requires attention from the developers. Please start a new thread at Template talk:Page-multi.

Tracking categories

The template uses the following tracking categories:

Error category

Category:PageLinks transclusions with errors - this is used to track all the errors listed above

Adding new links

To add a new link, you need to edit the Lua module that this template is based on, Module:PageLinks. Instructions are in the source code, if you feel capable programming in Lua. If you're not familiar with Lua, feel free to make a request on Template talk:Page-multi, and someone might add the link for you.

Template:Page-multi/doc

Page version status

Template documentation

Usage

Parameters

Behavior details

Examples

Best practices

Lua-powered variant (optional)

See also

Usage

Parameters

Codes

Examples

Errors

Not a valid link code

No link type specified

Function did not return a string value

Tracking categories

Adding new links

See also