Template:Official website/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

The purpose of this template is to provide a standard format for labeling links to official websites. The only required parameter is the URL. Three other parameters are also available:

name= is used to reformat the title if "official website" is not suitable.

NOTE: This name should succinctly and accurately describe the external link in relation to the subject. In particular, it should not include the article subject's name as the reader reasonably expects that all external links pertain to the subject.

mobile= is optionally used if there is a different "official website" for use with Mobile Web devices
format=flash is optionally used if the website requires Adobe Flash Player software

Some URLs that contain special characters, such as & or =, will break the template. The solution is to prepend the URL with 1=

Code	Result
`{{Official website\|example.org}}`	Official website
`{{Official website\|www.example.org}}`	Official website
`{{Official website\|http://www.example.org/}}`	Official website
`{{Official website\|https://www.example.org/}}`	Official website
`{{Official website\|1=http://www.example.org/?action=view}}`	Official website
`{{Official website\|http://www.example.org\|name=Example}}`	Example
`{{Official website\|example.org\|mobile=http://m.example.org}}`	Official website (Mobile)
`{{Official website\|example.org\|format=flash}}`	Lua error: expandTemplate: template "Link note" does not exist.

TemplateData

This is the TemplateData documentation for the template used by the new VisualEditor.

Official website

The purpose of this template is to provide a standard format for labeling links to official websites.

Template parameters
Parameter		Description	Type	Status
URL	`1`	The URL that the template will link to	String	required
URL Text	`name`	The text the URL will display. If not provided this will default to 'Official website''	String	optional
Mobile Website	`mobile`	If the website has a different 'official website' for mobile devices this website can be listed here	String	optional
Requires Flash	`format`	If the website requires Adobe Flash Player software to be displayed, set this parameters value to 'flash'	String	optional

Template:Official website/doc

Page version status

Template documentation

Usage

Parameters

Behavior details

Examples

Best practices

Lua-powered variant (optional)

See also

Usage

TemplateData

See also