This page is semi-protected against editing.

Template:StringDiff

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Example of old text...
+
Example with new text!
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:StringDiff/doc.

Shows character changes in Wiki-Diff page style.

Usage

{{StringDiff |1= |2= }}

Not usable with wiki text indent like “:”. In these cases, use {{outdent}} first and then this template on a new line.

Template parameters

ParameterDescriptionDefaultStatus
1Old TextThe old textemptyrequired
2New TextThe new textemptyrequired
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Shows character changes in Wiki-Diff page style.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Old Text1

The old text

Stringrequired
New Text2

The new text

Stringrequired

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Example

{{StringDiff|Example of old text...|Example with new text!}}

renders as:

Example of old text...
+
Example with new text!

See also

Localization

This template is not intended to be localized.