Pomoc:Tworzenie podręcznika

Pomoc
Tworzenie podręcznika

Spis treści

Tworzenie zbioru podręczników

Jeśli masz zamiar stworzyć na Wikibooks nową książkę, trafiłeś w odpowiednie miejsce! Ten poradnik podpowie Ci, jak skonstruować łatwy w utrzymaniu i poszerzaniu podręcznik, zaznajomi Cię też z paroma zasadami, którymi kierujemy się na Wikibooks, aby utrzymać księgozbiór w porządku i móc go łatwo przeglądać i edytować.

Przed rozpoczęciem pracy

przeszukaj Wikibooks – być może jest tu już podręcznik, który chciałbyś napisać, lub wystarczy poszerzyć istniejący
zastanów się, co i jak chcesz napisać. Jeśli nie jesteś pewien kształtu tekstu, który chcesz stworzyć na Wikibooks, użyj strony Wikibooks:Brudnopis zamiast eksperymentować na nowym haśle
jeśli tego jeszcze nie zrobiłeś, przeczytaj Czym Wikibooks nie jest i Dlaczego nie pisać na Wikibooks, aby upewnić się, że dobrze rozumiesz ideę Wikibooks. Książki na Wikibooks mają mieć charakter edukacyjny, zatem np. nie tworzymy tutaj własnych opowiadań, nie przechowujemy tutaj tekstów źródłowych czy też nie tworzymy podręczników opisujących, jak przejść daną grę komputerową. Dodatkowo przygotowaliśmy dla Ciebie strony pomocy, w tym moduł Wikibooks:Witamy nowicjuszy. Zawsze możesz poprosić o pomoc innych użytkowników w Barze.
zobacz, jak zostały zrobione podręczniki na Wikibooks o podobnej tematyce. Jeśli podpatrzysz w nich dobre rozwiązania, oszczędzi ci to pracy.
nie porywaj się na pisanie podręczników o obszernej tematyce. Wyznacz sobie, które tematy chcesz opisać. Zamiast pisać większy podręcznik, bardziej opłaca się stworzyć mniejszy, o węższej tematyce, ale lepiej ją omawiający i mający większe szanse na to, żeby mógł zostać ukończony. Na Wikibooks mamy za dużo przypadków porzucania podręczników na początkowym etapie ich pisania. Jeśli doprowadzisz swoje dzieło do końca, wykażesz się odpowiedzialnością, a także nie rozczarujesz czytelników i innych użytkowników.

Tworzenie podręcznika

Aby stworzyć nowy podręcznik musimy wykonać poniższe kroki:

