Instrukcja Stylów
/File/en/Notice.png
Informacja
Ten artykuł tłumaczyli ludzie tacy jak Ty. Mimo dołożenia wszelkich starań, żeby tłumaczenie było poprawne merytorycznie, może okazać się że między polską a angielską wersją językową są jakieś drobne różnice.
Pamiętaj - w oryginale ten artykuł napisano w języku angielskim, więc w razie wszelkich nieścisłości to angielska wersja stoi nad innymi.

Contents

/File/en/Wiki/StyleGuide.png

Ta strona zawiera listę zasad tworzenia i edycji artykułów wiki OpenTTD.

Zobacz pomoc dotyczącą edycji, jeśli jesteś nowy w edycji wiki.

Jeśli chcesz dołączyć do nas jako tłumacz, zajrzyj na stronę Internacjonalizacja

Bardzo ważne zasady

  1. Zawsze zostawiaj swój nick zamieszczając komentarz. Wpisz cztery tyldy: "~~~~" - nick z datą pojawi się automatycznie.
  2. Zawsze używaj przycisku Pokaż podgląd przed zapisaniem zmian.
  3. Zawsze odnoś się do tej strony podczas edytowania stron.

Zasady ogólne

Folders

Wszystkie strony wiki są sortowane w folderach. Obrazy, szablony i kategorie, do których odwołują się tylko strony w określonym folderze, trafiają do tego samego folderu.

Manual Instrukcja gry, informacje dla 'graczy'.
Manual/Game Mechanics Strony szczegółów dla 'min/max' ze spojlerami.
Manual/Tutorial Tutorial, pierwszy kontakt z 'grą'.
Community Treści społeczności, które nie pasują nigdzie. Preferuj używanie osobistych stron GitHub pages/repozytoriów/wiki do osobistych treści.
Development Tworzenie OpenTTD i 'zawartość' dla OpenTTD.
Development/Script Informacje dotyczące tworzenia 'SI' i skryptów GameScripts.
Development/NewGRF Informacje dotyczące tworzenia NewGRF-ów.
Development/Design Drafts 'Projekty' dokumentów dla zmian o większym zakresie. Preferuj używanie osobistych stron GitHub/repozytoriów/wiki do osobistych projektów.
Wiki Strony o samej wiki.
Archive Rzeczy, które są interesujące tylko dla starszych ludzi.
Archive/OpenTTD Historia OpenTTD, TTDPatch i 'zaprzyjaznionych'.
Archive/Manual/Settings Stare strony 'skrótowe'. Proszę ulepszyć 'podpowiedzi i wskazówki' w grze, zamiast pisać strony wiki o ustawieniach.

Tytuły artykułów

Liczba pojedyncza czy mnoga?

Kiedy tworzysz artykuł, zastanów się czego będzie szukał gracz.
na przykład: Gracz pragnący dowiedzieć się czegoś o Przedsiębiorstwach najprawdopodobniej wyszuka "przedsiębiorstwa", nie: "przedsiębiorstwo"

Zawsze możesz utworzyć stronę przekierowującą:

#REDIRECT [[Przedsiębiorstwa/Pl]]

W razie wątpliwości (jednak nie powinny być one zbyt częste) użyj liczby pojedynczej

Wielkie litery

Nie należy umieszczać w tytułach wielkich liter, chyba że wymaga tego pisownia (np. OpenTTD). Wiki automatycznie zmieni pierwszą literę tytułu na wielką.

Strony językach innych niż angielski

Tytuł artykułu powinien być napisany w tym samym języku co artykuł, następnie, po znaku /, w tytule należy umieścić kod języka. Na przykład:

Strony nieangielskie znajdziesz tutaj: Category

Od tłumacza: W tytułach artykułów można, a wręcz należy używać polskich liter (Dlaczego należy? Jeśli zaczęlibyśmy tworzyć strony bez ploskich znaków w tytułach, po chwili pogubilibyśmy się wśród nazewnictwa. Gdyby dwóch użytkowników stworzyło stronę o Złocie w grze OpenTTD, i jeden nazwałby ją Zloto a drugi Złoto, mielibyśmy dwie strony o tym samym... Tak samo z innymi rzeczami)

Strony testowe

Jeśli piaskownica nie jest wystarczającym narzędziem dla Twojej strony, możesz stworzyć stronę jako "folder" na stronie użytkownika. Pomaga to utrzymać główną przestrzeń nazw w czystości. Przykład:

Przestrzenie nazw

Jeśli twój artykuł nie dotyczy bezpośrednio gry, to prawdopodobnie należy do przestrzeni nazw. Przykłady:

Treść artykułu

Ilustracje

Najważniejsze żeby działało. Do większości grafiki najlepszy format to .png. Wstawienie obrazka wygląda tak:

Kod Efekt
[[File:en/Archive/Manual/Settings/Longerbridges.png|frame|Opis oobrazka]]
Opis obrazka

Opisywanie zrzutu ekranu

Prawidłowo opisany zrzut ekranu

