Witamy w Podręczniku stylu OpenTTD. Ten dokument opisuje zasady dotyczące wszystkich angielskich tekstów w grze (zarówno brytyjskich, jak i amerykańskich). Podręcznik na początku powstał w celu poprawy jakości tekstu interfejsu użytkownika, aby ułatwić lokalizację w różnych językach. Ostatecznie przekształcił się w projekt pełnej dokumentacji, aby ujednolicić reguły tekstu pisanego w grze, naprawić niespójności i poprawić czytelność.

Podręcznik stylu OpenTTD jest wzorowany na Microsoft Writing Style Guide. Dodatkowe formatowanie unikalne dla OpenTTD pochodzi z preferencji społeczności lub zostało zaczerpnięte z tekstu już obecnego w oryginalnym interfejsie użytkownika.

Zakres

• Te reguły stsowane są tylko do tekstu wyświetlanego w grze, który jest zawarty w pakiecie podstawowym OpenTTD.
• Kod, obrazy lub inna osobna dokumentacja zawarta w pakiecie OpenTTD nie będzie zgodna z zasadami tego podręcznika. Jeśli chcesz nauczyć się formatować kod, zapoznaj się z przewodnikiem OpenTTD Styl Kodowania dostępnym na wiki.
• Tekst dodatków pobranych za pomocą narzędzia do pobierania zawartości w grze lub w dowolny inny sposób nie jest objęty tym przewodnikiem. Zaleca się jednak twórcom dodatków przestrzeganie tych zasad podczas tworzenia nowej zawartości, aby zachować spójność z oryginalnymi tekstami.
• Tekst należący do zewnętrznych plików readme wyświetlanych w narzędziu odczytu w grze również nie wchodzi w zakres tego przewodnika.

Skrócona instrukcja obsługi

To jest podsumowanie najważniejszych zasad, którego korektorzy mogą używać jako "ściągawki" podczas przeglądania tekstu. Przed rozpoczęciem zmiany koniecznie przeczytaj cały przewodnik stylu, aby usunąć jakichkolwiek wątpliwości.

• Język: używaj łatwych do zrozumienia terminów i krótkich zdań. Nie używaj żargonu ani slangu.
• Język: w miarę możliwości używaj terminów neutralnych pod względem płci.
• Wielkie litery: Domyślnie używaj wielkich liter jak w normalnym zdaniu.
• Wielkie litery: Używaj wielkich liter w nazwach pojazdów, zasobów, walut, lokalizacji, nazwach budynków, nazwach własnych, rangach, aplikacjach i skrótach klawiaturowych.
• Formatowanie: akapity składające się z więcej niż jednego zdania zawsze kończą się kropką lub innym znakiem końca zdania.
• Porady: zawsze zostawiaj odstęp akapitu między tytułem podpowiedzi a opisem i umieszczaj dwukropek na końcu tytułu. Jeśli podpowiedź ma tylko tytuł, nie umieszczaj interpunkcji na końcu.
• Porady: nigdy nie umieszczaj tytułu w poradzie odnoszącej się do przycisku z tekstem (sam tekst przycisku to tytuł).
• Porady: zawsze umieszczaj tytuł na przycisku z ikoną.

Styl języka

• Języka używany w OpenTTD ma być prosty i precyzyjny.
• Tekst w grze powinien, jeśli to możliwe, być podzielony na małe akapity i krótkie zdania, aby lepiej przekazywać informacje osobom o każdym poziomie znajomości języka angielskiego.
• OpenTTD to gra o sieciach transportowych, takich jak te z prawdziwego świata, więc słownictwo techniczne będzie obecne, ale nie należy go nadużywać.
• Żargon i slang w ogóle nie powinny być używane.
• Celem jest stworzenie treści tekstowej, której czytanie będzie proste i przyjemne, a która jednocześnie będzie w stanie łatwo przekazać złożone informacje wszystkim, każdemu, kto w grę zagra.

Bezstronna komunikacja

Ponieważ w OpenTTD gra wiele osób na całym świecie, używany język musi być możliwie jak najbardziej inkluzywny. Oto kluczowe wytyczne dotyczące komunikacji bez uprzedzeń.

• Unikaj zaimków płciowych, jak on lub ona.
• Jeśli chodzi o gracza, zawsze staraj się używać struktur zdań, które odnoszą się do graczy jako "you".

Poprawnie	You can host a game via the multiplayer screen.
Niepoprawnie	A user can host a game via the multiplayer screen.

• Używaj neutralnych pod względem płci alternatyw dla popularnych terminów. Kilka przykładów poniżej.

Użyj tego	Nie tego
chair	chairman
workforce, staff	manpower
operates	mans

