Szablon:ORP/opis

To jest podstrona dokumentacji dla szablonu {{ORP}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji szablonu i inną zawartość niebędącą częścią oryginalnej strony.

Szablon służy do łatwiejszego linkowania do okrętów polskiej marynarki wojennej (ORP).

Zapisem {{ORP|Błyskawica}} zastępujemy dłuższy zapis [[ORP Błyskawica|ORP „Błyskawica”]]. W efekcie otrzymujemy: ORP „Błyskawica”.

Jeśli istnieje kilka okrętów o tej samej nazwie, dodajemy parametr: {{ORP|nazwa|rok}}. Przykładowo: {{ORP|Piorun|1940}} zastępuje zapis [ORP Piorun (1940)|ORP „Piorun”]] i w efekcie otrzymujemy: ORP „Piorun” (1940).

Kolejny parametr steruje sposobem wyświetlania linku:

{{ORP|nazwa|rok|2}}. Przykładowo: {{ORP|Piorun|1940|2}} da zapis „Piorun”
{{ORP|nazwa|rok|6}}. Przykładowo: {{ORP|Piorun|1940|6}} da zapis ORP „Piorun”

Uwaga 1. Proszę zwrócić uwagę na użyte cudzysłowy.
Uwaga 2. Wartości: 2 i 6 użyto dla zachowania kompatybilności z szablonami Szablon:HMS i Szablon:USS.
Uwaga 3. Jeśli chcemy otrzymać zapis „Błyskawica” (dot. okrętu o unikalnej nazwie; chcemy otrzymać samą nazwę, tj. bez ORP) wówczas stosujemy zapis {{ORP|Błyskawica||2}}.