Help: Pomoc:Piszemy od podstaw prosty rozdział podręcznika

Edytuj
Komentarze              Archiwum wersji (wszystkie edycje)

Skopiowano ze stron roboczych projektu Wolne Podręczniki

Streszczenie 
W tym rozdziale znajduje się instrukcja jak stworzyć od podstaw prostą stronę w MediaWiki, na przykładzie Pomoc:Przykładowy rozdział. 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.

Spis treści


Tworzymy

Na rys. 1 przedstawiony jest kod hasła tak jak wygląda on w oknie edycji, zaś na rys. 2 rezultat jego działania po zapisaniu, tak jak będzie go widział czytelnik.

Etap 1: Utworzenie nowej strony

Aby zacząć pisać nieistniejący wcześniej rozdział książki wpisałem do wewnętrznej wyszukiwarki hasło "Pomoc:Przykładowy rozdział" i kliknąłem na "Przejdź", a następnie na czerwony link z sugestią napisania artykułu. Otworzyło mi się puste okno edycyjne zatytułowane "Edytujesz "Pomoc:Przykładowy rozdział" (1 na rys. 1). Po kliknięciu w pole tekstowe tego okna mogłem już zacząć pisać.

Inny sposób utworzenia nie istniejącej wcześniej strony to wpisanie na już istniejącej stronie linku do strony, którą chcemy utworzyć a następnie kliknięcie w niego. Oczywiście, jeśli na jakiejś stronie już istnieje link do jeszcze nie istniejącej strony to można go również wykorzystać do przejścia do okna edycji.

Etap 2: Pisanie strony - nagłówki i spis treści

Zgodnie z zasadami przyjętymi w Wolnych Podręcznikach rozdział zacząłem od jego tytułu - nagłówka II rzędu (2 na rys 1 i 2). Zrobiłem to wpisując najpierw tekst tego tytułu a potem zaznaczyłem go myszką przycisnąłem ikonkę A na górze okna edycji. Na skutek tego oprogramowanie dodało po dwa znaki "=" na początku i końcu tego tekstu:

==Przykładowy rozdział podręcznika==

W ten sposób użyłem pierwszego kodu formatującego - kodu nagłówka II rzędu.

Następnie napisałem krótkie streszczenie rozdziału, stosując do formatowania znak ";" i ":", które razem tworzą tzw. listę definicyjną (3 na rys 1 i 2).

Po streszczeniu umiejscowiłem automatycznie tworzony przez oprogramowanie spis treści (4 na rys 1 i 2), wstawiając tzw. magiczne słowo __TOC__.

Po wstępie i spisie treści rozpocząłem pisanie pierwszej sekcji rozdziału zaczynając go od nagłówka III rzędu (5 na rys 1 i 2), który utworzyłem poprzez użycie trzech znaków "===" na początku i końcu tekstu. W ten sam sposób stworzyłem tytuły wszystkich pozostałych sekcji.

Więcej na ten temat w: Pomoc:Tytuły

Etap 3: Formatowanie tekstu i akapity

Pod tytułem sekcji zacząłem pisać jej tekst, po prostu wpisując go akapit po akapicie. Aby akapity się nie zlewały z sobą oddzieliłem je od siebie jedną pustą linią (6 na rys 1 i 2), naciskając na końcu każdego akapitu dwa razy klawisz "enter".

