Instrukcja korzystania z portletu Seminaria Krzysztof Rutkowski nr albumu: 219828 Toruń 2010 1
Spis treści Wstęp... 3 1.Czym jest portlet Seminaria... 3 2.Wymagania...3 Tryb przeglądania... 4 1.Wygląd strony głównej... 4 2.Archiwum seminariów... 5 Tryb administracyjny... 6 1.Ogólne informacje... 6 2.Zapowiedzi seminariów... 7 3.Archiwum seminariów... 13 4.Seminaria stałe... 14 5.Baza wykładowców... 17 6.Powiadamianie przez email...20 2
Wstęp 1. Czym jest portlet Seminaria Portlet Seminaria jest wtyczką do systemu zarządzania tręścią Liferay Portal, o który opiera si ę witryna internetowa Wydziału Matematyki i Informatyki UMK. Zadaniem tej wtyczki jest prezentowanie aktualnych informacji o seminariach odbywających się na WMiI, a dla osób z odpowiednio wysokimi uprawnieniami (m.in. wykładowców) dostarczenie wygodnego systemu do zarządzania bazą seminariów. 2. Wymagania Do poprawnej obsługi portletu Seminaria wystarczy przeglądarka internetowa obs ługująca następujące standardy: XHTML 1.0 Transitional CSS 2.0 (zalecany 3.0, lecz nie wymagany) JavaScript Ostatnia pozycja nie jest obowiązkowa, jednak bez włączonej obsługi JavaScript nie jest możliwe (bądź jest ograniczone) korzystanie z niektórych dynamicznych elementów aplikacji, takich jak walidacja formularzy bez komunikacji z serwerem, automatyczne przekierowanie do poprzedniej strony po pomyślnym zapisaniu zmian, czy efekt przewijania strony). W praktyce, jeśli przeglądarka radzi sobie z wyświetlaniem witryny WMiI, z pewnością poradzi sobie z poprawnym wyświetleniem portletu Seminaria. 3
Tryb przeglądania 1. Wygląd strony głównej Główną stroną portletu Seminaria jest strona prezentująca aktualne zapowiedzi seminariów (od początku bieżącego tygodnia): U góry strony znajduje się główne menu służące do nawigacji pomiędzy podstronami oraz przełączania między trybami (przeglądania, administracji, pomocy patrz niżej). Poniżej tytułu strony widać listę aktualnych zapowiedzi seminariów. Jest ona, dla zwiększenia czytelności, podzielona na sekcje wg dni tygodnia. Pojedyncza informacja zawsze zawiera nazwę seminarium oraz zakres godzin i symbol sali w której się odb ędzie. Mo że te ż zawiera ć szczegóły dot. osoby prowadzącej wykład, tytułu wykładu oraz ewentualnie statusu (odwołany, informacja niepełna, etc). 4
Wygląd menu głównego: W trybie przeglądania dostępne są dwie podstrony: zapowiedzi seminariów i archiwum seminariów. Dodatkowe menu, oznaczone symbolem, pozwala przełączać się między trybami aplikacji. 2. Archiwum seminariów Strona archiwum pozwala przeglądać informacje o seminariach, które odbyły się (lub mia ły si ę odbyć) przed obecnym tygodniem. Zawsze wyświeta informacje o seminariach z jednego, wybranego tygodnia. Wygląd tej strony zasadniczo nie różni się od strony aktualnych zapowiedzi. Jedyną różnicą jest dodatkowe menu pozwalające nawigować między tygodniami, na które składają się linki poprzedni, następny oraz lista wyboru konkretnego tygodnia. 5
Tryb administracyjny 1. Ogólne informacje Ten tryb jest znacznie bardziej rozbudowany od trybu przeglądania. Każda strona posiada podstrony (formularze dodawania, edycji). Struktura drzewa stron ma następującą postać: Zapowiedzi seminariów Nowa zapowiedź Archiwum seminariów Nowa archiwalna zapowiedź Seminaria stałe Nowe seminarium stałe Baza wykładowców Dodaj wykładowcę Powiadamianie przez email Wyślij informacje Lista subskrybentów Dostęp do poszczególnych stron zależy od posiadanych uprawnień. W kolejnych rozdziałach zostały opisane wszystkie strony trybu administracyjnego. 6
2. Zapowiedzi seminariów Strona Zapowiedzi seminariów jest domyślną stroną panelu administracyjnego. Służy do zarządzania informacjami o zaplanowanych wykładach. Jak widać na powyższym zrzucie, strona wygląda podobnie do analogicznej strony trybu przeglądania. Nowością jest breadcrumb ułatwiający nawigację pomiędzy stronami umieszczony tuż pod głównym menu. Wygląd samej listy seminariów zosta ł natomiast wzbogacony o przyciski pozwalające edytować lub usuwać wybrane zapowiedzi. 7
Kliknięcie na przycisk 'X' przy zapowiedzi spowoduje usunięcie seminarium oraz wy świetlenie komunikatu jak na poniższym zrzucie: Aby dodać nową zapowiedź, należy przejść do podstrony odpowiedniej podstrony, wybierając z menu Zapowiedzi seminariów Nowa zapowiedź, tak jak, na poniższym screenie: 8
Pojawi się wtedy pusty formularz edycji zapowiedzi: Powyższy formularz pozwala na edycję następujących informacji o seminarium: wybór nazwy seminarium z listy lub wpisanie własnej ustawienie jednego z dostępnych statusów wpisanie tytułu wykładu oraz określenie, która to część (wybór jednej wartości z listy) wybór daty wykładu, godziny oraz sali 9
określenie wykładowcy (jedna z dwóch możliwości): wybranie z listy dostępnych wykładowców (wykładowcy znajdujący się w bazie) zignorowanie listy wyboru i wpisanie danych wykładowcy poniżej (zaznaczenie pola dodaj wykładowcę do bazy spowoduje, że zostanie zapamiętany w bazie danych wykładowców oraz przypisany do określonego seminarium. Pola oznaczone gwiazdką są obowiązkowe. Ponadto przed wysłaniem pola formularza są walidowane. W przypadku niewłaściwego wypełnienia formularza wyświetli się komunikat o błędzie oraz wskazówki przy błędnie wypełnionych polach, tak ja na screenie: 10
Po poprawnym wypełnieniu i wysłaniu formularza, nowa zapowiedź zostanie dodana i pojawi się komunikat o powodzeniu operacji: W treści komunikatu znajduje się link do strony nadrzędnej, czyli w tym wypadku Zapowiedzi seminariów oraz licznik sekund. Po osiągnieciu wartości 0 przez licznik, następuje przekierowanie do w.w. strony, na której pojawi się właśnie utworzona zapowiedź. 11
Aby wyedytować zapowiedź należy kliknąć na przycisk 'X' obok wybranej zapowiedzi na stronie Zapowiedzi seminariów. Pojawi się wtedy podstrona zawierająca identyczny formularz jak przy dodawaniu zapowiedzi, tylko wypełniony. Powiadamianie o błędach walidacji oraz o powodzeniu aktualizacji przebiega w identyczny sposób, jak w przypadku dodawania zapowiedzi. 12
3. Archiwum seminariów Strona Archiwum seminariów jest przeznaczona do zarządzania informacjami o seminariach z poprzednich tygodni. Nie różni się ona znacznie wyglądem od strony Zapowiedzi seminariów. Jedyną różnicą jest pasek nawigacyjny, taki jak na stronie archiwum trybu przeglądania. Aby dodać archiwalną zapowiedź należy Archiwum seminariów Nowa archiwalna zapowiedź: wybrać z menu głównego Dodawanie, edycja oraz usuwanie przebiega w taki sam sposób, jak na stronie Zapowiedzi seminariów (patrz poprzedni rozdział). 13
4. Seminaria stałe Strona Seminaria stałe pozwala zarządzać seminariami odbywającymi się regularnie (co tydzień). Dzięki temu można raz utworzyć stałe seminarium, a zapowiedzi b ęd ą dodawane automatycznie. Jak widać na powyższym screenie strona prezentuje listę sta łych seminariów z podstawowymi informacjami, takimi jak dzień tygodnia, oznaczenie sali oraz godziny, w których odbywają się wykłady. Do edycji i usuwania seminariów służą, tak jak na pozosta łych stronach, przyciski 'X' i 'X'. Aby dodać nowe seminarium stałe Seminaria stałe Nowe seminarium stałe. należy wybrać z menu głównego 14
Formularz dodawania seminarium stałego wygląda jak na poniższym screenie: Możliwa jest edycja następujących informacji: nazwa seminarium dzień tygodnia, w którym odbywają się wykłady możliwy jest wybór konkretnego dnia (poniedziałek piątek) lub wartości nieregularne, taki wybór sprawi, że zapowiedzi dla tego seminarium nie będą dodawane automatycznie godziny rozpoczęcia i zakończenia wykładów symbol sali na której odbywają się wykłady Pola formularza są oczywiście walidowane. Wszystkie litery w nazwie seminarium są automatycznie zamieniane na wielkie. 15
Po zaakceptowaniu poprawnie wypełnionego formularza ukaże się komunikat o powodzeniu operacji: Tak jak w innych podstronach dodawania lub edycji, po wyczerpaniu licznika sekund nast ąpi przeniesienie do strony nadrzędnej tutaj do strony Seminaria stałe. Korzystanie z formularza edycji stałego seminarium przebiega dokładnie tak samo. 16
5. Baza wykładowców Strona Baza wykładowców służy do administrowania danymi wykładowców oraz przypisywania wykładowcom prowadzonych przez nich seminariów. Strona Baza wykładowców przedstawia listę wszystkich wykładowców znajdujących się w bazie danych. Dodawanie, edycja, usuwanie wpisów odbywa się w taki sam sposób jak w przypadku innych stron. Aby przejść do strony dodawania nowego wykładowcy, należy wybrać z menu głównego pozycję Baza wykładowców Dodaj wykładowcę. 17
Strona dodawania wykładowcy wygląda następująco: Formularz pozwala edytować następujące informacje o wykładowcy: imię i nazwisko adres email wybór prowadzonych seminariów wydział, nazwa uczelni oraz kraj, gdzie pracuje wykładowca 18
Wysłanie poprawnie wypełnionego formularza spowoduje dodanie wykładowcy do bazy oraz wyświetlenie komunikatu jak na poniższym screenie i przekierowanie do strony z listą wykładowców. Edycja istniejącego wykładowcy przebiega w taki sam sposób. 19
6. Powiadamianie przez email Strona Powiadamianie przez email jest przeznaczona do wysyłania informacji o odbywających się seminariach do wybranych, wcześniej zdefiniowanych subskrybentów. Pozwala to administratorom w łatwy sposób informować użytkowników o aktualnych planach seminariów na WMiI. Formularz znajdujący się na tej stronie pozwala wybrać dowolną ilość adresatów (spośród zdefiniowanych zapisanych w bazie subskrybentów) oraz tydzień, dla którego plan ma być wysłany (poprzedni, bierzący lub następny). 20
Jeśli wysłanie wiadomości się powiedzie, użytkownik zostanie o tym poinformowany komunikatem: Do zarządzania subskrybentami służy strona Lista subskrybentów, dostępna przez menu Powiadamianie przez email Lista subskrybentów: 21
Strona Lista subskrybentów wygląda następująco: Przyciski znajdujące się przy wpisach na liście pełnią takie same funkcje, jak na innych stronach. Pod listą zostały umieszczone dwa dodatkowe przyciski: Usuń zaznaczone do usuwania wszystkich zaznaczonych wpisów Dodaj nowego pozwala dodać nowego subskrybenta do listy Aby dodać nowego subskrybenta można posłużyć się wyżej wspomnianym przyciskiem lub wybrać z menu Powiadamianie przez email Lista subskrybentów Nowy subskrybent. Spowoduje to przekierowanie do strony dodawania subskrybenta. 22
Na stronie dodawania subskrybena znajduje się pusty formularz pozwalający zdefiniować nowego odbiorcę informacji o seminariach. Po wysłaniu prawidłowo wypełnionego formularza, nowy subskrybent zostanie dodany do bazy, a użytkownik zostanie o tym poinformowany stosownym komunikatem. Po kilku sekundach nastąpi przekierowanie do strony Lista subskrybentów. Formularz na stronie edycji istniejącego subskrybenta nie różni si ę od formularza dodawania nowego. 23