W swojej pracy postaraj się stosować do poniższych zaleceń - dzięki temu materiały w naszej bibliotece będą bardziej przejrzyste i spójne pod względem graficznym.
Struktura tekstu
W dłuższych artykułach zawsze można podzielić na mniejsze sekcje i oznaczyć je nagłówkami - tytułami, podkreślającymi strukturę tekstu. Masz do dyspozycji 6 poziomów nagłówków różniących się rozmiarem czcionki i innymi cechami typograficznymi. 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ą.
Aby podzielić tekst na części użyj nagłówków::
Kod nagłówka
|
Rezultat
|
== Nagłówek 2 ==
=== Nagłówek 3 ===
==== Nagłówek 4 ====
===== Nagłówek 5 =====
====== Nagłówek 6 ======
|
Nagłówek 2
Nagłówek 3
Nagłówek 4
Nagłówek 5
Nagłówek 6
|
Sekcje mogą być zagłębione jedna w drugiej i tworzyć strukturę hierarchiczną.
Z tytułów sekcji oprogramowanie tworzy automatycznie spis treści, umieszczany zwykle zaraz nad pierwszą sekcją w dokumencie, gdy na stronie jest więcej niż 2 sekcje tego samego poziomu. Spis można wyłączyć za pomocą magicznego słowa __NOTOC__, albo przenieść na prawą stronę za pomocą polecenia {{SpisPoPrawej}}.
Każdą sekcję można edytować oddzielnie, bez ładowania do okna edycji pozostałej części strony. Wystarczy nacisnąć umieszczony na wysokości danej sekcji po prawej stronie ekranu odnośnik [edytuj].
Nie rób zbyt dużo nagłówków, gdyż artykuł może się stać mało przejrzysty.
Nagłówek pierwszego poziomu (= Nagłówek 1 =) nie powinien być stosowany. Funkcje nagłówka 1. poziomu spełnia tytuł artykułu (widoczny na górze strony.
Wyróżnienia tekstu i wcięcia
Oprogramowanie Wikimedia umyślnie oferuje ograniczone możliwości formatowania tekstu, aby po pierwsze nie komplikować niepotrzebnie kodu, a po drugie zapewnić jednolity, spójny pod względem typograficznym wygląd witryn.
Wyróżnienia
Aby wyróżnić tekst, obejmujemy go grupami dwóch, trzech albo pięciu apostrofów " ' ".
Kod
|
Rezultat
|
''pochylenie''
'''pogrubienie'''
'''''pochylenie i pogrubienie'''''
|
pochylenie
pogrubienie
pochylenie i pogrubienie
|
Wcięcia
Użytecznym sposobem wyróżniania przykładów lub cytatów są wcięcia - odsunięciu tekstu od lewego brzegu ekranu. Realizuje się je przy pomocy znaków dwukropka ":" umiesczonego na początku linii. Dwa i więcej dwukropków powodują powiększenie wcięcia:
Oto przykładowy kod:
- :Pojedyncze wcięcie
- ::Podwójne wcięcie
- :::Potrójne wcięcie
I jego rezultat:
- Pojedyncze wcięcie
- Podwójne wcięcie
- Potrójne wcięcie
Spisy - punktowanie i numerowanie
Spisy zwane też wykazami albo listami, i wszelkie zestawienia ułatwiają przeglądanie stron i pomijanie elementów, które nie interesują internautów. Czynią tekst przejrzystym. Listy mówią użytkownikom, że ich elementy są w jakiejś mierze do siebie podobne, a równocześnie, że każdy jest inny od pozostałych. Elementy list można oznaczać znakami punktowania lub wyliczenia albo- w przypadku list definicji - rozmieszczeniem definiowanego terminu i jego opisu.
Listy tworzymy w oprogramowaniu Wikimedia za pomocą czterech znaków:
- * - gwiazdka na początku linii umieszcza w niej symbol wypunktowania,
- # - krzyżyk (hasz) na początku linii umieszcza w niej kolejny numer
- ; - średnik na początku linii formatuje umieszczony w niej napis jako definiowany termin,
- : - dwukropek na początku linii powoduje jej wcięcie, formatując umieszczony w niej tekst jako definicję.
W jednej liście można użyć i gwiazdek, i krzyżyków, aby zbudować mieszaną listę piętrową. Jeśli na początku linii umieścimy więcej niż jedną gwiazdkę lub krzyżyk, otrzymamy kolejny poziom listy, dzięki czemu można tworzyć piętrowe struktury, np.
Kod
|
Rezultat
|
# pierwszy poziom
## drugi poziom
## drugi poziom
##* trzeci poziom
##* trzeci poziom
##*# czwarty poziom
##*# czwarty poziom
|
- pierwszy poziom
- drugi poziom
- drugi poziom
- trzeci poziom
- trzeci poziom
- czwarty poziom
- czwarty poziom
|
Wyliczenia nie powinny być zbyt długie. Nie sposób jednak sprecyzować, co to znaczy "zbyt długie". Można kierować się np. zasadą "pięć plus minus dwa", zgodnie z którą typowa lista ma "średnio" około 5 elementów, raczej nie mniej niż 3 inie więcej niż 8. Oczywiście, zdarzą się i listy dwupunktowe i 9-punktowe. Gdy ilość elementów zbliża się do "górnej granicy" lub ją przekracza, warto podzielić listę na dwie lub więcej grup, i opatrzyć każdą własnym nagłówkiem oraz zadbać, by lista miała nie więcej niż dwa - trzy poziomy.
W tabelce poniżej można zobaczyć przykłady wszystkich typów list:
Opis
|
Kod
|
Rezultat
|
Lista nienumerowana
|
* jeden
* dwa
* trzy
** trzy i jedna trzecia
** trzy i dwie trzecie
|
- jeden
- dwa
- trzy
- trzy i jedna trzecia
- trzy i dwie trzecie
|
Lista numerowana
|
# jeden
# dwa
# trzy
## trzy i jeden
## trzy i dwa
|
- jeden
- dwa
- trzy
- trzy i jeden
- trzy i dwa
|
Lista mieszana
|
# jeden
# dwa
# trzy
#* trzy i jedna trzecia
#* trzy i dwie trzecie
|
- jeden
- dwa
- trzy
- trzy i jedna trzecia
- trzy i dwie trzecie
|
Definicja
|
;Termin
:wyjaśnienie 1
:wyjaśnienie 2
|
- Termin
- wyjaśnienie 1
- wyjaśnienie 2
|
Spisy treści
U nas można w prosty sposób zarówno utworzyć linki we wszystkich artykułach do strony głównej danej książki, jak i ustalić kolejność artykułów w rozdziałach.
Przykład:
- Jeśli wpiszesz poniższy kod
[[Przykładowy poradnik]]
*Rozdział 1 → [[Przykładowy poradnik:Rozdz. 1 s. 1|1]] - [[Przykładowy poradnik:Rozdz. 1 s. 2|2]] - [[Przykładowy poradnik:Rozdz. 1 s. 3|3]]
*Rozdział 2 → [[Przykładowy poradnik:Rozdz. 2 s. 1|1]] - [[Przykładowy poradnik:Rozdz. 2 s. 2|2]] - [[Przykładowy poradnik:Rozdz. 2 s. 3|3]]
*Rozdział 3 → [[Przykładowy poradnik:Rozdz. 3 s. 1|1]] - [[Przykładowy poradnik:Rozdz. 3 s. 2|2]] - [[Przykładowy poradnik:Rozdz. 3 s. 3|3]]
----
|
- Otrzymasz spis treści jak poniżej
Styl dokumentów
Praca nad dokumentem wchodzącym w skład podręcznika jest zwykle wieloetapowa. Zanim przybierze ostateczny kształt, możliwe jest opublikowanie wersji roboczej. Zarówno w wersji roboczej, jak i ostatecznej stosujemy pewne konwencje zapewniające jednolity styl dokumentów. Zastosuj się do poniższych wskazówek:
Elementy opisu
Stosuj standardowe elementy i nazewnictwo elementów opisu:
- Informacja wstępna: W pierwszych zdaniach poinformuj o podstawowym celu dokumentu lub podstawowych funkcjach, jakie użytkownik realizuje, korzystając z elementu Joomla, któremu poświęcony jest dokument.
- Ikony w przyborniku - możliwe działania: jeśli opisujesz ekran panelu administracyjnego, wypisz dostępne opcje w pasku narzędzi i wskaż funkcję każdej z ikon i odsyłaczy. Pożądane jest zilustrowanie każdego odniesienia do grafiki ikony lub zilustrowanie całego fragmentu zrzutem ekranu zawierającym dostępne ikony.
- Informacje w kolumnach: jeśli opisujesz ekran, na którym znajduje się wykaz elementów w tabeli, wypisz nazwy kolejnych kolumn i opisz zawarte w nich informacje. Jeśli możliwe są jakieś działania na elementach tabeli (np. gdy nazwa elementu jest odnośnikim, gdy kliknięcie w ikonę powoduje zmianę stanu) - opisz to działanie. Pożądane jest zilustrowanie tego fragmentu zrzutem ekranu zawierającym fragment tabeli, wzbogaconym o wskazanie najważniejszych możliwych działań.
- Pola edycji: jeśli opisujesz ekran edycji szczegółów, wypisz nazwy wszystkich elementów i posługując się trybem rozkazującym (czasowniki ’wpisz’, ’określ’, ’ustaw’) poinstruuj użytkownika, w jaki sposób powinien edytować detale informacji. Pożądane jest zilustrowanie tego fragmentu zrzutem lub zrzutami ekranu zawierającymi opisywane elementy, wzbogaconymi o wskazanie istotnych czynności, zwłaszcza odbiegających od typowych dla danego rodzaju formularza.
- Uwagi: Jeśli opatrujesz instrukcję uwagą, ostrzeżeniem, poradą - wyróżnij ten element nagłówkiem (np. Uwaga:, Porada:) i zamieść jej tekst w tym samym lub nowym akapicie.
Ilustracje
Jeśli ilustrujesz dokument, przygotuj zoptymalizowaną grafikę w formacie JPG lub PNG. Szerokość obrazków nie powinna przekraczać 750px. Stosuj w miarę możności standarowe szerokości obrazków: 200 px, 275px, 400 px, 550px.
Akapit czy lista punktowana
Treść ujmuj w krótkie akapity, zgodnie z zasadą "5 plus-minus 2". Innymi słowy 5-6 wierszy w akapicie to w zasadzie górna granica. Oczywiście, jeśli zdarzy się akapit 7-wersowy, to nic złego się nie stanie. Dłuższe akapity podziel w najodpowiedniejszym miejscu na dwa.
Jeśli tylko możliwe jest ujęcie treści w punktach (wszelkie wykazy, opisu kolejnych czynności) - skorzystaj z tej możliwości. Dla użytkownika taki tekst jest czytelniejszy.
W wersji roboczej możesz ująć wykaz w jednnym akapicie, przełamując wiersz po każdym elemencie listy. Szczególnie w przypadkach, gdy pierwszy wyraz wskazuje opcję. Wyróżnij ten pierwszy wyraz czy pierwsze wyrażenie pismem pochyłym lub pogrubionym, np.
- Edytuj [Edit]: Kliknij tę ikonę lub odnośnik, aby...
- Usuń [Remove]: Kliknij tę ikonę lub odnośnik, aby...
Inne konwencje
- Wielkie i małe litery:
- używaj wielkich liter rozpoczynając opis opcji (jak w przykładzie powyżej); jeśli Ci to sprawia trudność, możesz używać - ale konsekwentnie w całym dokumencie - małych liter,
- używaj wielkich liter zawsze, gdy przywołujesz nazwę własną składnika (komponentu, modułu, dodatku), a także ikony, klawisza (np. ’Enter’, ’Anuluj’)
- używaj małych liter, którzy przywołujesz nazwę w potocznym znaczeniu.
- słowa: ’e-mail’, ’webmaster’, ’administrator’, ’główny administrator’, ’witryna’, ’strona WWW’ pisz z zasady małymi literami, chyba, że używasz ich na początku zdania bądź jako ważnych w kontekście opisu nazw własnych,
- słowo ’Internet’ , a także zaimki ’Ty’, ’Ci’, ’Tobie’ pisz zawsze z wielkiej litery.
- Apostrofy i cudzysłowy:
- używaj jako cudzysłowu angielskiego znaku cala,
- nazwy klawiszy, ikon, opcji ujmuj w nawiasy klamrowe (np. [Enter], [Anuluj], [Edycja]); jeśli stosujesz inne wyróżnienie (pogrubienie, pochylenie), nie ujmuj ich ani w cudzysłów, ani apostrof,
- przytoczenia, cytaty, teksty komunikatów ujmuj w znaki cudzysłowu, np. "Nowe elementy zostały zapisane", nie stosuj w takich przypadkach pochyłej czcionki, możesz ująć je w znacznik z klasą stylu "quote" lub "cytat"
- Typowe wyrażenia:
- na działania myszką wskazuj zwrotami: kliknij tę ikonę lub odnośnik, zaznacz pole wyboru;
- na działania klawiatury wskazuj zwrotami naciśnij klawisz, naciśnij klawisze [CTRL+SHIFT],
- wskazując na opcje, ikony, konkretne składniki Joomla! (komponenty, dodatki) używaj polskiego nazewnictwa, ale - przywołując taką nazwę zwłaszcza po raz pierwszy w dokumencie, opatrz ją oryginalnym angielskim odpowiednikiem w nawiasach kwadratowych, np.: Ustawienia globalne [Global Configuration]; możesz zastosować tę zasadę także w stosunku do niektórych komunikatów, jeśli doświadczenie podpowiada Ci, że nie zostaną one najprawdopodobniej spolonizowane.
Pisz dla adresata
/-- dokończyć --/