XWAAB01 Katalogi wiedzy

Author:dr inż. Piotr Czaja
Date:2018.05.04
Version:1.0.0
Contact:piotr.czaja@pwr.edu.pl
Address:http://ftp.ovzo.net/materialy/dydaktyka20180518/
Status:stable
Keywords:katalogi wiedzy
Abstract:Opis zasad tworzenia oraz posługiwania się katalogami wiedzy przy generowaniu prezentacji do zajęć oraz materiałów dydaktycznych.

Podział tematyczny

../../_images/obraz01.png

Zasoby katalogowe

Zalety

  • Ustrukturyzowanie materiału, z podziałem na jednostki o podobnej objętości
  • Oddzielenie treści (zawartości merytorycznej) od warstwy prezentacji
  • Brak przypadkowych powtórzeń treści w kolejnych terminach zajęć
  • W przypadku przypomnienia materiału z wcześniejszych zajęć łatwe włączenie powtarzanych treści do materiałów dydaktycznych
  • Lepsze zarządzanie programem zajęć
  • Poprawienie modułu aktualizuje jego treść we wszystkich materiałach w których został użyty
  • Możliwość opisu zajęć (dość szczegółowego przyporządkowania komentarzy do poszczególnych treści programu zajęć - modułów)
  • Możliwość wielokrotnego wykorzystania modułu w różnych kursach
  • Łatwe tworzenie wariantów kursu poprzez kombinacje różnych modułów z zachowaniem tego co najbardziej istotne w każdym z nich
  • Umożliwia zachowanie informacji o różnych autorach poszczególnych fragmentów zajęć (każdy moduł posiada nagłówek)

Wady

  • Utrudniona narracja w poszczególnych dokumentach (te same źródłą dla prezentacji i materiałów)
  • Format .rst nie pozwala na skomplikowane tabele - trzeba je tworzyć jako rysunki.

Opracowane tematy [2018.04.30]

  • Ekonomia (34 moduły)
  • Eksploatacja (18 modułów)
  • Informatyka (36 modułów)
  • Inne (4 moduły)
  • Matematyka (124 moduły)
  • Organizacyjny (23 moduły)
  • Technika (66 modułów)
  • Zarządzanie (184 moduły)

Razem: 489 modułów

Katalogi wiedzy przechowywane są w centralnych repozytoriach (GIT/GITEA) a ich lokalna kopia trzymana jest na komputerze na których następuje generowanie dokumentów (prezentacje, materiały).

Zawartość modułu

  • Czas trwania podczas prezentacji: 10 - 30 min.

  • Zawartość merytoryczna: autonomiczna jednostka

  • Nagłówek (przykład):

    • Author: Piotr Czaja
    • Date: 2018.05.04
    • Version: 1.0.1
    • Contact: piotr.czaja@pwr.edu.pl
    • Address: logistyka.pwr.wroc.pl
    • Status: stable
    • Keywords: na ich podstawie powstaje skorowidz
    • Abstract: Ogólny opis modułu, miejsce na rezerwację dla konkretnego kursu.

  • Język znaczników użytych w modułach to reStructuredText (tagi tekstu są wersją rozszerzoną reStructuredText zgodnie ze specyfikacją Sphinx-a - system do tworzenia dokumentacji oprogramowania)

  • Wzory matematyczne pisane są zgodnie z notacją LaTeX-a

  • Rysunki stanowią osobne pliki w formacie odczytywanym przez przeglądarkę internetową (Firefox, Brave, …)

  • Proste tabele tworzone są w formacie reStructuredText

  • Złożone tabele wymagają zapisu ich jako rysunek

  • Materiałem wynikowym może być nie tylko dokument HTML lecz również PDF, ebook, dokument latex-a do dalszego składu itp.

  • Gdy zachowamy założenie, że plikami wynikowymi są tylko dokumenty HTML to można róznież stosować tag RAW pozwalający na dodanie dowolnego fragmentu dokumentu zgodnego z tym formatem

Struktura zawartości katalogów

../../_images/obraz02.png

Strona główna katalogu INNE

Podział katalogu (różny dla katalogów):

  • Prezentacje/pokazy
  • Wykłady
  • Instrukcje laboratoryjne
  • Ćwiczenia
  • Zadania projektowe
  • Referaty

Oznaczenie modułu

../../_images/obraz03.png

Lista modułów w katalogu INNE

Każdy z modułów posiada indeks.

Informacje w nazwie modułu

../../_images/obraz04.png

Pozycje indeksu

Indeks
  • Katalog: ekonomia (E), eksploatacja (N), informatyka (I), inne (X), matematyka (M), organizacyjny (Y), technika (T), zarządzanie (Z)
  • Forma: wykład (W), ćwiczenia (C), projekt (P), laboratorium (L)
  • Identyfikator: [A-Z][A-Z][A-Z] - nadawany seryjnie
  • Seria: [1-9] (dla odróżnienia wersji językowej, wersji dla studenta i prowadzącego [z rozwiązaniami], itp.)
  • Wersja: [0-9] dla odróżnienia kolejnych wersji zgodnych tematycznie ale różnych co do układu i zawartości

Narzędzia

  • Katalogi wiedzy są dokumentami kompilowanymi z plików źródłowych do wynikowych za pomocą Sphinx-a
  • Moduły zapisane są w osobnych podkatalogach takiego dokumentu
  • Nazwa katalogu modułu rozpoczyna się od indeksu (np. XWAAB01_katalogi-wiedzy ) dzięki czemu można nimi zarządzać
  • Dystrybucja katalogów wiedzy dokonywana jest przez jedno centralne repozytorium GIT dla każdego katalogu wiedzy oraz wiele kopii lokalnych w miejscu powstawania dokumentów pochodnych (prezentacje, materiały)

Zawartość pliku modułu (.rst)

../../_images/obraz05.png

Fragment pliku modułu.

Treści modułu zapisane są w pliku w formacie reStructuredText.