--=REKLAMA=--

Poradnik twórcy ekranów pomocy dla Joomla 3.x

Z Joomla!WikiPL

Wersja Zwiastun (dyskusja | edycje) z dnia 10:08, 3 cze 2018

(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)

O tym poradniku

Zapoznaj się z tym poradnikiem, jeśli chcesz pomagać w rozwijaniu i utrzymaniu pomocy ekranowej dla Joomla. Poradnik opisuje sekcje, jakie powinny się znaleźć w artykułach systemu pomocy nazywanych ekranami pomocy, oraz podpowiada, tworzyć zawartość systemu pomocy. Jeśli masz pomysły, sugestie, możesz poprawiać ten poradnik lub zgłosić je na stronie dyskusji.

Zawartość ekrnów pomocy

Streszczenie

Każdy ekran pownien rozpoczynać się od streszczenia. Objaśnij w nim zwięźle cel - przeznaczenie ekranu. Streszczenie jest używane w zestawieniach pomocy na całym wiki. NIe umieszczaj nagłówka Streszczenie.

Jak uzyskać dostęp

Poniżej streszczenia, w sekcji Jak uzyskać dostęp wskaż lokalizację opisywanego ekranu zaplecza Joomla. Przedstaw kroki, jakie trzeba wykonać, aby dotrzeć do ekranu z różnych miejsc zaplecza.

Pamiętaj, że ekrany pomocy można pobrać na wiele różnych sposobów, nie tylko podczas wykonywania czynności administracyjnych na zapleczu. Na przykład ktoś korzystajacy z wyszukiwarki Google, aby dowiedzieć się, jak coś zrobić, trafi na ekran pomocy na wiki, a nie na zapleczu Joomla.

Pamiętaj również, że dostęp mogą chcieć uzyskać osoby z różnymi niepełnosprawnościami, które np. nie widzą albo nie używają myszki.

  • Staraj się więc wskazywać położenie ekranów, a także położenie różnych elementów na ekranach określeniami odwołującymi się do ich miejsca w strukturze zaplecza i w strukturze ekranów zaplecza.
  • Unikaj zwrotów adresowanych na przykład tylko dla osób widzących ekran ('po lewej stronie', 'na górze po prawej stronie', 'zielona ikona', itp.) albo kierowanych tylko do osób, które posługują się myszką ('kliknij ikonę', 'ustaw wskaźnik myszki nad...').
  • Jeśli to możliwe wskazuj alternatywne sposoby dostępu do opisywanej funkcji lub obszaru zaplecza.

Oto przykłady:

  • Wybierz z menu zaplecza Artykuły    Wyróżnione
  • Na stronie pulpitu wybierz ikonę skrótu Utwórz artykuł
Uwagi:
  • Jeśli droga do ekranu prowadzi z innego ekranu, nazwa tego ekranu powinna być linkiem do jego ekranu pomocy.
  • Aby ułatwić budowanie ścieżki, został zdefiniowany szablon strzałki w prawo:   . Aby go użyć, wpisz: {{rarr}}

Zdjęcie ekranu

Zrzut ekranu przedstawiający ogólny wygląd. Niekoniecznie musi przedstawiać całą zawartość

  • Obrazy zrzutów ekranu mogą wprawdzie mieć dowolną szerokość, ale większe obrazy powinny mieć szerokość ograniczoną w źródle do |800px.
  • Nazwa pliku powinna być zgodna z naszymi standardowymi konwencjami nazewnictwa dotyczącymi ekranów pomocy (zobacz poniżej).
  • Instrukcja osadzajaca grafikę powinna także definiować zwięzły opis alternatywny, np.
 np. [[Plik:j35_artykuly-kategorie-dostosuj-kategorie.png|700px|Ekran edytora kategorii artykułów]]
  • Możesz użyć plików .png lub .jpg.

Opis

Przedstaw:

  • z jakim rodzajem ekranu mamy do czynienia ('pulpit', 'menedżer', 'formularz', 'informator').
  • jakie operacje można tutaj wykonać,
  • jakie elementy odróżniają omawiany ekran od innych tego typu.

Nie określamy formatu tej sekcji, ponieważ opis zależy od celu i przeznaczenia ekranu. Opis może zawierać podsekcje.

Wykaz pozycji

Ta sekcja powinna być umieszczana tylko w opisach ekranów, które przedstawiają menedżery, czyli ekrany służące do zarządzania wieloma pozycjami (np. artykułami, kategoriami, modułami, kontaktami).

Poinformuj zwięźle, co zawiera lista pozycji znajdująca się w obszarze roboczym. Zwróć uwagę na elementy nietypowe.

Zilustruj tę sekcję zdjęciem fragmentu listy, np. nagłówka i 2-3 wierszy.

Kolumny tabeli