Jeśli publikujesz zrzuty ekranu objaśniające koncepcje gier lub skrzyżowania, powinieneś ograniczyć do minimum ilość tekstu objaśniającego w rzeczywistym obrazie, a zamiast tego w głównym tekście odnieść się do oznaczonych elementów. Oznaczenia powinny być wykonane w kontrastowym kolorze (dla klimatu umiarkowanego dobry jest biały) przy użyciu czcionki bezszeryfowej, pogrubionej na przezroczystym tle. W razie potrzeby można użyć strzałek, ale lepiej jest umieścić etykietę w pobliżu elementu, który ma być objaśniony. Przykładem tego formatu jest obrazek po prawej stronie (ale pamiętaj, że etykiety nie muszą być literami lub cyframi, o ile nie zakłócają one zrzutu ekranu i nie zwierają całego objaśnienia, które powinno znajdować się w głównym tekście).

Zrzuty ekranu okienek

Jeśli załączasz taki zrzut ekranu, postaraj się przyciąć go dokładnie do krawędzi okna, aby uzyskać bardziej profesjonalny wygląd. Okna OpenTTD to idealne prostokąty, więc powinno być to wystarczająco proste - w razie potrzeby można je powiększyć.

Instrukcje w etapach

Do oddzielnych kroków należy używać list uporządkowanych i nieuporządkowanych:

Kod Efekt
#krok 1.
#krok 2.
#* uwaga do kroku 2.
#* uwaga do kroku 2.

  1. krok 1.
  2. krok 2.
    • uwaga do kroku 2.
    • uwaga do kroku 2.

Wersja gry

Skoncentruj się na tworzeniu artykułów do najnowszej wersji, nie na wersjach nocnych (nightly). Na stronach deweloperskich można dyskutować o nocnych funkcjach. Jeśli naprawdę musisz dołączyć funkcję nocną, oznacz sekcję szablonem {{en/Nightly}}.

Angielski - brytyjski czy amerykański?

Oryginalny TTD został stworzony w Wielkiej Brytanii, więc..:

Od tłumacza: W artykułach w języku polskim należy używać funtów, a po nich w nawiasie, złotówek (wartość 6-krotnie większa). Natomiast jednostki pozostawiamy metryczne (km/h, nie używamy mph)

Przyciski w grze, elementy menu itp.

Przy cytowaniu nazwy przycisku w grze należy używać kursywy (w niektórych przypadkach pogrubienia), bez cudzysłowów. Na przykład:

Aby dostosować ustawienia łatek, kliknij przycisk Configure Patches.

Używanie "meta"słownictwa

Unikaj używania słowa wiki i innych słów opisujących mechanikę, chyba że jest to absolutnie konieczne. Nazwa tego co edytujesz to dokumentacja, podręcznik, tutorial itp. - Wiki jest tylko środkiem przekazu, więc najlepiej w ogóle o niej nie wspominać.

Podobnie wygląda sprawa z rzeczami takimi jak "strona", "sekcja" czy "link" przy linkowaniu do innych stron - powinieneś użyć tytułu strony jako tekstu linku. Dobrym sposobem na podjęcie takiej decyzji jest wyobrażenie sobie strony jako drukowanego dokumentu i sprawdzenie, czy ma ona sens - oczywiście słowo "kliknij" nie ma sensu w tym kontekście.

Dążymy tutaj do tego, aby informacje były niezależne od mediów i użyteczne w każdym formacie, w jakim się znajdują. Oczywiście meta-słownictwo może być odpowiednie, jeśli jest to artykuł taki jak ten - o tym, jak korzystać z wiki.

Patche (łatki)

Użyj takiego samego formatu jak w artykule Longer bridges (en) (w jęz. angielskim).

Szablony

Format szablonów

Tworząc szablon, użyj takiego samego formatu jak w szablonie {{en/Nightly}}. Pamiętaj o dołączeniu instrukcji dla innych!

Wybierz kolorystykę najlepiej pasującą do wiadomości, którą chcesz przekazać - poczytaj o ramkach informacyjnych, żeby dowiedzieć się więcej na temat doboru kolorów (strona w języku polskim).

Podstawowe szablony

Zobacz artykuł: Wspólne szablony

Kategorie

Format kategorii

Tworząc stronę kategorii, użyj takiego samego formatu jak na stronie Znoszone (en).

Dodawanie artykułu do kategorii

Dodaj swój artykuł do kategorii - a nawet dwóch, lub więcej, jeśli to możliwe - ułatwi to jego znalezienie.

Umieść kod przydzielający do kategorii na samym końcu swojego artykułu:

Należy zawsze najpierw sprawdzić, jaki rodzaj artykułów korzysta z danej kategorii. Na przykład: (angielskojęzyczna) kategoria Lokomotywy przeznaczona jest tylko dla artykułów o konkretnych maszynach - nie dla jakichkolwiek artykułów związanych z pociągami, które wspominają o lokomotywach. Założenie jest takie, że jeśli użytkownicy chcą mieć prostą, "nieskażoną" listę lokomotyw, przejdą do tej kategorii.

Scenariusze

Sprawdź instrukcje dla scenariuszy tutaj: Grupa Scenarios#procedura-dodawania-scenariusza. Umieść scenariusz w przestrzeni nazw Scenario, jak:

Zobacz również