Następnie aby tekst był czytelniejszy postanowiłem pogrubić jego słowa kluczowe (7 na rys 1 i 2). Zrobiłem to zaznaczając te słowa myszką, a następnie klikając na ikonę "B" u góry okna edycji. Oprogramowanie automatycznie objęło kodem formatującym zaznaczone słowa. W przypadku pogrubiania kodem tym są trzy znaki apostrofu '''. W podobny sposób można tekst pochylić poprzez jego wybór myszką i kliknięcie na ikonę "I". (8 na rys 1 i 2)

Jeden z akapitów, który jest cytatem postanowiłem wyróżnić przez utworzenie wcięcia. W tym celu po prostu dodałem na jego początku znak ":" (9 na rys 1 i 2). Gdybym dodał dwa znaki "::" - powstałoby wcięcie podwójne, gdy trzy, potrójne itd.

Więcej na ten temat w: Pomoc:elementarz formatowania tekstu


Etap 4: Utworzenie spisu

Rys 3: Środkowa część ekranu edycji
Rys 4:Środkowa część Pomoc:Przykładowy rozdział

W podręcznikach, aby poprawić ich czytelność warto stosować listy elementów. Wypunktowana lub numerowana lista elementów jest zawsze czytelniejsza niż napisanie jej w jednej linijce tekstu. Spisy tworzy się za pomocą znaku "*" i "#. Krzyżyk na początku linii tekstu powoduje powstawanie listy numerowanej (1 na rys 3 i 4) zaś gwiazdka punktowanej (2 na rys 3 i 4).

Listy numerowane i nienumerowane można z sobą dowolnie mieszać i tworzyć w ten sposób listy złożone (3 na rys. 3 i 4).

Więcej na ten temat: Pomoc:spisy

Etap 5: Tworzenie odnośników (ang link)

Aby powiązać z sobą rozdziały z jednego podręcznika lub z różnych podręczników chciałem dodać odnośniki wewnętrzne.

Zacząłem od utworzenia odnośnika do rozdziału "Pomoc:Pytania i odpowiedzi" (4 na rys 3 i 4). W tym celu zaznaczyłem myszką ten fragment tekstu a następnie kliknąłem na ikonkę Ab. Oprogramowanie automatycznie objęło to słowo podwójnym, kwadratowym nawiasem:

[[Pomoc:Pytania i odpowiedzi]]

Podwójne kwadratowe nawiasy "[[" i "]]" są kodem odnośnika wewnętrznego.

Chciałem też dodać jeden odnośnik zewnętrzny (5 na rys 3 i 4) czyli do zewnętrznej strony WWW. W tym celu najpierw wpisałem jej pełen adres:

http://pl.wikibooks.org/wiki/MediaWiki_w_obrazkach

a następnie jego opis

"MediaWiki w obrazkach"

po czym na początku i końcu wstawiłem pojedyńcze nawiasy kwadratowe: "[" i "]"

W rezultacie powstał kod:

[http://pl.wikibooks.org/wiki/MediaWiki_w_obrazkach MediaWiki w obrazkach]
Więcej na ten temat w: Pomoc:linki.


Etap 6: Dodanie obrazka

Rys. 4: Dolna część okna edycji
Rys. 5: Dolna część Pomoc:Przykładowy rozdział

Zaraz pod tytułem sekcji "Grafika" chciałem wstawić wcześniej przygotowany przykładowy obrazek (1 na rys 4 i 5). W tym celu:

  • kliknąłem na ikonkę "ekranik" na skutek czego oprogramowanie wpisało mi taki kod:
[[Grafika:Przyklad.JPG]]
  • zamieniłem nazwę "Przyklad.JPG" na nazwę pliku, w którym jest przykładowy obrazek:
[[Grafika:Maszyna parowa przekroj.png]]
  • ponieważ chciałem, aby ta grafika była umieszczona po prawo i opływana przez tekst dodałem taki fragment kodu "|right":
[[Grafika:Maszyna parowa przekroj.png|right]]
  • aby grafika została obwiedziona ładną ramką ze znaczkiem powiększenia dodałem fragment kodu "|thumb"
[[Grafika:Maszyna parowa przekroj.png|right|thumb]]
  • aby ustalić rozmiar wyświetlania obrazka (jego szerokość) dodałem do kodu "|250 px"
[[Grafika:Maszyna parowa przekroj.png|right|thumb|250 px]]
  • na koniec chciałem dodać krótki opis tego obrazka, bo istnieje zalecenie, że należy takie opisy robić; dodałem zatem taki fragment kodu "|Rys 1: przykładowy opis, przykładowego obrazka":
[[Grafika:Destylacja_z_krowka.png|right|thumb|250 px|Rys 1: przykładowy opis, przykładowego obrazka]]

I to już jest cały, potrzebny kod wstawienia obrazka z opisem, ramką, ustalonym rozmiarem wyświetlania i opływaniem z lewej strony.

więcej na ten temat w: Pomoc:grafika

Etap 7: Dodanie kategorii

Każdy rozdział podręcznika warto przypisać do określonej kategorii, aby można go było potem łatwiej znaleźć. Aby to uczynić, na samym jego dole dodałem kod:

[[Kategoria:Pomoc]]

który jest jednocześnie odnośnikiem do strony tej kategorii i przypisuje mój artykuł do niej.

Więcej na ten temat w: Pomoc:Kategorie

Podgląd, zapis poprawianie

Gdy wydaje się, że strona jest już skończona, warto jeszcze sprawdzić jak wygląda przed zapisaniem. W tym celu należy kliknąć klawisz Pokaż podgląd (3 na rys. 4). Oprogramowanie wyświetli wtedy nad oknem edycji wygląd strony tak jak ona ukazuje się czytelnikowi. Często się zdarza, że pierwszy wygląd strony jest niezadowalający - np. zapomnieliśmy gdzieś domknąć podwójny, kwadratowy nawias i link się nie wyświetla.

Po zauważeniu błędów należy oczywiście je poprawić i ponownie kliknąć "pokaż podgląd", aż wreszcie strona będzie taka jak oczekiwaliśmy. Stosowanie podglądu skraca historię zmian strony i ma też tę zaletę, że błędy, które zrobiliśmy, nie zostaną na zawsze zapamiętane na serwerze jako jedna z wersji strony.

Wreszcie, gdy wszystko wydaje się być w kodzie strony tak jak należy, pozostaje tylko kliknąć na klawisz "zapisz" (2 na rys. 4), co spowoduje załadowanie napisanej strony na serwer i stanie się ona odtąd dostępna dla wszystkich czytelników. Dość często zdarza się, że po zapisaniu strony, mimo wielokrotnego jej sprawdzania za pomocą podglądu, nadal są w niej błędy. Gdy je zauważymy możemy oczywiście ponownie kliknąć na edytuj (1 na rys. 1) i je poprawić.