Scratchpad:Transwiki guide

A transwiki guide is a page aimed at providing information about transwikiing a complicated project or series of templates to a remote wiki. Such templates generally involve intricate features of template syntax and parser functions, and are split into multiple core or sub-templates. Unlike template documentation, which explains how to use the template for local wiki editors, a transwiki guide teaches the editor to localize it on another wiki. While it is possible to tell the reader to blindly copy all the templates under the same page name to their home wiki, a good transwiki guide should also describe which “external templates” are transcluded and essential for the end template to be functional.

Readers of a transwiki guide are expected to be non-native English speakers, so it is preferable to write the guide in simple and plain English. Since some parts of the template code may require translation to the transwikier’s home language, the guide should describe which parts can be renamed without ruining the template functionality and which parts should not.

Templates

 * : tag for a project or template that already has a transwiki guide page written, to notify remote wiki editors to use this page for transwikiing instructions.
 * : tag for encouraging an editor who is familiar with the codes of the project or template to write a transwiki guide.