Objaśnij znaczenie informacji w każdej kolumnie. W opisach wykorzystaj szablony powtarzalnych komunikatów:

Wyszukiwanie, filtry, sortowanie

Przedstaw tu informacje o dostępnych filtrach. Informacje umieść pod śródtytułami nazywającymi opisywany filtr. W opisach wykorzystaj szablony powtarzalnych komunikatów:

Przetwarzanie wsadowe

Jeśli w udostepnianych na stronie narzędziach jest funkcjonalność Przetwarzanie wsadowe, opisz jej możliwości. Zilustruj zrzutem ekranu.

Nawigacja lokalna ...

Poinformuj, dokąd prowadzą łącza w nawigacji lokalnej. Nazwa strony docelowej powinna być łączem do opisującego ją ekranu pomocy. Na przykłąd:

  • Kontakty [Contacts]: odnośnik jest nieaktywny, ponieważ znajdujesz się właśnie na stronie Kontakty.
  • Kategorie [Categories]: przenosi na stronę kategorii kontaktów.

Pola formularzy

Ta sekcja powinna być umieszczana tylko w opisach ekranów, które zawierają formularze służące do tworzenia i poprawiania zawartości oraz konfigurowania ustawień serwisu (np. Konfiguracja globalna) lub poszczególnych rozszerzeń (np. Opcje komponentu Reklamy)

Karty szczegółów (detali)

Dla każdej karty utwórz odrębną sekcję. Zatytułuj ją etykietą (nagłówkiem) karty lub panelu, np. Karta Integracja, Karta Opcje publikacji. Każdą podsekcję rozpocznij od zrzutu ekranu, przedstawiajacego zawartość karty.

Objaśnij znaczenie każdego detalu lub opcji. W opisach wykorzystaj szablony powtarzalnych komunikatów:

Inne typy obszarów

Jeśli pola są pogrupowane w zestawy pól albo na kartach lub panelach rozwijanych, zgrupuj pola pod śródtytułami.

Przybornik

Oczywiście, ta sekcja powinna być umieszczana tylko w opisach ekranów, na których znajduje się przybornik (pasek narzędziowy).

Objaśnij znaczenie przycisków w przyborniku. Napisz prostym zdaniem, co przycisk robi. W opisach wykorzystaj szablony powtarzalnych komunikatów:

Możesz też posłużyć się szablonami zestawów przycisków:

  • {{Porcje35:Przybornik 5 przycisków}}
  • {{Porcje35:Przybornik 6 przycisków}}
  • {{Porcje35:Przybornik edytora Opcje}}

Zobacz pełną listę i generowaną treść: Przyborniki


Porady

Jak wskazuje tytuł, ta sekcja powinna zawierać zwięzłe wskazówki, podpowiedzi, sugestie, które mogą pomóc użytkownikowi w wykonywaniu zadań związanych z ekranem. Użyj listy punktowanej.

  • Porada 1.
  • Porada 2.

Pokrewne tematy pomocy i inne zasoby

Powinna to być lista odnośników do dalszych lub powiązanych informacji. Wszystkie łącza powinny być stronami na tej wiki. Nie umieszczaj żadnych łączy zewnętrznych bez ważnego powodu.

  • Odnośnik 1.
  • Odnośnik 2.

Na końcu utwórz łącze do ekranu pomocy w wersji angielskiej jako dokumentu źródłowego. Posłuż się szablonem:

© Ten materiał jest dokładnym albo swobodnym tłumaczeniem artykułu [[Tu wklej adres dokumentu źródłowego]] udostępnionego na licencji JEDL na witrynie: Joomla! Official Documentation Wiki

Konwencja nazywania plików graficznych

  • Plik:j3x_<sciezka-menu-admina-malymi-literami-oddzielona-myslnikami>-<obszar-strony>-<opisywany-element>.png,jpg
    • Zastąp <sciezka-menu-admina-malymi-literami-oddzielona-myslnikami> nazwami pozycji menu, które należy wybrać, aby uzyskać pozycję, z której robisz zrzut ekranu. Oddziel elementy menu za pomocą myślnika (-) i jeśli nazwa pozycji menu zawiera więcej niż jedno słowo. Oddziel je od pozostałej części nazwy pliku znakiem podkreślenia (_). Nie używaj spacji w nazwie pliku.
    • Zastąp <obszar-strony> nazwą typu obszaru, który zawiera obraz. Typy elementów ekranu to:
      • ekran - to zrzut całego ekranu wybieranego z menu,
      • przybornik - to zrzut pasek narzędzi,
      • menu lokalne - to jest zdjęcie paska menu
      • karta - zdjecie karty na ekranach, na których zawartość umieszczono na kilku kartach
      • filtr - zdjęcie jednego z filtrów

Dziękujemy za wkład

» Stefan Wajda [zwiastun],