Pomoc:Styl

(Przekierowano z OpenSUSE Style Guide)
Skocz do: nawigacja, szukaj
32px-Icon-cleanup.png Ten artykuł wymaga uporządkowania ponieważ nie spełnia standardów jakości wiki.
Jeśli chcesz go edytować pamiętaj o trzymaniu się zasad tego wiki a jeśli masz pytania, nie wahaj się skontaktować z zespołem wiki, jesteśmy gotowi Ci pomóc! :-)

Prosimy o stosowanie się do poniższych zasad podczas tworzenia lub edycji stron openSUSE wiki.

Tytuły artykułów


Nazwa artykułu (strony) jest także jego tytułem. Postaraj się aby była jednoznaczna, nie używaj tajemniczych skrótów ani nie stosuj ZapisuTegoTypu. Nie powtarzaj tytułu w nagłówkach niższego poziomu. Nie twórz własnych przestrzeni nazw.

Nagłówki


  • Używaj znacznika =, zamiast ''' (pogrubienie) aby stworzyć nagłówek (wyróżnić sekcję w artykule). Dzięki temu będzie możliwa automatyczna generacja spisu treści.
  • Rozpocznij pojedynczym znakiem = zamiast ==. Na przykład:
=nagłówek 1=
==nagłówek 1.1==
==nagłówek 1.2==
=nagłówek 2=
==nagłówek 2.2==
===nagłówek 2.2.1===
====nagłówek 2.2.1.1===
  • Stosowanie znaczników wyróżniających nagłówki sprawia, że czytelnik w łatwy sposób może dotrzeć do tej części artykułu, która go interesuje oraz pominąć informacje, które nie są dla niego istotne.
  • Jeśli Twój artykuł okaże się być bardzo długim zastanów się czy nie warto zastosować nagłówków wielopoziomowych (tak jak w powyższym przykładzie).

Stosuj wyróżnienia


Korzystaj ze specjalnych znaczników formatujących MediaWiki, tak aby tekst był łatwiejszy do czytania. Nazwy plików oraz komendy wiersza poleceń powinny być wyświetlane z wykorzystaniem czcionki o stałej szerokości:

<tt>czcionka o stałej szerokości</tt>

Wykorzystuj możliwości MediaWiki


Nie używaj znaczników HTML do momentu kiedy będzie to naprawdę konieczne. Wykorzystywanie znaczników formatujących MediaWiki pozwala zachować artykułom podobny styl i wygląd oraz powoduje , że ich kod źródłowy jest łatwiejszy do czytania i edycji. Możesz skorzystać z tego artykułu aby dowiedzieć się więcej na temat możliwości formatowania i organizacji tekstu. Przydatnym może także okazać się przeglądnięcie kodu źródłowego kilku artykułów w Wikipedii.

Komentarze


Jako czytelnik, użyj strony dyskusji danego artykułu aby podzielić się swoimi uwagami na jego temat. Nie zaśmiecaj niepotrzebnie tekstu artykułu.

Jako autor, unikaj umieszczania informacji o tym że artykuł jest niekompletny i wymaga rozbudowy. Do tego celu służy szablon {{Expand}}.

Jeśli chcesz przekazać informację innym edytującym, użyj komentarzy, które będą niewidoczne dla zwykłych czytelników. Aby tego dokonać umieść swój komentarz między znacznikami

<!-- i -->.

Na przykład w ten sposób:

Witaj <!--To jest komentarz.--> świecie!

jest widoczne jako:

Witaj świecie!

Komentarz będzie widoczny podczas przeglądanie kodu źródłowego wiki lub HTML.

Szablony

http://en.opensuse.org/Templates

Mały jest pożytek dla czytelnika z samych nagłówków lub pustych tabel, jednak czasami takie podejście może okazać się przydatne. Dzieje się tak wtedy gdy puste artykuły stanowią szablon, na podstawie którego dokonuje się dalszych edycji.

Zawartość artykułów


Nie twórz artykułów, które nie wiążą się choćby w minimalny sposób z tematyką openSUSE wiki. Dobrym sposobem okazania zapotrzebowania na nowy artykuł w wiki jest umieszczenie do niego łącza w innym artykule. Jeśli istnieją co najmniej dwa odniesienia do tego samego, nieistniejącego artykułu, pojawi się on na liście Wanted Pages.