• Unikaj odwoływania się do delikatnych tematów politycznych i wymieniania spornych lokalizacji geograficznych.
• Nie używaj slangu ani obyczajnego/wulgarnego języka.
• Określając graczy graczy niepełnosprawnych, unikaj języka, który może wyglądać protekcjonalnie "suffering from" lub "affected by".

Opisy i etykiety interfejsu

Interfejs OpenTTD jest wypełniony tekstem w dwóch głównych formatach, z własnymi unikalnymi regułami: opisowymi i etykietami interfejsu.

Opisy

Podpowiedzi są przykładem tekstów opisowych.

• Teksty używane do opisywania lub dostarczania szczegółowych informacji o określonej funkcji, sytuacji lub koncepcji gry.
• Przykładami opisów są podpowiedzi, wiadomości w gazetach, instrukcje lub kontekstowe wskazówki i zapytania w grze.
• Teksty opisowe wykorzystają jedno lub więcej pełnych zdań, które zaczynają się od wielkiej litery. Jeśli akapit składa się z więcej niż jednego zdania, zawsze kończą się kropką lub innym znakiem końca zdania.

'Etykiety interfejsu'

Niektóre przykłady etykiet interfejsu użytkownika: etykiety pól i przycisków.

• Etykiety interfejsu użytkownika to tekst służący do nazwania konkretnej funkcji lub pola.
• Najczęściej stosowany do nazewnictwa części interfejsu użytkownika, takich jak przyciski, ramki okien i pola tabeli.
• Etykiety interfejsu użytkownika zazwyczaj nie tworzą pełnych zdań i nigdy nie kończą się kropką. Czasami mogą kończyć się dwukropkiem, jeśli wprowadzają dynamiczne pole, takie jak liczba.
• Etykiet interfejsu użytkownika nie należy mylić z tytułami podpowiedzi; nawet jeśli wyglądają podobnie, gdy są używane samodzielnie, tytuły podpowiedzi są w praktyce tekstami opisowymi.

Skrótowce

Używanie skrótwców jest często popularnym wyborem ułatwiającym czytanie tekstu lub oszczędzającym miejsce w interfejsie użytkownika. Niektóre akronimy są szeroko rozumiane i czasami preferowane w stosunku do terminów, które reprezentują, ale inne mogą powodować zamieszanie u osób, które nie są z nimi zaznajomione. Używając akronimów, należy pamiętać o następujących wytycznych:

• Domyślnie pisz akronimy wielkimi literami.

Poprawnie	If you have any doubts check our FAQ.
Niepoprawnie	If you have any doubts check our Faq.

• W tekstach opisowych dobrze rozpoznawane akronimy (takie jak FAQ) można wprowadzać bez wyjaśniania.
• W razie wątpliwości, czy akronim jest powszechnie rozpoznawany, możesz sprawdzić Słownik Dziedzictwa Amerykańskiego , aby sprawdzić, czy znajduje się on na liście popularnych akronimów.
• Nie twórz nowych akronimów samodzielnie. Jeśli uważasz, że dany termin powinien zostać przekształcony w nowy akronim, najpierw skonsultuj się z innymi programistami.
• W tekstach opisowych, przy pierwszym użyciu wraz z akronimem w nawiasach, przeliteruj nieznane akronimy techniczne.

Poprawnie	The Dash is a diesel multiple unit (DMU) available from 1984.
Niepoprawnie	The Dash is a DMU available from 1984.

• Użyj pisowni małymi literami, chyba że jest to nazwa własna lub protokół.
• Jeśli akronim jest zapisany w kombinacji wielkich i małych liter ze względów stylowych (takich jak BaNaNaS), sprawdź, czy jest to najczęstszy sposób pisania akronimu, zanim to zrobisz.

Poprawnie	BaNaNaS is the content downloader for OpenTTD.
Niepoprawnie	BANANAS is the content downloader for OpenTTD.

• Nie stylizuj istniejących skrótów na własną rękę.
• W przypadku akronimów przyswojonych do języka angielskiego (takich jak laser), pisz je w całości małymi literami, ponieważ mają być traktowane jako rzeczowniki pospolite.

Wielkie litery

Zasady kapitalizacji określają użycie dużej litery w tekście pisanym. Pomagają poprawić sposób odczytywania tekstu i jego wyglądu.

Ogólne zasady wielkich liter

Przy pisaniu wielkimi literami postępuj zgodnie z tymi podstawowymi wytycznymi:

