View source for Wikipedia:Route diagram template/Transwiki guide

'''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.
{{TOC limit|limit=2}}

==Icon==
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 [[mw:InstantCommons|InstantCommons]] if possible. You can find all the icons of this project in [[Commons:category:BSicon]] and its subcategories, or check the [[Wikipedia:Route diagram template/Catalog of pictograms|catalog of pictograms]] for list of explanation of the icons. For starter, you will at least need {{bsq|KBHFa}}, {{bsq|BHF}}, {{bsq|STR}} and {{bsq|KBHFe}} to compose the most basic map.

==Module and template==
Since 2013, [[Wikipedia:Lua|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 [[module:Routemap|Routemap module]] is being developed and tested. Ongoing updates are expected but the overall format of forming the basic route map is already stable, so Wikimedia projects have not yet adopted the RDT project are recommended to directly copy the [[module:Routemap|module]] and [[Template:Routemap|transcluding template]] and make minor adjustments  or localization if needed.

The module itself will work perfectly without translating anything inside it (which are technically [[Comment (computer programming)|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 <code style="color:#500">["row-collapsible-left-button-width"]</code> and <code style="color:#050">["row-collapsible-right-button-width"]</code>. Change the width values so they fit just the longest length of the show/hide and expand/collapse buttons. Also the name of the category which groups diagram with error or improper usage should be translated as well.

==Transition from legacy BS template to Routemap module==
Here shows the example of how the old and new methods will produce the similar route map:
{|class="wikitable"
!Legacy!!Lua module
|-
!colspan=2|Syntax
|-
|<pre><nowiki>{{BS-map
|title = ABC Railway
|collapsible = 0
|map =
{{BS|KBHFa||Terminus A}}
{{BS3|WASSERq|hKRZWae|WASSERq|||Bridge B}}
{{BS3|BOOT|BHF|||Station C|ferry pier}}
{{BS3|BS2c2|BS2lr|BS2c3|||Junction D}}
{{BS2|KBHFe|STR||Terminus E}}
{{BS2||STR|O2=INCIDO||Crash site}}
{{BS2||KBHFe||Terminus F}}
}}</nowiki></pre>
|<pre><nowiki>{{Routemap
|title = ABC Railway
|collapsible = 0
|map =
KBHFa~~Terminus A
WASSERq\hKRZWae\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
}}</nowiki></pre>
|-
!colspan=2|Result
|-
|
{| class="" style="width: auto; border: 0px !important; padding:0; box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12), 0 3px 1px -2px rgba(0, 0, 0, 0.2); border-spacing: 0px !important;font-size:90%;float:none;margin:auto;position:relative;background-color:#f9f9f9;" cellpadding=0 cellspacing=0
|-
! style="padding:5px; text-align:center; vertical-align:center; background-color:#27404E; color:white;" | <span style="font-size:110%; padding:0 5px;">ABC Railway</span>
|-
|-
|<div class="selfreference noprint" style="text-align:right; font-size:90%; padding-right:.5em">[[Template:Railway line legend|Legend]]</div>
|-
| style="text-align:center;" |
{|cellpadding="0" cellspacing="0" style="background-color:; line-height:1.2em; border:none; width:auto; text-align:left; margin:.5em; font-size:110%; white-space:nowrap;"
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_KBHFa.svg|x20px|alt=|class=noviewer]]</div>
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|Terminus A<div style="display:inline;font-size:90%;padding-left:3px"></div>
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_WASSERq.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_hKRZWae.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_WASSERq.svg|x20px|alt=|class=noviewer]]</div>
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|<div style="display:inline;font-size:90%;padding-left:3px">Bridge B</div>
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_BOOT.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_BHF.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; width:20px; min-width:20px;" |
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|Station C<div style="display:inline;font-size:90%;padding-left:3px">ferry pier</div>
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_BS2c2.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_BS2lr.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_BS2c3.svg|x20px|alt=|class=noviewer]]</div>
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|<div style="display:inline;font-size:90%;padding-left:3px">Junction D</div>
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_KBHFe.svg|x20px|alt=|class=noviewer]]</div>
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_STR.svg|x20px|alt=|class=noviewer]]</div>
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|Terminus E<div style="display:inline;font-size:90%;padding-left:3px"></div>
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; width:20px; min-width:20px;" |
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative; width: x20px; ">
<div style="position: absolute; left: 0px; top: 0px; padding: 0;">[[File:BSicon_INCIDO.svg|x20px|link=file:|class=noviewer|alt=|]]</div>[[File:BSicon_STR.svg|x20px|link=|alt=]]</div>
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|Crash site<div style="display:inline;font-size:90%;padding-left:3px"></div>
|-
| style="padding:0; background-color:; text-align:center !important; width:0px; border: 0px !important"|
{| cellspacing=0 cellpadding=0 style="background-color:transparent; float:none !important; margin:auto !important; width: auto !important; line-height: 0px !important; text-align:left; padding:0 !important;"
|-
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; width:20px; min-width:20px;" |
|class="bs-overlap" style="background-color:inherit; border:0; padding:0; " |<div style="position: relative;">[[File:BSicon_KBHFe.svg|x20px|alt=|class=noviewer]]</div>
|}
| style="text-align:right; vertical-align:middle; padding:0 0 0 3px !important; font-size:90%; border: 0px !important" | 
| colspan="2"  style="text-align:left; vertical-align:middle; padding:0 0 0 3px; white-space:nowrap; border: 0px !important;"|Terminus F<div style="display:inline;font-size:90%;padding-left:3px"></div>
|}
|-
|}
|{{Routemap
|title=ABC Railway
|float = center
|collapsible=0
|map=
KBHFa~~Terminus A
WASSERq\hKRZWae\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
}}
|}

When translating big map from legacy format to Lua, it would be a huge time saver to use the [[WP:SAFESUBST|safesubst]] function. This requires adding the safesubst commands in [[:Category:Route diagram templates|all original BS row templates]] like the English versions do. When it is done correctly, for example, change <code><nowiki>{{BS2|STR|BHF|0|1|2|3|O1=uSTRq}}</nowiki></code> in the map to <code><nowiki>{{safesubst:BS2|STR|BHF|0|1|2|3|O1=uSTRq}}</nowiki></code>, then save change, it will produce <code><nowiki>STR!~uSTRq\BHF~~0~~1~~2~~3</nowiki></code>.

If for whatever reason you cannot use safesubst in your home wiki, then use the "search and replace" [[File:Vector toolbar search-replace button.png|20px]] function of [[Help:Edit toolbar|enhanced edit toolbar]] (which requires enabling last 2 options of toolbar in [[Special:Preferences|Preferences]]-Editing-Editor) or copy the map codes to a text editor (e.g. [[Notepad++]]) 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 <code style="color:#500">|O1=</code>, <code style="color:#500">|O2=</code>, etc. by <code style="color:#050">!~</code>. 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 {{tl|RoutemapRoute}} and {{tl|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 <code style="color:#500">|K</code> by <code style="color:#050">\K</code> for {{bsq|KBHFa}} and {{bsq|KRWl}} but there is also <code style="color:#500"><nowiki>{{rmr|licon=u|Kingsland}}</nowiki></code> in the map code, you may consider changing the replacing rule to more specific <code style="color:#500">|KB</code> by <code style="color:#050">\KB</code> and <code style="color:#500">|KR</code> by <code style="color:#050">\KR</code> to avoid changing <code style="color:#500"><nowiki>{{rmr|licon=u|Kingsland}}</nowiki></code> to <code style="color:#500"><nowiki>{{rmr|licon=u\Kingsland}}</nowiki></code> at the same time.

==Legacy BS templates==
{|style="background: #fcc; width: 100%; border-radius: 5px; border: 1px solid #000;" class="collapsible"
! align=center style="font-size: 120%;" |The following content represents the legacy form of RDT. Editor is discouraged to use it unless there is a strong technical reason.
|-
|
===Template===
This project was originally created by German Wikipedians, but since its adoption to English Wikipedia, the project/templates continue to expand while the German Wikipedians prefer to keep the project as simple as possible. However, because the English Wikipedia counterpart has a backward compatibility with the German code (map code in German Wikipedia technically works fine in English Wikipedia without additional modification), it is highly recommended to apply the English Wikipedia version.

====Fundamental template====
* {{tl|Superimpose2}} & {{tl|Superimpose2/base}} for the 5-layer icon overlapping function.
* {{tl|BS-overlap}}
* {{tl|BSpx}}
* {{tl|BS-map}} & {{tl|BS-map/map}}, you may need to translate the text "legend" if your Wiki is not in English. Also you may add more parameter definition of your home language in the "#switch:" parser which is applied to decide which legend page to be linked to. The following 3 templates are often used together for 1 map. On June 5, 2011 they were replaced by BS-map for the sake of simplicity. However, these templates are already widely used even outside of English Wikipedia. If you know you will be copying most of the existing maps to your home Wiki and do not want to bother with replacing them by BS-map, you should adopt these templates as well but tell the other editors to stop using them:
* {{tl|Navbar}}, most Wikimedia projects already have this template adopted. If not, you may need to ask admin of your local Wiki to help because it requires editing common CSS page which is not open to normal user. If you do not want to bother with it, remove the transclusion of Navbar from BS-map and BS-header.
* {{tl|BS-alt}}
** BS-alt was created under the [[Wikipedia:alternative text for images]] guideline. However, the overwhelmingly large amount of the icons for this project proves this template too difficult to be maintained or translated. If you want to skip BS-alt by voiding the alt attribute of all icons in the BS row templates altogether, copy the {{tl|BS-overlap/noalt}} to your BS-overlap instead.

====Row template====
The number in these row templates indicates how many grid the template provides to display the icon horizontally. Theoretically it can be expanded endlessly, 8 icons per row is enough in most cases. Otherwise the map will spread too far and other method of rendering the map is recommended over this project. Create more row templates '''on demand''' or the admin may delete the unused.

* {{tl|BSrow}}, {{tl|BS}}, {{tl|BS2}}, {{tl|BS3}}, etc.
* {{tl|BSrow-sc}}, etc.
* {{tl|BSrow-2}}, {{tl|BS-2}}, {{tl|BS2-2}}, {{tl|BS3-2}}, etc.

The BSrow* templates are used to define the master format for its child templates. This is especially helpful for wiki of [[right-to-left]] writing system so editor only needs to modify the BSrow* template rather than the rest of the child row templates one by one.

A trial fix for the [[Help:Mobile access|mobile view]] has been applied to all 3 BSrow* master templates in April 2012. <span style="color:red;">However, on 17 April 2012 the mobile view has been presumably modified by the WMF and making the fix ineffective.</span>

====Legend====
The "legend" in BS-map or BS-table which links to any of these pages:
* {{tl|Railway line legend}} for generic railway map, the default legend.
* {{tl|Railway track legend}} for railway track and platform alignment diagram.
* {{tl|Bus route legend}} for any type of bus route map.
* {{tl|Waterways legend}} for waterway or canal map.
* {{tl|Trails legend}} for footpath map.

Although most legend pages use the <code>[[Wikipedia:Help namespace|template]]</code> [[WP:NAMESPACE|namespace]], you can apply other namespace like <code>[[Wikipedia:Project namespace|project]]</code>, <code>[[Wikipedia:Help namespace|help]]</code> or even [[Wikipedia:Main namespace|no namespace]] (for general article if it is your personal Wiki) if you see fit, just remember to revise the legend link in the BS-map and BS-table.

If you find some of the term difficult to be translated into your home language, you can ring the code of the row by <code style="color:red"><nowiki><!--</nowiki></code> and <code style="color:red"><nowiki>--></nowiki></code> to hide it temporary until other editor helps the translation.

====Optional template====
* {{tl|BSrow-replace}}, {{tl|BS3-replace}}, etc.: Replace the BS''n''-startCollapsible template with one of these templates in the map when the collapsed section expanded.
* {{tl|Stnlnk}}, {{tl|BScvt}}, {{tl|BSsplit}} & {{tl|BSto}}: tailored text templates to display the text properly in the text cell of BS row templates.
* {{tl|RoutemapRouteIcon}} & {{tl|RoutemapRoute}} for display of arrow icons [[File:Arrow_Blue_Left_001.svg|10px|border|alt=]] [[File:Arrow_Blue_Up_001.svg|10px|border|alt=]] [[File:Arrow_Blue_Right_001.svg|10px|border|alt=]] [[File:Arrow_Blue_Down_001.svg|10px|border|alt=]] in the text column.
* {{tl|BS-daten}}
* {{tl|Rdt intro}} for adding description in map template page, may require translation.
* {{tl|BSicon quote}} (bsq) for quoting the icon in the project, documentation or discussion pages.
* {{tl|Colorbox}} for adding a colored square before the map title for indicating the livery color of the subject. According to [[WP:COLOR]] guideline, this is better than coloring the text or background of text for the sake of accessibility.

===Major difference in other Wikimedia project===
This section compares the major differences of other Wikimedia projects with English Wikipedia.  If you have modified the RDT project in your home Wikimedia project, please kindly add or update the status in here.
{|class="wikitable" style="text-align:center"
|+Last update: 15 January 2012
!Features
![[German Wikipedia|DE]]
![[English Wikipedia|EN]]
![[French Wikipedia|FR]]
![[Hebrew Wikipedia|HE]]
![[Japanese Wikipedia|JA]]
![[Korean Wikipedia|KO]]
![[Latin Vicipaedia|LA]]
![[Portuguese Wikipedia|PT]]
![[Russian Wikipedia|RU]]
![[Serbo-Croatian Wikipedia|SH]]
![[Swedish Wikipedia|SV]]
![[Ukrainian Wikipedia|UK]]
![[Chinese Wikipedia|ZH]]
|-
|style="text-align:left"|{{tl|BS-map}}
|{{no}}
|{{yes}}
|{{partial}}
|{{no}}
|{{no}}
|{{partial}}
|{{no}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="text-align:left"|[[Template:BS|BS''n'']] row templates (basic)
|{{yes}}
|{{yes}}
|{{partial}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="text-align:left"|[[Template:BS-2|BS''n''-2]] row templates
|{{no}}
|{{yes}}
|{{no}}
|{{no}}
|{{yes}}
|{{partial}}
|{{partial}}
|{{yes}}
|{{yes}}
|{{no}}
|{{partial}}
|{{partial}}
|{{yes}}
|-
|style="text-align:left"|Icon overlapping (available layers){{ref|1|[1]}}
|{{no}}
|{{yes|5}}
|{{partial|4*}}
|{{yes|5}}
|{{partial|2*}}
|{{partial|1}}
|{{yes|5}}
|{{yes|5}}
|{{yes|5}}
|{{yes|5}}
|{{no}}
|{{partial|1}}
|{{yes|5}}
|-
|style="text-align:left"|[[Wikipedia:Picture tutorial#Links|Icon wikilink]]{{ref|1|[1]}}
|{{no}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{yes}}
|{{yes}}*
|{{yes}}
|{{no}}
|{{yes}}*
|{{yes}}
|}

{{note|1|1}} Parameters of all kinds of BS''n'' row templates.

====DE - German Wikipedia====
* To translate the map of [[:de:Vorlage:BSe]] to conventional BS''n'' row templates, add the letter '''e''' before every icon name in the row template.

====EN - English Wikipedia====
* {{tl|BS-map}} has been removed and ''only'' Lua-based maps (using {{tl|Routemap}}) are now supported.

====FR - French Wikipedia====
* BS''n'' row templates employ a different set of icon names which we strongly discourage. Because it makes it difficult to adopt the maps from French Wikipedia to other Wiki. Also it requires a separate template (Modèle:LCF_[French icon name]) for '''every''' icon individually before using the icon in the BS row template.
* If you want to use the original icon name in French Wikipedia, use the BS''n''bis row templates instead (known as "Modèles internationaux"/"international template").
* BS''n''bis templates support 4-layer icon overlapping while the basic BS''n'' row templates do not. You can overlap 2 icons ''over'' the base icon (O# and O#2) and two icons ''under'' the base icon (U# and U#2).

====JA - Japanese Wikipedia====
* Parameter name of second icon layer is '''P#''' instead of '''O#2'''.

====KO - Korean Wikipedia====
* [[:ko:틀:노선도]] is now adopted back to English Wikipedia as {{tl|BS-map}} and its functionality is further expanded.

====LA - Latin Vicipaedia====
These legacy templates are used because LA does not have Lua. Templates were adapted from Hungarian and Danish wikis to ensure correct rendering on mobile view.

====RU - Russian Wikipedia, UK - Ukrainian Wikipedia====
* The parameter name of [[Wikipedia:Picture tutorial#Links|icon wikilink]] in row templates is '''link#''' instead of '''L#'''.
|}

==See also==
* [[Meta:Help:Transwiki]]
* [http://www.mediawiki.org/wiki/Version 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.

{{bsicon}}

[[Category:Rail routemap templates]]