Wybieramy odpowiednią nazwę dla naszego podręcznika. Najlepiej, aby ta nazwa była dosyć krótka i rzeczowa. Tytuł nie może zawierać slasha (/), a także niektórych znaków specjalnych.
Tworzymy stronę główną podręcznika, na której się znajdzie spis treści. Najłatwiej to zrobić wpisując w pasek adresu http://pl.wikibooks.org/wiki/Nazwa podręcznika, gdzie w miejsce "Nazwa podręcznika" wpisujemy tytuł podręcznika, który chcemy stworzyć, a następnie po przejściu do odpowiedniej strony klikamy przycisk edytuj i tworzymy odpowiedni spis treści.
Jeśli chcemy, możemy stworzyć okładkę dla podręcznika. Robimy to na podstronie o nazwie "Okładka" naszego podręcznika (podstrony używając znaka "/" w nazwie), czyli w pasku adresu wpiszemy adres (http://pl.wikibooks.org/wiki/Nazwa podręcznika/Okładka).
Dodajemy podręcznik w odpowiednie miejsce do księgozbioru.

Nazewnictwo

Pierwsza rzecz, nad jaką należy się zastanowić, to wybranie nazwy podręcznika. Sprawa jest niebanalna, bo zaważy również na wszystkie podrozdziały książki.

Generalnie preferujemy nazwy, które jak najprościej i najpełniej wyrażają istotę rzeczy: Mikrobiologia, Historia Polski, Książka kucharska, Mechanika kwantowa. Tytuł książki nie powinien być przesadnie długi, nie powinien też zawierać niestandardowych znaków (mechanizm MediaWiki ostrzeże, jeśli dany znak nie może znaleźć się w tytule).

Jeśli tworzymy podrozdziały podręcznika, ich tytuły dopisujemy do tytułu głównej książki. Przykładowo, mamy podręcznik Filozofia i planujemy dodać rozdział Filozofia grecka. Nowy artykuł powinien nosić nazwę Filozofia/Filozofia grecka – tytuł książki i rozdziału są oddzielone slashem (bez spacji).

Przeczytaj także Wikibooks:Nazewnictwo artykułów aby poznać szczegóły.

Nazwa podręcznika

Generalnie, preferujemy nazwy, które jak najprościej i najpełniej wyrażają istotę rzeczy: Mikrobiologia, Historia Polski, Książka kucharska, Mechanika kwantowa. Tytuł książki nie powinien być przesadnie długi, nie powinien też zawierać niestandardowych znaków (mechanizm MediaWiki ostrzeże, jeśli dany znak nie może znaleźć się w tytule).

Jeśli tworzymy podrozdziały podręcznika, ich tytuły dopisujemy do tytułu głównej książki. Przykładowo, mamy podręcznik Filozofia i planujemy dodać rozdział Filozofia grecka. Nowy artykuł powinien nosić nazwę Filozofia/Filozofia grecka - tytuł książki i rozdziału są slashem (bez spacji).

Konstrukcja podręcznika

Dobrze jest, jeśli przystępując do pracy masz obmyśloną z grubsza wizję podręcznika. Nie chodzi o szczegóły – raczej o to, jak będzie postępował jego rozwój i jaki zakres ma obejmować. Najlepiej – rzecz jasna – byłoby, gdybyś miał/miała już gotowy podręcznik napisany przez siebie, np. pod "Wordem". Dzięki temu byłyby mniejsze szanse, że porzucisz pisanie podręcznika w połowie pracy. Nie marnowałbyś/marnowałabyś swojego wysiłku i czasu, a czytelnicy nie zawiedliby się na Tobie.

Jednym z pierwszych kroków twórcy nowego podręcznika powinno być umieszczenie na stronie głównej podręcznika spisu treści. W ten sposób porządkujemy nasze pomysły i stawiamy ważny krok – następni edytorzy zastaną już gotowy plan i to Ty w dużym stopniu wskażesz im, co powinni zrobić.

Trochę na temat stylu

Odnośnie formy:

Nie piszemy w pierwszej osobie liczby pojedynczej (możemy pisać w liczbie mnogiej). Pomimo że w danym momencie podręcznik może pisać jedna osoba, jednak później ktoś może jeszcze dołączyć do projektu.
Podczas pisania pamiętamy o zasadzie neutralnego punktu widzenia, czyli staramy się bezstronnie prezentować różne poglądy.

Odnośnie kodu:

Nie robimy zbyt dużo nagłówków, gdyż artykuł może się stać mało przejrzysty.
Nie tworzymy nagłówków przez pogrubienie (np. '''Nagłówek''')
Gdzie tylko można korzystamy z kodu wiki. Jeśli nie będziemy nadużywać HTML-a, kod będzie przejrzysty i łatwiej będzie go edytować innym.
Nie tworzymy akapitów za pomocą znacznika <p>. W szczególności nie justujemy tekstu akapitu za pomocą <p align="justify">. Każdy użytkownik może indywidualnie włączyć lub wyłączyć justowanie akapitów w swoich preferencjach.
Nie tworzymy "ręcznie" list numerowanych:

1. Raz<br />
2. Dwa<br />
3. Trzy<br />

Zamiast tego używamy wikikodu:

# Raz
# Dwa
# Trzy

Treść

Pora wpisać do podręcznika treść. Nie musisz od razu rzucać się na głęboką wodę – dobrym pomysłem jest napisanie spisu treści, dobrego i kompletnego wstępu lub pierwszego rozdziału. Kolejni czytelnicy lub edytorzy będą widzieli, że podchodzisz poważnie do tematu i większe jest prawdopodobieństwo, że wrócą do Twojej książki. Spis treści pokaże innym chętnym, co mają robić, gdyby chcieli pomóc w rozwoju podręcznika.

Na początku można wstawić kilka linków do naszego siostrzanego projektu, Wikipedii – szczególnie, jeśli ma hasło poświęcone tematowi. Jednak dopisz coś od siebie i nie przepisuj treści z Wikipedii – to niepotrzebne, bo czytelnik może odwiedzić link by przeczytać to samo, a z drugiej strony książka, która składa się z dwóch zdań i kilku linków do Wikipedii sprawia fatalne wrażenie. Nie idź więc na łatwiznę i jeśli zdecydowałeś się stworzyć nową książkę, daj próbkę swoich możliwości. Pamiętaj, że na Wikibooks nie wolno wklejać tekstów objętych prawem autorskim. Jeśli znajdziesz tekst, który chcesz skopiować lub przetłumaczyć, ale nie ma wyraźnej informacji o licencji pozwalającej na skorzystanie z niego na Wikibooks – uważaj. Nie możesz ich tłumaczyć "wprost" i kopiować, lecz dobre opracowanie jako część większej całości pasuje idealnie. Bez ograniczeń ożesz natomiast wykorzystać ciekawe i rozbudowane artykuły z Wikipedii. W obu przypadkach pamiętaj o podaniu źródeł.

Możesz przeszukać zasoby anglojęzycznych Wikibooks oraz pozostałe. Jeśli znajdziesz taką samą książkę w języku obcym, wstaw link do niego (tzw. interwiki) – robi się to umieszczając zwyczajowo na końcu strony kod [[en:Philosophy]] – jeśli przykładowo znaleźliśmy podręcznik do filozofii. Linki interwiki wstawiamy tylko na stronie głównej książki.

Pamiętaj o zachowaniu neutralnego punktu widzenia i opieraniu się na wiarygodnych źródłach.

Nagłówki

Aby podzielić tekst na części użyj nagłówków:

== Nagłówek 2 ==

=== Nagłówek 3 ===

==== Nagłówek 4 ====

Nie rób zbyt dużo nagłówków, gdyż artykuł może się stać mało przejrzysty

Uwaga: Nagłówek pierwszego poziomu (= Nagłówek 1 =) nie powinien być stosowany. Funkcje nagłówka 1. poziomu spełnia tytuł modułu (widoczny na górze strony).

Ozdobniki i komunikaty

Może okazać się, że będziesz potrzebował zostawić jakieś komunikaty – na przykład, że w danym miejscu powinien znajdować się obrazek – lub po prostu zechcesz umieścić w tekście jakiś ozdobnik. Zajrzyj na Wikibooks:Szablony, gdzie znajdziesz listę gotowych do wstawienia elementów. Pamiętaj jednocześnie, że do umieszczania uwag o tekście służy strona dyskusji.

Nawigacja

Aby ułatwić poruszanie się do przodu i wstecz między rozdziałami, można wstawić na strony jeden z szablonów nawigacyjnych.

Grafika

Na Wikibooks można umieszczać grafikę. Jeśli chcesz dowiedzieć się więcej, przeczytaj Wikibooks:Ilustracja Wikibooks.

Materiały z Wikipedii

Na Wikibooks można dowolnie używać materiałów z Wikipedii, ale należy w opisie zmian (krótkim polu pod polem edycji) podać źródło (z jakiego hasła wzięliśmy tekst). Podobnie można używać materiałów ze stron i publikacji na licencji GFDL, ale zawsze konieczne jest podanie źródła.

Spis treści

Na stronie ze spisem treści oprócz listy rozdziałów możemy umieścić linki do pokrewnych podręczników oraz stron organizacyjnych danego podręcznika. Jeśli książka ma okładkę, powinien być także dostępny link do niej.

Przykłady spisów treści:

IRC (podręcznik z okładką)
Piwowarstwo domowe (podręcznik bez okładki)

Okładka

Okładka podręcznika powinna zawierać:

odnośnik do spisu treści
linki interwiki i kategorię (nie powinny być na stronie ze spisem treści)
opcjonalnie grafikę lub zdjęcie związane tematycznie z książką
opcjonalnie link do głównej strony dyskusji podręcznika
link do wersji do druku (o ile istnieje)
ewentualne krótkie wprowadzenie do podręcznika, informacje o postępie prac

Księgozbiór

Aby dodać podręcznik do księgozbioru przechodzimy do niego, wybieramy odpowiedni dział (ułatwi nam to spis treści na samej górze) i klikamy na niego edytuj. Dodajemy podręcznik w odpowiednie miejsce, pamiętając o kolejności alfabetycznej pisząc:

jeśli mamy okładkę

: [[Nazwa podręcznika/Okładka|Nazwa podręcznika]] {{kompletność krótka|00%|01.12.2024}}

lub jeśli jej nie mamy

: [[Nazwa podręcznika]] {{kompletność krótka|00%|01.12.2024}}

Korzystaj ze strony dyskusji

Na temat każdej strony można rozpocząć dyskusję, klikając na zakładkę powyżej jej tytułu i zaczynając ją jak każdy artykuł. Dyskusja może Ci się przydać do wstawienia notatek i uwag odnośnie tekstu, a także wytycznych dla przyszłych edytorów. Sam tekst artykułu nie powinien służyć do wstawiania swoich uwag, ewentualnie można w treści artykułu zaznaczyć rzeczy do zrobienia (szablon {{TODO}}).

Dobrze jest utworzyć dla podręcznika jedną, centralną stronę dyskusji, gdzie będą dyskutowane kwestie istotne dla całego podręcznika.

Kategoria

Kategorie na Wikibooks mają nieco inne użycie niż na Wikipedii. Na Wikipedii każda strona znajduje się w jakiejś kategorii; na Wikibooks to podręczniki są podstawowymi jednostkami i tylko stronę główną podręcznika (okładkę, a wobec jej braku spis treści) umieszcza się w określonej kategorii. Podręcznik dopasujesz do odpowiedniej kategorii, przeglądając Kategoria:Podręczniki według tematu.

Wykaz ważnych stron "technicznych", "administracyjnych" i ogólnej natury znajdziesz w kategorii: Metastrony Wikibooks.

Błędnym postępowaniem jest także tworzenie podkategorii dla podręczników językowych. Dlatego też, np. podręcznik do języka niemieckiego powinien znajdować się tylko w kategorii "Języki". Nie należy więc wstawiać w modułach tego podręcznika kategorii "Język niemiecki" i ją osobno tworzyć. Podobnie nie powinno się tworzyć oddzielnych podkategorii "Język portugalski", "Język rumuński" itp.

Wstawiając komendę [[Kategoria:...]], na okładce należy ją obudować komendą "noinclude", np.

<noinclude>
[[Kategoria:Języki]]
</noinclude>

Dzięki temu unikniemy problemów z tworzeniem wersji do druku.

Skróty

Przeglądając Wikibooks, często napotkasz na skróty, które pojawiają się w ramce, w prawym, górnym rogu strony. Są to po prostu oznaczenia często używanych i odwiedzanych stron, ważnych dla społeczności autorów podręczników. Ich wykaz znajdziesz na stronie Wikibooks:Skróty.

Zwyczajowo tworzone strony

Spis treści

Podręcznik wielomodułowy na swej głównej stronie (np. "Angielski, Mikrobiologia) powinien mieć umieszczony spis treści (np. Mikrobiologia). Na stronie ze spisem treści oprócz listy rozdziałów możemy umieścić linki do pokrewnych podręczników oraz stron organizacyjnych danego podręcznika. Poza tym zamieszczamy nazwę kategorii, pod którą można znaleźć podręcznik: [[Kategoria:...]].

Przykłady spisów treści:

Informacje o podręczniku i autorach

Jeśli przy podręczniku pracuje kilka osób lub wykorzystywane są w nim źródła zewnętrzne, dobrze jest stworzyć stronę informacyjną podręcznika. Nazywamy ją Nazwa podręcznika/O podręczniku. Na stronie takiej wydzielamy zazwyczaj dwie sekcje.

Pierwsza z nich wymienia osoby, które wniosły znaczny wkład w rozwój podręcznika. Wystarczy, że będą to linki do stron Wikipedystów, nie przedstawiamy się w wykazie autorów, takie informacje należy umieścić na swojej stronie użytkownika.

Druga sekcja, zatytułowana "Źródła" lub "Bibliografia", powinna zawierać listę książek, z których korzystaliśmy przy pisaniu podręcznika i odnośniki do stron internetowych, których treść wykorzystaliśmy. Jest to odpowiednie miejsce na napisanie o licencjach tekstów źródłowych – jeśli korzystamy np. z tekstu na licencji GNU FDL, to licencja nakłada na nas obowiązek poinformowania o oryginale i o tym, że jest na licencji GFDL.

Przykłady:

Indeks

Jeśli w podręczniku pojawia się wiele definicji różnych terminów, warto dla ułatwienia życia czytelnikom stworzyć indeks, zbierający najważniejsze z pojęć i linkujący do rozdziałów, które je objaśniają. Dodatkową zaletą tworzenia indeksu jest potencjalne zwiększenie rankingu w wyszukiwarkach. Przykład indeksu (niebędący jednak wzorem) można znaleźć w C/Indeks.

Wytyczne dla innych autorów

Wikibooks to miejsce, gdzie wspólnie tworzy się podręczniki. Aby inne osoby były w stanie rozwijać podręcznik, warto opracować plan prac. W takim celu dobrze jest stworzyć rozdział Dla autorów lub założyć sekcję w głównej stronie dyskusji podręcznika. Rozdział taki powinien zawierać najważniejsze wytyczne dotyczące stylu, na przykład dla książki o matematyce będzie to ustalenie notacji wzorów. Oprócz tego przydatne jest określenie, co powinien zawierać każdy rozdział podręcznika (gdy gotowy jest szkielet spisu treści).

Przykłady:

Integrowanie podręczników

Niektóre podręczniki pokrywają się pod względem treści. Wówczas oznaczamy je szablonami {{integruj z}} i {{integruj do}}. Lista wszystkich książek (a właściwie tej części, która jest oznaczona szablonem) znajduje się w Kategoria:Artykuły do zintegrowania. Integrując podręczniki powinniśmy zwrócić się o pomoc do administratorów, mogą oni wówczas dokonać integracji historii modułów. Mając do zintegrowania moduł integrowany X i moduł docelowy Y tak, by moduł Y był modułem docelowym, to:

kasujemy moduł docelowy,
przenosimy moduł integrowany do modułu docelowego,
kasujemy moduł docelowy,
odtwarzamy moduł docelowy wraz ze wszystkimi wersjami,
wklejamy do modułu docelowego treść z modułu integrowanego,
likwidujemy przekierowania modułu integrowanego i go kasujemy, tak by nie pozostały zbędne "linkujące" i puste linki.

Po zakończeniu pracy

Koniec pracy nad stroną nie jest finałem procedury dodawania nowej książki. Czeka Cię jeszcze kilka prostych czynności.

Dopisanie do księgozbioru

Aby książka była widoczna dla innych użytkowników, należy ją dodać w odpowiednie miejsce na stronie Wikibooks:Księgozbiór.

Ikony kompletności

W Księgozbiorze zaznaczamy, jaki jest etap prac nad daną książką. Zobacz szczegóły w Wikibooks:Etapy rozwoju książek.

Jeśli chcesz, możesz umieszczać ikonki kompletności przy poszczególnych działach swojego Wikibooks (tak jak tutaj: Lawiny) – rozważ tylko, czy nie zmniejszy to przejrzystości.

Wersja dla druku

Możesz też pomyśleć na samym początku o wersji przeznaczonej dla druku, jeśli uważasz, że czytelnicy będą chcieli drukować twój podręcznik. Zobacz na Wikibooks:Podręczniki do druku, aby przeczytać, jak to zrobić.

Obserwowanie

Trudno jest dodać cały podręcznik do swojej listy obserwowanych. Na Wikibooks bardziej od tej listy przydaje się funkcja Zmiany w dolinkowanych (w ramce poniżej pola z wyszukiwaniem). Używając jej na stronie ze spisem treści podręcznika, można zobaczyć listę wszystkich zmian w stronach dolinkowanych ze spisu treści.

Powrót do Pomocy Wikibooks

Koniec