• Domyślnie używaj wielkich liter na początku, zarówno w tekstach opisowych, jak i elementach interfejsu użytkownika.
• Zawsze rozpoczynaj od wielkiej litery pierwsze słowo nowego zdania, frazy lub etykiety. Zdania, które zaczynają się od słowa którego pierwsza litera obowiązkowo jest mała (np. stylizowany akronim) przepisz tak, aby na początku nalazło się inne słowo.

Poprawnie	The eGRVTS is a newgrf vehicle set by Zephyris.
Niepoprawnie	eGRVTS is a newgrf vehicle set by Zephyris.

• Nie używaj wielkich liter do podkreślania słów. W razie potrzeby zmień brzmienie zdania.

Poprawnie	You can download OpenTTD on the link below.
Niepoprawnie	You can download OpenTTD HERE.

• Nie używaj wielkich liter wewnątrz wyrazu, chyba że jest to akronim, nazwa własna lub nazwa produktu.

Poprawnie	You can check our email address in the contacts section.
Niepoprawnie	You can check our eMail address in the contacts section.

• Nie używaj wielkich liter w akronimach, chyba że zawierają one właściwy rzeczownik.

Poprawnie	The electric multiple unit (EMU) is a type of train.
Niepoprawnie	The Electric Multiple Unit (EMU) is a type of train.

Style kapitalizacji

Istnieją dwa rodzaje wielkich liter używanych w tekstach interfejsu dla OpenTTD: kapitalizacja zdań i tytułów.

Kapitalizacja zdań

• Zawsze stosuj ją do pierwszego słowa bez względu na to, czy jest to fraza, zdanie, nagłówek czy etykieta.
• Zawsze stosuj do odpowiednich rzeczowników.
• Zawsze stosuj do pierwszego słowa tytułów.
• Wszystkie pozostałe słowa powinny być napisane małymi literami, z wyjątkiem przypadków objętych szczególnymi regułami stosowania wielkich liter.

Przykład(szybkie zapytanie)

Are you sure you want to exit OpenTTD and return to Unix?

• Ogólnych tekstach opisowych

Przykład (narzędzie)

Start playing on a new map.

• Ogólnych tekstach etykiet interfejsu.

Przykład (przycisk)

New game

• Nagłówkach

Przykład

Section 1 - How to play

• Podpowiedziach

Przykład

Build railway station: For loading and unloading cargo or passengers.

• Tytułach okien

Przykład

Operating profits graph

Kapitalizacja tytułów

• Zawsze używaj wielkich liter dla pierwszych słów frazy lub zdania, nagłówka, lub etykiety.
• Nie używaj wielkich liter dla, przyimków lub spójników, chyba że są to pierwsze lub ostatnie słowa frazy lub zdania.
• Wszystkie inne słowa w zdaniu, frazie, nagłówku lub etykiecie należy pisać wielkimi literami (Capitalize), w tym czasowniki, rzeczowniki, przysłówki, przymiotniki i zaimki.
• Jeśli słowa łączą się myślnikiem, używaj ich tak, jakby były oddzielone zwykłą spacją.

Przykład (tytuł)

OpenTTD Scenario Editor

• Nazwach zasobów i typach energii zasilania kiedy używane jako elementy na liście.

Przykład 1	Station accepts: Coal, Iron Ore, Goods
Przykład 2	Engine type: Diesel

• Nazwach produktu/pojazdu.

Przykład

Kirby Paul Tank

• Nazwach państw/narodowości/walut.

Przykład

Yen, Dollar, Euro

• Nazwach geograficznych i nazwach struktur.

Przykład

Wartington Coal Mine

• Nazw aplikacji

Przykład

Jazz Jukebox

• Nazw firm

Przykład

Burnley & Smiths Inc.

• Nazw własnych i rang

Przykład

Chief Executive Officer

• Skrótów klawiszowych

Przykład

Ctrl+Click+Drag to select an area

Formatowanie

Teksty opisowe

Ogólne opisowe formatowanie tekstu

• Domyślnie używaj wielkich liter w zdaniu.
• Użyj wyrównania do środka w podpowiedziach, wiadomościach, wiadomościach i oknach informacyjnych.
• Użyj wyrównania do lewej we wszystkim innym.

Nagłówki

Nagłówki służą do nazywania dokumentów i dzielenia ich na sekcje. Są formą wewnętrznej organizacji w tekście pisanym. Podczas formatowania nagłówków postępuj zgodnie z tymi wskazówkami:

• Użyj kapitalizacji zdań.
• Nigdy nie kończ nagłówków kropką lub inną interpunkcją, chyba że jest to wykrzyknik lub znak zapytania użyty do podkreślenia.

Poprawnie	1 - What's new
Poprawnie	1 - What's new?
Niepoprawnie	1 - What's new.

