MediaWiki w obrazkach/Podstawy formatowania tekstu

Tak to się robiło dawno temu...

W tym rozdziale zostaną przedstawione podstawy wikikodu służącego do formatowania tekstu.

Wikikod został stworzony z myślą o ludziach, którzy nie znają XHTML. Z technicznego punktu widzenia wikikod jest w gruncie rzeczy odpowiednikiem tagów (znaków sterujących) języka XHTML stosowanego rutynowo do pisania stron WWW przez zawodowych webmasterów. Oprogramowanie MediaWiki zamienia automatycznie wikikod na odpowiednie tagi XHTML i wysyła tak wygenerowaną stronę WWW do przeglądarki użytkownika. Wikikod oferuje znacznie mniej możliwości od pełnego XHTML, ale za to jest znacznie prostszy i bardziej intuicyjny. Jego podstaw można się nauczyć w godzinę, gdy tymczasem opanowanie XHTML wymaga dużo więcej czasu i pewnego, minimalnego obycia programistyczno-informatycznego. Wikikod składa się z prostych znaków w rodzaju "=" i "[[".

Aby lepiej zrozumieć ten artykuł należy wcześniej zapoznać się z rozdziałem: Piszemy od podstaw nieduży artykuł oraz Okno edycji

"Niewidzialne" wikikody

Wielu początkujących autorów dziwią w wikokodzie trzy rzeczy:

• ignoruje on normalne znaki końca akapitu, czyli wciśnięcia klawisza "enter", które w "normalnych edytorach" powodują rozpoczęcie nowej linii tekstu; nowy akapit można stworzyć dopiero przez dwukrotne przyciśnięcie klawisza "enter", czyli pozostawienie jednej pustej linii tekstu; pusta linia tekstu jest w istocie rodzajem "niewidzialnego" wikikodu, który powoduje właśnie rozpoczęcie nowego akapitu
• naciśnięcie klawisza "enter" powoduje za to wyłączenie wszystkich aktualnie aktywnych wikikodów, co powoduje nieoczekiwane efekty, jak np. zaburzenie porządku numerowych list
• pozostawienie spacji na początku linii tekstu, co jest zwyczajowym sposobem rozpoczynania akapitu skutkuje dość nieoczekiwanym efektem - tekst jest wyświetlany na szarym tle i obwiedziony ramką oraz często wychodzi poza stronę - w istocie spacja na początku linii tekstu jest również rodzajem "niewidzialnego" wikikodu, który uruchamia pole preformatowanego tekstu.

Np. kod:

''W tym rozdziale znajduje się instrukcja jak stworzyć 
 od podstaw prostą stronę w MediaWiki,  na przykładzie artykułu 
 "Krówka destylacyjna" w Wikipedii. 
 Jego celem jest skrótowe przedstawienie podstawowych etapów procesu pisania. 
 W rozdziale tym występują opisy działania wybranych elementów wikikodu, 
 ale nie należy oczekiwać, że po jego przeczytaniu będzie się już wszystko 
 na ten temat wiedziało.''

Wyświetli się jako:

W tym rozdziale znajduje się instrukcja jak stworzyć od podstaw prostą stronę w MediaWiki, na przykładzie artykułu "Krówka destylacyjna" w Wikipedii. Jego celem jest skrótowe przedstawienie podstawowych etapów procesu pisania. W rozdziale tym występują opisy działania wybranych elementów wikikodu, ale nie należy oczekiwać, że po jego przeczytaniu będzie się już wszystko na ten temat wiedziało.

Podstawowe elementy formatu tekstu

Sterowanie czcionkami

Wikikod umożliwia uzyskanie prostego efektu pochylenia, pogrubienia i pochylenia z pogrubieniem, które realizuje się za pomocą apostrofów " ' "

Przykładowy kod:

''Pochylenie''

'''Pogrubienie'''

'''''Pochylenie i pogrubienie'''''

i jego rezultat:

Pochylenie

Pogrubienie

Pochylenie i pogrubienie

Wikikod celowo nie oferuje więcej możliwości sterowania czcionkami

