Zasady Pisania Na Wiki

Zasady

  1. Wszystkie artykuły muszą być pisane zgodnie z zasadami polskiej gramatyki, interpunkcji i ortografii, a także z polskimi znakami diakrytycznymi. Artykuły mają być pisane w formie bezosobowej, zabronione jest bezpośrednie zwracanie się do czytelnika. Nalegamy na pisanie stylem w miarę oficjalnym i słowami, które znajdują się w słowniku języka polskiego.
  2. Nie dublujemy żadnych treści zawartych w oficjalnej dokumentacji Gentoo.
  3. Wszystkie opisy mają być dokładnie sprawdzane zanim zostaną dodane do wiki. Jeśli jakiś opis zostanie zgłoszony jako niedziałający, musi zostać niezwłocznie naprawiony lub usunięty.
  4. Nie wolno publikować żadnych treści bez wyraźnej zgody ich autora, chyba, że pozwala na to licencja artykułu.
  5. Każdy artykuł musi być podpisany w następującym formacie:
------

Autorem artykułu jest [[[user pseudonim]]].

Życzymy miłej pracy.

Sposób formatowania

By móc dobrze zorganizować tekst, należy wprowadzić znaczniki rozdziałów, które posłużą nam później do budowania spisu treści o ile dodamy na początku tekstu znacznik [[toc]]. Posługujemy się następującą składnią:

+ Nazwa rozdziału
++ Nazwa podrozdziału
+++ Nazwa podrozdziału o poziom niższego
++++ Nazwa podrozdziału niższego o jeszcze jeden poziom

Jak powyższe znaczniki się przedstawiają, widać w spisie treści tego dokumentu.

UWAGA: Nie przesadzajmy z ilością tych znaczników.

Wypunktowanie

* (bez użycia poprzedzającej spacji) - tworzy następujące wypunktowanie:

  • test1
  • test2

# (bez użycia poprzedzającej spacji) - tworzy następujące wypunktowanie:

  1. test1
  2. test2

Wynik polecenia

By wstawić wynik polecenia do dokumentu, posługujemy się następującą składnią:

[[code]]test[[/code]]

Prezentuje się to następująco:

test

Treść pliku

TODO

Polecenie

Jeśli zamierzamy wstawić treść polecenia, które ma wydać użytkownik, posługujemy się:

{{$ polecenie -x parametr1 -y parametr2}}

Prezentuje się to następująco:
$ polecenie -x parametr1 -y parametr2

Warto dodawać $ lub #, by poinformować czytelnika, z jakiego użytkownika ma wykonywać dane polecenie.

Pogrubienie/kursywa

Jeśli chcemy wstawić kursywę, piszemy //kursywę//.
Jeśli chcemy wstawić pogrubienie, piszemy **pogrubienie**.
Jeśli chcemy wstawić kursywę i pogrubienie, piszemy //**kursywę i pogrubienie'**//

Nazwy pakietów/poleceń/ścieżek do katalogów w tekście

Jeżeli chcemy napisać nazwę pakietu, np. kde-base/kicker, posłużymy się następującym formatowaniem:

##blue|kde-base/kicker##

Jeżeli chcemy umieścić nazwę polecenia w tekście, np. emerge -uDN world, posługujemy się następującym formatowaniem:

##red|emerge -uDN world##

Jeżeli chcemy umieścić ścieżkę katologu lub pliku, np. /etc/X11/xorg.conf, posługujemy się następującym formatowaniem:

##blue|/etc/X11/xorg.conf##

Wstawianie linków

W tym przypadku odsyłam do ładnej tabelki tutaj

Znak ucieczki

Jeśli chcemy skorzystać z jakiegoś znaku, który jest zarezerwowany dla wiki, posługujemy się znakiem ucieczki, który w przypadku wikidot, to @@, czyli podwójny znak at (potocznie nazywany "małpą"). Znaki takie należy umieścić przed i za linijką w przypadku której chcemy ominąć parsowanie przez wiki.

Zależałoby nam, by następujące znaki nie były parsowane @@//@@ @@**@@

Zależałoby nam, by następujące znaki nie były parsowane // **


Autorem artykułu jest Damjanek.

Zawartość tej strony dostępna jest na licencji Creative Commons Attribution-Noncommercial-Share Alike 2.5 License.