Nazwy klawiszy, skróty klawiszowe

Są to złożone terminy, które wskazują kombinację klawiszy i akcji myszy używanych do wykonywania funkcji gry bez użycia przycisków interfejsu. Podczas pisania nazw klawiszy postępuj zgodnie z tymi zasadami:

• Użyj kapitalizacji tytułu.
• Jeśli skrót wymaga wykonania więcej niż jednej akcji, rozdziel je za pomocą znaku plus (+) zamiast spacji.

Poprawnie	Ctrl+Click+Drag selects the area diagonally.
Niepoprawnie	Ctrl, Click and Drag selects the area diagonally.

Tytuły

Tytuły odnoszą się do nazw poszczególnych dzieł (książek, piosenek, aplikacji, artykułów itp.). Podczas formatowania tytułów pojawiających się w grze postępuj zgodnie z tymi wskazówkami:

• Aplikacje - użyj kapitalizacji tytułu.

Przykład 1	Jazz Jukebox
Przykład 2	OpenTTD Scenario Editor

• Książki lub dokumenty - użyj kapitalizacji tytułu.

Przykład

OpenTTD Manual of Style

• Odniesienia do rozdziałów lub sekcji - jeśli nazwa rozdziału jest przywoływana w tekstach opisowych, umieść nazwę rozdziału w cudzysłowie i użyć kapitalizacji tytułu, jakby to było nowe zdanie.

Przykład

For more information see section 9 "How to play".

• Tytuły utworów muzycznych - użyj kapitalizacji tytułu.

Przykład

Playing song 1 - Taxi Ride

Porady

Elementy porady:
Zielony - tytuł;
czerwony - opis;
niebieski - dodatkowe skróty.

Podpowiedzi to teksty wyświetlane w małych wyskakujących oknach, które pojawiają się po najechaniu kursorem myszy na niektóre funkcje interfejsu użytkownika. Są większą częścią tekstów opisowych OpenTTD. Podpowiedzi mogą składać się z co najmniej jednej z trzech możliwych części:

• Tytuł - nazwa funkcji lub narzędzia
• Opis - krótkie wyjaśnienie funkcji lub narzędzia
• Dodatkowe skróty - tekst informujący o dodatkowych funkcjach odblokowanych przez kombinacje klawiszy

Do podpowiedzi stosowane są następujące ogólne reguły formatowania:

• Niezależnie od zawartości, tekst podpowiedzi zawsze będzie następował w tej kolejności - tytuł, opis, dodatkowe skróty.
• Tytuł zawsze będzie oddzielony dwukropkiem i podziałem akapitu, jeśli nastąpi opis lub dodatkowe skróty.
• Nie wstawiaj żadnych innych podziałów akapitów oprócz tego, który dzieli tytuł.
• Etykietka bez tytułu musi zawierać opis. Nigdy nie może zawierać dodatkowych skrótów.

Podpowiedzi do przycisków z ikonami

Jeśli podpowiedź jest powiązana z przyciskiem ikony, obowiązują następujące zasady:

• Etykietki przycisków ikon muszą zawsze mieć tytuł.

Etykietki przycisków ikon zawsze wymagają tytułu w pierwszym wierszu.

Podpowiedzi do przycisków tekstowych

Jeśli podpowiedź jest powiązana z przyciskiem tekstowym, obowiązują następujące zasady:

• Etykietki przycisków tekstowych nigdy nie mogą mieć tytułu, ponieważ jest już napisany na samym przycisku.
• Etykietki przycisków tekstowych muszą zawsze mieć opis.

Etykietka przycisku tekstowego. Etykieta przycisku działa jak tytuł.

Podpowiedzi do tabeli

Jeśli podpowiedź jest powiązana z tabelą, obowiązują następujące zasady:

• Jeśli tabela ma tytuł, powiązana etykieta nie może mieć tytułu. Jeśli okno zawiera tylko jedną tabelę, tytuł okna jest także tytułem tabeli.
• Jeśli tabela nie ma tytułu, powiązana etykieta musi zawsze mieć tytuł.

Jeśli tabela ma tytuł lub nie dzieli okna z innymi tabelami, podpowiedź wymaga tylko opisu.

Etykiety IU (interfejsu użytkownika)

Ogólne formatowanie etykiet IU

• Użyj środkowego wyrównania w normalnych przyciskach i tytułach okien.
• Użyj wyrównania do lewej dla przycisków, które generują menu rozwijane.
• Użyj wyrównania do lewej dla wszystkich innych etykiet interfejsu użytkownika.

Liczby

Ogólne zasady formatowania liczb