Nie można za jego pomocą zmieniać rozmiaru tekstu, rodzaju czcionki i jej koloru, a także uzyskiwać efektu podkreślenia. Jest tak celowo - twórcom oprogramowania MediaWiki chodziło bowiem o to, aby strony na serwisach wyglądały mniej więcej jednolicie i tworzyły jedną, typograficznie spójną całość. Wielu użytkowników ignoruje jednak ten fakt i formatuje teksty na swój sposób stosując tagi XHTML. W wielu serwisach jest to zabronione lub przynajmniej nie zalecane - w innych z kolei zezwala się na takie "upiększanie" stron.

Wcięcia

Wcięcie polega na odsunięciu fragmentu tekstu od lewego brzegu ekranu. Może być stosowane np. do wyróżnienia cytatów lub przykładów. Realizuje się je przy pomocy znaku ":". Aby dwukropek zadziałał jako wikikod wcięcia, musi znajdować się na samym początku linii tekstu. Dwukropki wplecione w tekst są po prostu wyświetlane jako dwukropki.

Przykładowy kod:

:Pojedyncze wcięcie

::Podwójne wcięcie

:::Potrójne wcięcie

::::Poczwórne wcięcie

i jego rezultat:

Pojedyncze wcięcie

Podwójne wcięcie

Potrójne wcięcie

Poczwórne wcięcie

Definicje

Tzw. definicje tworzy się za pomocą znaków: ";" (średnik) i ":" (dwukropek). Definicja składa się z wytłuszczonego nagłówka (definiowanego pojęcia) i wciętego tekstu zwykłego (wyjaśnienia pojęcia.).

Przykładowy kod:

;Definicja : To jest definicja definicji

da efekt:

Definicja

To jest definicja definicji

Należy zwrócić uwagę, że definicja musi być napisana w jednej linii i między definicją pojęcia i dwukropkiem musi być spacja, a po dwukropku musi być kolejna spacja przed wyjaśnieniem pojęcia. Napisanie:

;Definicja :

To jest definicja definicji

choć wydaje się intuicyjne, da zupełnie inny efekt:

Definicja

To jest definicja definicji

gdyż jak już było wspomniane wyżej wstawienie znaku "enter" wyłącza wszystkie wikikody.

Oczywiście wikokod "definicji" można używać nie tylko do wprowadzania definicji, lecz we wszystkich przypadkach gdzie to może być celowe.

Tekst preformatowany

O tekście preformatowanym była już mowa wyżej. Kodem tekstu preformatowanego jest "niewidzialna" spacja wstawiona na początku linii tekstu. Tekst preformatowany jest "wyłączany" przez rozpoczęcie kolejnej linii tekstu bez spacji na początku. Tekst preformatowany, jak sama nazwa wskazuje, nie jest formatowany przez oprogramowanie, co powoduje, że nie ignorowane są znaki końca akapitu ("enter"), ale też linie tekstu nie są automatycznie zawijane do szerokości strony, co powoduje, że mogą sprawiać wrażenie jakby wychodziły za ekran.

Przykładowy "kod":

To jest długa linia tekstu, która z pewnością wyjdzie poza ekran, jak ktoś nie wierzy, to zaraz to zobaczy. O proszę bardzo, ten tekst wyszedł poza ekran.

Da taki efekt:

To jest długa linia tekstu, która z pewnością wyjdzie poza ekran, jak ktoś nie wierzy, to zaraz to zobaczy. O proszę bardzo, ten tekst wyszedł poza ekran.

Tekst preformatowany przydaje się często do przedstawiania kodu programów komputerowych, oraz tekstów dokumentów urzędowych, które się cytuje.

Elementy struktury tekstu

Wikikod oprócz formatowania tekstu ciągłego umożliwia mu też nadanie logicznej struktury. Do tego celu służy zbiór kilku, dość prostych kodów.

Tytuły i sekcje

Wikikod pozwala dzielić tekst na sekcje. Każda sekcja posiada swój tytuł, który jest widoczny odpowiednio dużą czcionką. Sekcje tworzy się poprzez wstawienie na ich początku tytułu.

