openSUSE wiki:Jak pisać artykuły

Każdy artykuł powinien mieć jakiś wstęp. Może to być podsumowanie funkcji programu/obiektu opisywanego w art., określenie jego popularności, historia powstawania, czy po prostu krótki opis. Pod wstępem powinno się znajdować spis treści, którego zadaniem jest ułatwienie linkowania do danych części opisu.

Formatowanie tekstu

Szczegółowe informacje, jak wygląda formatowanie tekstu w MediaWiki, znajdują się na stronach "technicznych" wikipedii.

Nagłówki

Warto treść rozbijać na nagłówki. Dzięki nim, jeśli zaistnieje potrzeba zalinkowania na forum czy ircu, można linkować np. do części odnoszącej się do GNOME. Rozbicie też pomaga w wykonywaniu porad z opisów, przez nie artykuły robią się "krokowe".

Największy nagłówek używany na openSUSE wiki ma dwa znaki równości z obu stron. Jeśli istnieje potrzeba umieszczenia jednoznakowego, to należy się zastanowić, czy nie lepiej stworzyć nową stronę z danym zagadnieniem. Nie powinno się używać nagłówka na początku strony, bez wstępu i spisu, ponieważ nagłówek traci swoje nawigacyjne właściwości i przylegając tuż do tytułu strony, jest po prostu nietetyczny.

Licencja, podpisywanie się

Artykuły są dostępne na licencji CC BY-NC-SA 3.0. Jest to szczególnie ważne przy umieszczaniu treści przeklejonej z innych stron - jeśli nie będą zgodne, artykuł poleci w /dev/null. W przypadku wielu naruszeń, ich twórca powędruje w ślad za swoimi artykułami. Oczywiście, jeśli tekst został udostępniony przez stronę trzecią na wiki, to grzeczność nakazuje wklejenie boksa z informacją o pierwotnym źródle ;)

Na wiki zostało przyjęte, że jedynym podpisem jest historia edycji. W przypadku umieszczenia podpisu pod artykułem, zostanie on usunięty.

Obrazki

Obrazki można przesłać w zakładce Prześlij plik, która znajduje się w ramce narzędzia z lewej strony.

Obrazek należy wklejać do artykułów jako miniaturkę kodem:

[[Plik:NAZWA_OBRAZKA|thumb|right|150px|OPIS_POD_MINIATURKĄ]]

Okno Konqueror z wyświetloną stroną sysinfo

Gdzie:

• NAZWA_OBRAZKA - tu należy podać nazwę wklejonego obrazka;
• thumb - określa, że ma być to miniaturka;
• right - określa wyrównanie do prawej strony;
• 150px - okresla wielkość miniaturki
• OPIS_POD_MINIATURKĄ - tu należy podać opis jaki ma się pokazać pod miniaturką.

Ze względów porządkowych, zmian parametrów thumb, right, 150px należy dokonywać tylko w uzasadnionych przypadkach.

Przykład:

[[Plik:Sysinfo2.png|thumb|right|150px|Okno Konqueror z wyświetloną stroną sysinfo]]

Styl pisania

Zdania na wiki są pisane w formie bezosobowej, ponieważ jest najbardziej neutralna. Uznano, że zwracanie się per Ty do użytkownika jest zbyt kontrowersyjne pod wględem grzecznościowym, a inna popularna forma - pierwsza osoba liczby mnogiej - jest kłamliwa, ponieważ to tylko czytający wykonuje w danym momencie rzeczy opisane na stronie.

Dosć dobrym porównaniem są przepisy kucharskie - zarówno one i artykuły tutaj zamieszczone są raczej wskazówkami przygotowania, niź litanią, którą należy wykonać/przekleić bez chwili zastanowienia.

Szablony

Szablony powstały w celu ujednolicenia wyglądu wiki oraz ułatwienia edycji.

Jak używać szablonów?

Aby wstawić szablon do artykułu, wystarczy po prostu przekopiować kod wybranego szablonu do treści wybranego artykułu. W niektórych przypadkach (np. w szablonie Szablon:Uwaga) będzie trzeba wstawić odpowiedni tekst - wystarczy napisać:

{{Uwaga|Tutajuwaga}}

Zastępując Tutajuwaga pożądanym tekstem - warto pamiętać, że można używać składni mediawiki w tym tekście. Niektóre szablony są przeznaczone tylko do umieszczania na górze artykułu - są to odpowiednio:

• Szablon:Nieaktualny
• Szablon:Niekompletny
• Szablon:Uporządkowanie
• Szablon:Zintegrowania

W przypadku uwag co do użycia szablonu w jakimś artykule, należy zgłosić je na forum lub w dyskusji danej strony.

Ile jest szablonów i do czego służą?

Wszystkie szablony są wymienione poniżej. Powstały w celu ujednolicenia i ułatwienia pracy w wiki. W razie zmiany szablonu nie trzeba edytować kilkunastu stron - wystarczy zmienić szablon. Żeby używać szablonów nie trzeba znać się na CSS, wystarczy niewielka znajomość składni MediaWiki.

Szablony "ważnych" uwag

Bardzo istotne dla czytelnika, do używania w sytuacjach kiedy artykuł nie pasuje do aktualnej wersji openSUSE czy programu, lub źle wykonana rada może coś uszkodzić.

Szablon:Uwaga

Uwaga: jestem bardzo ważną uwagą!

{{Uwaga|jestem bardzo ważną uwagą!}}

Szablon:Nieaktualny

Ten artykuł dotyczy starszej wersji oprogramowania, informacje w nim zawarte są nieaktulne.

{{Nieaktualny}}

Szablony informacyjne

Sztuczki czy informacje o obszerniejszym podejściu do jakiegoś tematu w innym artykule.

Szablon:Wskazówka

Wskazówka: jestem bardzo pomocną wskazówką!

{{Wskazówka|jestem bardzo pomocną wskazówką!}}

Szablony o stanie artykułu (i mniej "ważnych" uwag)

Informujące o tym, że artykuł wymaga dopracowania, lecz to nie jest jakaś krytyczna sprawa. Niekompletny i Uporządkowanie mają dodatkowe zasady użycia wypisane na swoich stronach.

Szablon:Niekompletny

Ten artykuł jest niekompletny i wymaga rozbudowy. Szczegóły można znaleźć na stronie dyskusji.

{{Niekompletny}}

Szablon:Uporządkowanie

Ten artykuł wymaga uporządkowania. Szczegóły można znaleźć na stronie dyskusji.

{{Uporządkowanie}}

Szablon:Zintegrowania

Poniższy artykuł należy zintegrować z artykułem Strona główna.

{{Zintegrowania|Strona główna}}