Podczas pisania liczb postępuj zgodnie z tymi podstawowymi wytycznymi:

• W tekstach opisowych nigdy nie zaczynaj zdania cyfrą. W razie konieczności sformułuj je inaczej.

Poprawnie	One bus is all that is necessary to start a simple passenger route between two stops.
Niepoprawnie	1 bus is all that is necessary to start a simple passenger route between two stops.

• Domyślnie wpisuj liczby od jednego do dziewięciu słownie, chyba że liczba jest częścią nazwy własne (na przykład nazwy firmy).

Poprawnie	Places a section of rail in one direction.
Poprawnie	View finances for 4-Rail Inc.
Niepoprawnie	Places a section of rail in 1 direction.

• Gdy tekst opisowy odnosi się do wielu powiązanych ze sobą liczb, zawsze używaj cyfr, nawet jeśli liczby są mniejsze niż dziesięć.

Poprawnie	There are 15 trains, followed by 5 trains, followed by 1 train.
Niepoprawnie	There are 15 trains, followed by five trains, followed by one train.

Cyfry

Używaj cyfr (nie zapisu słownego) w następujących przypadkach:

• Jednostki miary, wymiary i wzory matematyczne

Przykład

Max. speed: 100 km/h

• Odniesienia do klawiszy lub ilości/kwot w grze

Przykład 1	5 units of coal
Przykład 2	Press key 4

• Procenty

Przykład

It takes 5% of the total value

• Sekcje numerowane, takie jak strony i rozdziały

Przykład

Page 5, Chapter 1

Liczebniki porządkowe

• Domyślnie zawsze zapisz słownie liczby porządkowe (kolejność)

Poprawnie	If this is the first time playing OpenTTD, check out the manual.
Niepoprawnie	If this is the 1st time playing OpenTTD, check out the manual.

• Nigdy nie zapisuj słownie liczebników w datach

Poprawnie	3rd Mar 1982
Poprawnie	The 20th century
Niepoprawnie	The twentieth century

Pisanie

Ogólne wskazówki dotyczące pisania

• Używaj prostych terminów i wybieraj proste i krótkie zdania.
• Bądź dokładny i precyzyjny. Wybierz słowa, które są łatwe do zrozumienia i opisz dokładnie to, czego potrzebujesz.

Stosuj	Places a railway bridge over land or water.
Unikaj	Constructs a railway bridge over land or water.

• Nie używaj złożonego żargonu.
• Nie używaj języka slangu ani wulgaryzmów.

Podpowiedzi

• W opisie opisu unikaj wyrażeń wskazujących na aktywację samego narzędzia, chyba że jest to absolutnie konieczne lub odnosi się do skrótów klawiszowych.

Stosuj	Demolish: Clears all objects in a selected area. Ctrl+Click+Drag selects the area diagonally.
Unikaj	Demolish: Use this tool to clear all objects in an area. Ctrl+Click+Drag selects the area diagonally.

• W opisie podpowiedzi nie powtarzaj informacji, które są już obecne w tytule lub tekście przycisku. Jeśli nie możesz uniknąć powtórzenia, przepisz opis, aby brzmiał inaczej.

Poprawnie	Build canals: Places a navigable waterway on flat land.
Niepoprawnie	Build canals: Places a navigable canal on flat land.

• Jeśli tytuł podpowiedzi sam w sobie opisuje narzędzie, nie pisz opisu.

Poprawnie	Pause game
Niepoprawnie	Pause button: Pauses the game.

• W opisie podpowiedzi zawsze opisuj funkcje w czasie teraźniejszym, używając postaci drugiej lub trzeciej osoby bez użycia zaimków.

Przykład 1	Build road: Places a section of road in a single direction.
Przykład 2	Build road: Place a section of road in a single direction.

• W tytule podpowiedzi nie używaj słowa "and". Zastąp go znakiem ampersand (&).

Poprawnie	Music & sound
Niepoprawnie	Music and sound

• Pisząc dodatkowe skróty, zawsze używaj jednego zdania na funkcję.

Poprawnie	Ctrl+Click+Drag selects an area. Shift+Click shows price preview.
Niepoprawnie	Ctrl+Click+Drag selects an area, and Shift+Click shows price preview.

Etykiety Interfejsu Użytkownika

• Zawsze staraj się pisać tekst etykiet interfejsu użytkownika, używając jak najmniej słów.
• W etykietach przycisków nie używaj słowa "and". Zamień go na znak "ampersand" (&).

Poprawnie	Save & quit
Niepoprawnie	Save and quit

• Nie powtarzaj informacji, które są już w tytule lub lepiej wyszczególnione w podpowiedzi.