Tytuły tworzy się za pomocą wikikodu "=". Tytuły posiadają hierarchię od poziomu 1. (jeden znak "=") do poziomu 6. (sześć znaków "="). Tytuły coraz niższych poziomów są wyświetlane coraz mniejszą czcionką. Poziom 5. wyświetlany jest taką samą czcionką jak zwykły tekst, 6. poziom wyświetlany jest czcionką o połowę mniejszą od normalnej. Poziomy 1. i 2. są dodatkowo wyróżnianie poziomą kreską.

Sekcje mogą być zagłębiane jedna w drugiej i tworzyć w ten sposób hierarchiczną strukturę. Co więcej, oprogramowanie tworzy z tytułów sekcji automatycznie spis treści, który standardowo jest umieszczany zaraz nad pierwszą, utworzoną w dokumencie sekcją. Standardowo, spis treści pojawia się automatycznie, gdy na stronie jest więcej niż 2 sekcje tego samego poziomu.

Każdą sekcję można oddzielnie edytować, bez konieczności ładowania do okna edycji kodu pozostałej części strony, co jest szczególnie przydatne przy bardzo obszernych dokumentach. Robi się to klikając na mały link [edytuj], który znajduje się po prawej stronie ekranu na wysokości danej sekcji. W przypadku sekcji posiadających podsekcje, kliknięcie na "[edytuj]" spowoduje wczytanie do pola edycji także kodu wszystkich podsekcji.

Przykładowy kod:

= 1 poziom =

== 2 poziom ==

=== 3 poziom ===

==== 4 poziom ====

===== 5 poziom =====

====== 6 poziom ======

Aby uniknąć rozbicia struktury tego dokumentu, który również jest pisany z użyciem mechanizmu sekcji i tytułów, rezultat przykładowego użycia tytułów znajduje się w dodatku Przykład stosowania tytułów.

Umiejscowieniem spisu treści można sterować za pomocą tzw. magicznego słowa __TOC__. Słowo __TOC__ określa miejsce gdzie w tekście ma wystąpić spis treści. Spis treści można też wyłączyć przez napisanie w tekście __NOTOC__.

Przykład użycia zmiennej __TOC__ jest pokazany we wcześniej wspomnianym dodatku: Przykład stosowania tytułów.

Spisy

Wikikod spisów zwanych też listami umożliwia tworzenie automatycznie formatowanych "wyliczanek". Kody te należy wstawiać na początku linii tekstu, w przeciwnym razie zostaną zinterpretowane przez system jako zwykłe znaki. Istnieją dwa rodzaje takiego kodu.

• "*" - to lista nienumerowana, w której kolejne pozycje są oznaczane tzw. "bombą", czyli grubym kwadracikiem lub kulką

• "#" - to lista numerowana, w której kolejne pozycje są oznaczane standardowo kolejnymi liczbami arabskimi, poczynając od "1"

Przykładowy kod listy nienumerowanej:

* pozycja z "bombą"

* pozycja z "bombą"

* pozycja z "bombą"

i efekt:

• pozycja z "bombą"
• pozycja z "bombą"
• pozycja z "bombą"

Przykładowy kod list numerowanej:

# pozycja 1

# pozycja 2

# pozycja 3

i efekt:

1. pozycja 1
2. pozycja 2
3. pozycja 3

Listy można z sobą mieszać i tworzyć ich piętrowe struktury.

Przykład złożonej, piętrowej i mieszanej listy:

# pozycja 1

## pozycja 1.1

### pozycja 1.1.1

##* pozycja 1.1.1. z "bombą"

# pozycja 2

#* pozycja 2 z "bombą"

# pozycja 3

i efekt:

1. pozycja 1
   1. pozycja 1.1
      1. pozycja 1.1.1
      • pozycja 1.1.1. z "bombą"
2. pozycja 2
   • pozycja 2 z "bombą"
3. pozycja 3

Aby utrzymać ciągłość numeracji list nie wolno rozdzielać jej żadną linią tekstu - również pustą. Zerwanie ciągłości listy powoduje, że numeracja zaczyna się ponownie od 1.

Przykład:

#pozycja 1

