Difference between revisions of "Template:BS-alt/doc"

From blackwiki
Jump to navigation Jump to search
imported>Eubulides
(Document the template.)
 
imported>Vanisaac
m (→‎top: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
  
This is a subsidiary template to {{tl|BS-overlap}}. This template takes a single argument, which is the name of a route-map component, and produces alt text for that component. Please see ''[[Wikipedia:Alternative text for images]]'' for more about alt text.
+
This is a subsidiary template to {{tl|BS-overlap}}. This template takes a single argument, which is the name of a route-map component, and produces [[alt attribute|alt text]] for that component. Please see ''[[Wikipedia:Alternative text for images]]'' for more about alt text.
  
To describe the icon "<code>File:BSicon <var>XXX</var>.svg</code>", add a line:
+
To describe the icon "<code>File:BSicon <var>ID</var>.svg</code>", add a line:
  
: <code>|<var>XXX</var>=<var>Description of the icon</var></code>
+
: <code>|<var>ID</var>=<var>Description of the icon</var></code>
  
to the template.
+
to the template. The <code><var>ID</var></code> is a pictogram ID; see ''[[Wikipedia:Route diagram template #Pictograms|Pictograms]]''. An example pictogram ID is <code>utSTRlg</code>, which identifies the image ''[[:File:BSicon utSTR+r.svg]]'' [[File:BSicon utSTR+r.svg|x20px|border|link=|alt=]]; this ID has the prefix "<code>ut</code>", the root "<code>STR</code>", and the suffix "<code>lg</code>". The corresponding entry in this template's source code is:
<includeonly>
+
 
 +
|utSTRlg=Urban tunnel from right
 +
 
 +
Directions in alt text are written from the driver's viewpoint. The driver faces down the page; in this example the tunnel comes from the driver's right and then goes straight ahead.
 +
 
 +
Entries in this template should be sorted first by core (using a standard en_US [[Locale (computer software)|locale]]), then by prefix, then by suffix.
 +
 
 +
<includeonly>{{Sandbox other||
 
[[Category:Rail routemap templates]]
 
[[Category:Rail routemap templates]]
</includeonly>
+
 
 +
[[mk:Шаблон:BS-alt]]
 +
[[zh:Template:BS-alt]]
 +
}}</includeonly>

Latest revision as of 00:26, 24 April 2020

This is a subsidiary template to {{BS-overlap}}. This template takes a single argument, which is the name of a route-map component, and produces alt text for that component. Please see Wikipedia:Alternative text for images for more about alt text.

To describe the icon "File:BSicon ID.svg", add a line:

|ID=Description of the icon

to the template. The ID is a pictogram ID; see Pictograms. An example pictogram ID is utSTRlg, which identifies the image File:BSicon utSTR+r.svg ; this ID has the prefix "ut", the root "STR", and the suffix "lg". The corresponding entry in this template's source code is:

|utSTRlg=Urban tunnel from right

Directions in alt text are written from the driver's viewpoint. The driver faces down the page; in this example the tunnel comes from the driver's right and then goes straight ahead.

Entries in this template should be sorted first by core (using a standard en_US locale), then by prefix, then by suffix.