XWAAD01 Kreator materiałów¶

Author:	dr inż. Piotr Czaja
Date:	2018.05.02
Version:	1.0.0
Contact:	piotr.czaja@pwr.edu.pl
Address:	http://ftp.ovzo.net/materialy/dydaktyka20180518/
Status:	stable
Keywords:	katalogi wiedzy, kreator materiałów
Abstract:	Opis założeń projektowych, obsługi i wykorzystania programu do generowania materiałów dydaktycznych z modułów katalogów wiedzy

Generowanie materiałów¶

Procedura generowania materiałów

Prowadzenie statystyk odwiedzin strony www z materiałami umożliwia:

śledzenie statystyk odwiedzin/pobrań
wnioskowanie o popularności poszczególnych materiałów (modułów)
wstępne wnioskowanie o podziale modułu na mniejsze jednostki (jeśli dla wybranych modułów zanotowano szczególnie wysokie ilości odwiedzin i czasu ich wyświetlania)

Jedynym mechanizmem umożliwiającym określenie grupy docelowej jest login/hasło nadawane poszczególnym grupom zajęciowym (lub dla całego kursu).

Uwzględnienie grup docelowych nadaje kontekst dla statystyk odwiedzin, co pozwala np. na:

W przypadku niskich ocen z zaliczenia sprawdzić czy studenci zapoznali się z materiałami oraz jak intensywna była ich nauka (ile czasu spędzili na stronie)
W przypadku niższej frekwencji na zajęciach ocenę czy wynika to z łatwości materiału (studenci zapoznali się wcześniej z treścią) czy innych przyczyn

Ułatwienie dostępu (możliwość oglądania online na dowolnej współczesnej przeglądarce internetowej)
Możliwość dostosowania do urządzeń z małym ekranem (np. telefon) przy zachowaniu czytelności treści
Zachowanie opcji eksportu do innych formatów dokumentów (poza HTML): np. PDF lub ebook-ów
Łatwe drukowanie wybranych treści (pojedynczych modułów)
Dostępność online zawsze ostatniej, najbardziej aktualnej wersji
Po wydrukowaniu dzięki temu, że każdy moduł jest dokładnie opisany (nagłówek) czytelnik może stwierdzić czy posługuję się ostatnią wersją dokumentu.
Łatwość tworzenia indeksu tematycznego po słowach kluczowych (przy długich materiałach indeksy stanowią przydatną alternatywę dla głównego spisu treści)
Wbudowany mechanizm wyszukiwania pełnotekstowego

Elastyczność wyświetlania treści utrudnia dostosowanie do zaleceń logotypu PWr
Utrudniona narracja w treści z powodu tych samych źródeł dla prezentacji i materiałów

Fragment pliku main.ini

Plik main.ini jest głównym plikiem konfiguracyjnym i zawiera:

lokalne położenie katalogów wiedzy
wersję: wykład/laboratorium/seminarium/… dla uwzględnienia wariantów kompilacji dla poszczególnych form materiałów
nazwę/tytuł kursu lub wystąpienia przy materiałach nieseryjnych
definicję czy materiał jest cykliczny dla uwzględnienia tego w generowanych spisach treści
komentarz umieszczany na stronie głównej materiałów
strukturę wystąpień [materiał -> termin -> punkt (moduł)] wraz z określeniem kolejności
ścieżki do dodatkowych bibliotek potrzebnych do renderowania materiałów na stronie www

Generowanie głównego indeksu dokumentu (index.rst) na podstawie plików konfiguracyjnych.

Linkowanie symboliczne do źródeł modułów w taki sposób aby wszystkie źródła znajdowały się w jednym katalogu (techniczne ograniczenie Sphinx-a).

Standardowe polecenie Sphinxa generujące dokument w formacie HTML.

Po skonfigurowaniu pliku conf.py i zmodyfikowaniu wyglądu finalnego (theme.css) utworzy cały dokument.

Polecenie do kopiowania materiłów na serwer (synchronizacja przy pomocy rsync).