#pozycja 2

przerwa

#pozycja 3

#pozycja 4

i efekt:

1. pozycja 1
2. pozycja 2

przerwa

1. pozycja 3
2. pozycja 4

Zgodnie z zasadą, że znak zakończenia linii tekstu (przyciśnięcie klawisza "enter") powoduje wyłączenie wszelkich otwartych wikikodów, nie wolno użyć tego znaku w ramach jednej pozycji w liście, bo wtedy tekst po "enter" będzie wyświetlony w osobnej linii, w dodatku zaburzającej ciągłość numeracji.

Przykład:

#W tym rozdziale znajduje się instrukcja jak stworzyć od 
 podstaw prostą stronę w  MediaWiki, na przykładzie artykułu 
 "Krówka destylacyjna" w Wikipedii.
#W tym rozdziale znajduje się instrukcja jak stworzyć od 
 podstaw prostą stronę w  MediaWiki, na przykładzie artykułu 
 "Krówka destylacyjna" w Wikipedii. 

i rezultat:

1. W tym rozdziale znajduje się instrukcja jak stworzyć od

podstaw prostą stronę w MediaWiki, na przykładzie artykułu "Krówka destylacyjna" w Wikipedii.

1. W tym rozdziale znajduje się instrukcja jak stworzyć od

podstaw prostą stronę w MediaWiki, na przykładzie artykułu "Krówka destylacyjna" w Wikipedii.

Pozioma linia

Pozioma linia przydaje się czasami do rozdzielania fragmentów tekstu, których nie chce się umieszczać w osobnych sekcjach. W wielu projektach nadużywanie poziomej linii nie jest mile widziane, gdyż mylą się one wizualnie z podkreśleniami tytułów sekcji 1. i 2. poziomu.

Poziomą linię wstawia się w tekst przy pomocy kodu w postaci czterech myślników: "----".

Przykład:

----

rezultat:

---

nowiki

Czasami zdarza się, że istnieje potrzeba wyświetlenia w tekście znaku, który normalnie zadziałałby jako wikikod. Służy do tego specjalnie zdefiniowany znacznik, wyłączający wykonywanie wikikodu przez oprogramowanie. Ma on następującą postać:

<nowiki>Fragment wyłączony</nowiki>

W ten właśnie sposób zostały umieszczone w tym rozdziale wszystkie przykłady wikikodu, które bez "nowiki" zostały by po prostu wykonane przez oprogramowanie i nie można by ich samych zobaczyć.

Wzory matematyczne

MediaWiki umożliwia wpisywanie nawet bardzo skomplikowanych wzorów matematycznych, w których mogą występować piętrowe nawiasy, symobole całek, sum, granic. wektorów itp. Do wpisywania wzorów stosuje się popularny wśród matematyków i fizyków system składu o nazwie: LaTeX. Jego pełne opisanie wykracza jednak znacznie poza zakres tego podręcznika.

W MediaWiki LaTeXowe wzory umieszcza się wewnątrz następującego kodu:

<math>Wzór</math>

LaTeXowy wzór jest przekształcany automatycznie przez oprogramowanie w obrazki wyświetlane na stronie.

Przykłady:

<math>\big|S-\sum\limits_{j=0}^{N-1} f(\xi_j)\cdot (t_{j+1}-t_j)\big|<\varepsilon/2</math>

i efekt:

${\big |}S-\sum \limits _{j=0}^{N-1}f(\xi _{j})\cdot (t_{j+1}-t_{j}){\big |}<\varepsilon /2$

Kod:

<math>m(v)=\frac{m}{\sqrt{1-\frac{v^2}{c^2}}}</math>

i efekt:

$m(v)={\frac {m}{\sqrt {1-{\frac {v^{2}}{c^{2}}}}}}.$

Kod:

<math>\int_{x_1}^{x_1 + \Delta x} f(t) dt = f(c) \Delta x </math>

i efekt:

$\int _{x_{1}}^{x_{1}+\Delta x}f(t)dt=f(c)\Delta x$

Źródła

• Formatowanie tekstu w Wikipedii
• Help:Formatting - w mediawiki.org