--=REKLAMA=--

Pomoc

Tworzenie poradników

Z Joomla!WikiPL

(Przekierowano z Joomla!WikiPL:Tworzenie poradników)

Jeśli masz zamiar stworzyć nowy poradnik, trafiłeś w odpowiednie miejsce! Dowiesz się tutaj, jak skonstruować podręcznik łatwy w utrzymaniu i poszerzaniu oraz poznasz kilka zasad, jakimi się tutaj kierujemy.

Co to jest poradnik?

Poradnikiem nazywamy instrukcję wykonywania zadań - prostych lub złożonych. Poradnik może być niewielkim artykułem albo rozbudowaną książką, złożoną z wielu rozdziałów i podrozdziałów.

Przed rozpoczęciem pracy

  1. Przeszukaj Joomla!WikiPL - być może podręcznik, który chcesz napisać, już istnieje albo wystarczy poszerzyć istniejący,
  2. Zastanów się, co i jak chcesz napisać. Gdy nie masz pewności co do kształtu tekstu, który chcesz stworzyć, użyj strony Brudnopis zamiast eksperymentować na nowym artykule.
  3. Jeśli tego jeszcze nie zrobiłeś, zajrzyj na strony Czym jest i czym nie jest Joomla!WikiPL oraz Dlaczego nie pisać na Joomla!WikiPL, aby upewnić się, że dobrze rozumiesz ideę Joomla!WikiPL.
  4. Zobacz, jak zostały zrobione podręczniki na Joomla!WikiPL o podobnej tematyce. Jeśli podpatrzysz w nich dobre rozwiązania, oszczędzi ci to pracy.

Nazewnictwo

Każdy poradnik powinien mieć możliwie krótką nazwę - tytuł, który prosto i ściśle określa jego zawartość.

Gdy tworzymy poradnik z rozdziałami, ich tytuły dopisujemy do tytułu poradnika. Przykładowo, mamy podręcznik Forum Kunena i planujemy dodać rozdział Instalacja. Nowy artykuł powinien nosić nazwę Forum Kunena/Instalacja - tytuł poradnika i rozdziału są oddzielone ukośnikiem (bez spacji).

Szczegółowe zasady tytułowania artykułów i poradników znajdziesz w oprcowaniu Nazewnictwo artykułów.

Konstrukcja

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ć. Jednym z pierwszych kroków twórcy nowego podręcznika powinno być umieszczenie w głównym artykule (w naszym przypadku będzie to Forum Kunena) spisu treści. Jeśli planujesz poradnik złożony z wielu artykułów (stron), możesz założyć odrębną stronę spisu treści, np. Forum Kunena/Spis 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ć.

Oczywiście spis treści można w każdej chwili zmienić, ale gdy prace są zaawansowane, nie jest już to takie łatwe.

Główna strona poradnika

Na stronie głównej poradnika możesz w zależności od upodobań umieścić

  • zawartość podręcznika lub też
  • okładkę albo
  • spis treści.

Przykłady.................... .

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.

Pamiętaj, że na Joomla!WikiPL 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 Joomla!WikiPL - wstrzymaj się.

Jeśli znalazłeś ciekawy i rozbudowany artykuł na http://docs.joomla.org, który chciałbyś przerobić we własnej książce nie przepisuj jego treści - poproś administratora o import strony na Joomla!WikiPL - pamiętaj, że używając treści GNU FDL lub JEDL zobowiązany jesteś podać źródło i jego autorów.

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


Zwyczajowo tworzone strony

Okładka i spis treści

Podręcznik wielomodułowy na swej głównej stronie (np. "Pierwsze kroki z Joomla, Poradnik administratora Joomla!) powinien mieć umieszczony spis treści (np. Poradnik administratora Joomla!). Ozdobną stronę tytułową (nazywaną na Joomla!WikiPL "okładką") możemy wykonać na osobnej stronie.

Okładka

  1. tworzymy stronę Poradnik/Okładka i linkujemy do Poradnik
  2. tworzymy spis treści w Poradnik
  3. linki w księgozbiorze itp. prowadzą do strony Poradnik/Okładka

Okładka podręcznika powinna zawierać:

  • odnośnik do spisu treści
  • nazwę pierwszego autora i współtwórców
  • nazwę tłumacza i wspomagających tłumaczenie
  • kategorie (nie powinny być umieszczane na stronie ze spisem treści)
  • opcjonalnie grafikę lub zdjęcie związane tematycznie z poradnikiem
  • opcjonalnie link do głównej strony dyskusji poradnika
  • link do wersji do druku (o ile istnieje)
  • ewentualne krótkie wprowadzenie do podręcznika, informacje o postępie prac

Przykłady stron tytułowych:

Jeśli poradnik ma osobno spis treści i okładkę, strona dyskusji okładki powinna przekierowywać do strony dyskusji spisu treści.

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ć dostępny link do niej.

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 poradnika/O poradniku. 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 użytkownikow (joomlariuszy), 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 (nie będący jednak wzorem) można znaleźć:

  • [[ |Indeks]]

Wytyczne dla innych autorów

WikiJoomlaPL 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. Oprócz tego przydatne jest określenie, co powinien zawierać każdy rozdział podręcznika (gdy gotowy jest szkielet spisu treści).

Przykład:


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 Joomla!WikiPL: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 Joomla!WikiPL można umieszczać grafikę. Jeśli chcesz dowiedzieć się więcej, przeczytaj Ilustrowanie Joomla!WikiPL.

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

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ć do księgozbioru.

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%|21.01.2019}}
  • lub jeśli jej nie mamy
: [[Nazwa podręcznika]] {{kompletność krótka|00%|21.01.2019}}


Ikony kompletności

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

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

Umieszczenie na liście nowych podręczników

Jeśli tworzysz zupełnie nową książkę, możesz ją umieścić w widocznym na stronie głównej szablonie Nowe podręczniki.

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 Joomla!WikiPL:Podręczniki do druku aby przeczytać, jak to zrobić.

Obserwowanie

Ciężko jest dodać cały podręcznik do swojej listy obserwowanych. Na Joomla!WikiPL 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.

Promocja poradnika

Dobrze jest dodać link na stronie ????? Joomla!WikiPL, używając szablonu {{Joomla!WikiPL|Nazwa podręcznika|Nazwa podręcznika}}. Nic nie stoi na przeszkodzie, by zgłosić poradnik (o ile jest dobry) do internetowych katalogów.

Zobacz też