Wikipedia:Route diagram template/Transwiki guide

From Wikipedia, the free encyclopedia
Jump to: navigation, search

Route diagram template (RDT) project involves lots of templates to be functional, in order to allow the map in other Wiki which has not yet adopted this project to display correctly, you will need to copy the required templates carefully. If you have more questions regarding transwikiing this project, go to the home discussion page, Wikipedia talk:Route diagram template, and leave the message.


You do not need to upload any icons to your local Wiki because they are shared in Wikimedia Commons. However, if your Wiki project is not directly affiliated to Wikimedia Foundation such as Wikia, you do need to upload all the license-free icons to your local Wiki web space, or enable InstantCommons if possible. You can find all the icons of this project in Commons:category:BSicon and its subcategories, or check the catalog of pictograms for list of explanation of the icons. For starter, you will at least need   (KBHFa),   (BHF),   (STR) and   (KBHFe) to compose the most basic map.

Module and template[edit]

Since 2013, Lua module has been created to replace the original method of stacking BS row templates repeatedly to form the route map which not only improves the loading speed and resource usage, but also provides unlimited horizontal icon columns and overlapping layers. The Routemap module is being developed and tested in Russian Wikipedia. Ongoing updates are expected but the overall format of forming the basic route map is already stable, so Wikimedia projects have not yet adapted the RDT project are recommended to directly copy the module and transcluding template from Russian Wikipedia and make minor adjustments if needed. Notice that the namespaces of "Module" and "Template" in Russian are "Модуль" and "Шаблон" respectively. These should be changed to English or the language of your home project, otherwise the Russian namespaces are unrecognizable elsewhere.

The module itself will work perfectly without translating anything inside it (which are technically commented notes). The only real changes that should be made to the module is the width of the collapsible button which differ from language to language. These are at the lines ["row-collapsible-left-button-width"] and ["row-collapsible-right-button-width"]. Change the width values so they fit just the longest length of the show/hide and expand/collapse buttons.

The Russian transcluding template provides both English and Russian versions of named parameters. You may remove the Russian parameter names for the sake of loading speed (e.g. from {{{сворачиваемый|{{{collapsible|}}}}}} to {{{collapsible|}}}), or translate the Russian parameters names to the language of your Wikimedia project. Template document is still being translated to English at ru:Шаблон:Маршрутная карта/doc/en.

Transition from legacy BS template to Routemap module[edit]

Here shows the example of how the old and new methods will produce the similar route map:

Legacy Lua module result
|title=ABC Railway
{{BS|KBHFa||Terminus A}}
{{BS3|WASSERq|hWSTR|WASSERq|||Bridge B}}
{{BS3|BOOT|BHF|||Station C|ferry pier}}
{{BS3|BS2c2|BS2lr|BS2c3|||Junction D}}
{{BS2|KBHFe|STR||Terminus E}}
{{BS2||STR||Crash site|O2=INCIDO}}
{{BS2||KBHFe||Terminus F}}
|title=ABC Railway
KBHFa~~Terminus A
WASSERq\hWSTR\WASSERq~~ ~~ ~~Bridge B
BOOT\BHF\~~ ~~Station C~~ferry pier
BS2c2\BS2lr\BS2c3~~ ~~ ~~Junction D
KBHFe\STR~~Terminus E
\STR!~INCIDO~~Crash site
\KBHFe~~Terminus F
ABC Railway
Terminus A
Bridge B
Station Cferry pier
Junction D
Terminus E
Crash site
Terminus F

When translating big map from legacy format to Lua, it would be a huge time saver to use the "search and replace" Vector toolbar search-replace button.png function of enhanced edit toolbar (which requires enabling last 2 options of toolbar in Preferences-Editing-Editor) or copy the map codes to a text editor (e.g. firstobject XML editor) capable of text replacement to do the transition and then copy it back to the wiki editor. Note that because the icon IDs are case-sensitive, you MUST check "match case" before proceeding replacement.

But before making any replacement, you should search carefully if the map has used the overlapping function (the "highlight all" option of find in some browser will help tremendously). If all overlapping parameters are lined up right after the icons of base and lower layer in the correct order, you can instantly apply the replacement of |O1=, |O2=, etc. by !~. Otherwise you should reline the overlapping parameters and values manually before replacing so you do not need to guess or check back and forth for the correct order of superimposition after the change.

The other thing you should look carefully is the additional templates used inside the BS row template such as {{RoutemapRoute}} and {{Rail-interchange}}. The initial character following the vertical bar | in the template could conflict with the icon ID. For example, if you are going to replace |K by \K for   (KBHFa) and   (KRWl) but there is also {{rmr|licon=u|Kingsland}} in the map code, you may consider changing the replacing rule to more specific |KB by \KB and |KR by \KR to avoid changing {{rmr|licon=u|Kingsland}} to {{rmr|licon=u\Kingsland}} at the same time.

For templates like {{BSsplit}} and {{BSto}}, the first vertical bar after the template name should be replaced by {{!}} (e.g. replace {{BSsplit|A|B}} by {{BSsplit{{!}}A|B}}), otherwise the markups of the template will explode in the route map.

Legacy BS templates[edit]

See also[edit]

  • Meta:Help:Transwiki
  • Mediawiki:Version, if you are running your own Wiki for a long time, your Wiki software might be outdated. Some Wiki syntax or parser used by this project are not available in the older versions.