Dokumentacja

Własne typy elementów

Projektuj wielokrotnie używalne szablony dla najmniejszych elementów materiału — zadań, pojęć, przykładów — z ustalonego zestawu prymitywów, bez zamieniania pracowni w kreator low-code.

Czym jest typ elementu

Element to najmniejsza wielokrotnie używalna jednostka treści w Didaxi — pojedyncze zadanie, definicja, przykład lub notatka. Typ elementu to szablon, który decyduje, co element danego rodzaju zawiera i jak renderuje się po osadzeniu w dokumencie.

Nazwa i opis to metadane dla twórcy: pomagają rozpoznawać i utrzymywać typ w pracowni i nigdy nie są pokazywane czytelnikom, chyba że sam to włączysz. Wszystko, co widzi czytelnik, kontrolują części, atrybuty i ustawienia wyświetlania typu.

Części — bloki treści

Części to uporządkowane bloki, które autor wypełnia podczas tworzenia elementu. Typ składasz z ustalonego zestawu prymitywów, dzięki czemu każdy element danego typu pozostaje spójny strukturalnie.

Każda część ma poziom dostępu, więc pojedynczy element może łączyć treść jawnie widoczną z treścią bramkowaną. Typ „Zadanie” może na przykład udostępniać treść polecenia publicznie, a pełne rozwiązanie zachować dla czytelników z uprawnieniem.

  • Tekst sformatowany — proza z formatowaniem i matematyką w treści.
  • Obraz — zasób z biblioteki pracowni.
  • Wideo zewnętrzne — osadzony link YouTube lub Vimeo.
  • Separator — wizualny rozdzielnik bez własnej treści.
  • Grupa — powtarzalny kontener (np. lista wskazówek lub warianty odpowiedzi), którego części potomne powtarzają się jako zestaw.
  • Poziom dostępu na część: publiczny, zarejestrowany lub z uprawnieniem.

Atrybuty — typowane metadane

Atrybuty to pola typowane dołączone do elementu, a nie dowolna treść — przydatne do klasyfikacji, poziomu trudności czy pochodzenia, które później zechcesz filtrować lub spójnie wyświetlać.

Atrybut może być opcjonalny w dokumentach i może zezwalać na nadpisanie w konkretnym dokumencie, więc ten sam element może mieć wartość domyślną, którą dany dokument koryguje.

  • Typy wartości: tekst, liczba lub wartość logiczna.
  • Rozmieszczenie decyduje, czy wartość renderuje się w linii z elementem, czy jako osobne metadane.
  • Przykład: liczbowe pole `difficulty` i tekstowe pole `source` w typie „Zadanie”.

Etykieta wyświetlania i numeracja

Etykieta wyświetlania pojawia się nad osadzonym elementem w dokumencie. Jest niezależna od nazwy typu: pozostaw ją pustą, aby nic nie pokazywać, użyj zwykłego tekstu jako stałego podpisu albo dodaj jeden token numeracji, aby włączyć numerację opartą o przepływ dokumentu.

  • Pusta — nie renderuje niczego nad elementem.
  • `Problem` — etykieta statyczna, pokazana dosłownie.
  • `Problem {n}` — numeracja kontekstowa: `Problem 1`, `Problem 2`, … w kolejności pojawiania się w dokumencie.
  • `Section {N}` — `{N}` używa numeracji zakresu nadrzędnego (otwiera lub przesuwa zakres).
  • `Task {n!}` — `{n!}` przesuwa licznik wyłącznie lokalny, nie wpływając na wspólną sekwencję.

Klucze liczników

Klucz licznika jest potrzebny tylko wtedy, gdy etykieta wyświetlania używa numeracji. Typy elementów z tym samym kluczem współdzielą jedną sekwencję w dokumencie, więc numeracja może być niezależna albo ujednolicona między kilkoma typami.

Przykład: nadaj typowi „Zadanie” i typowi „Ćwiczenie” ten sam klucz `problem`, a będą numerowane razem jako jedna ciągła sekwencja; różne klucze dają numerację niezależną.

Szablony tytułów elementów

Typ może wstępnie wypełnić tytuł nowego elementu w chwili rozpoczęcia tworzenia. Szablon jest rozwiązywany tylko raz na starcie edycji; autor może później swobodnie zmienić tytuł. Szablon może być pojedynczym tokenem albo łączyć tokeny z tekstem.

  • `{date:yyyyMMdd}` i `{date:yyyyMMddHHmmss}` wstawiają znacznik czasu.
  • `{rand:N}` wstawia losowy ciąg wielkich liter o długości N, np. `{rand:4}`.
  • Tokeny nie wymagają prefiksu: `{date:yyyyMMddHHmmss}` jest poprawne samodzielnie.

Usuwanie typu elementu

Własny typ elementu można usunąć tylko wtedy, gdy nie używa go żaden element — chroni to istniejące dokumenty przed utratą struktury. Edytor pokazuje dokładnie, ile elementów wciąż odwołuje się do typu, i podaje link do każdego z nich, abyś mógł je najpierw przepiąć lub usunąć.

Wbudowanych typów systemowych nie można usuwać. Gdy odłączysz ostatni element, akcja usuwania zostaje odblokowana.

Dalsza lektura

4 min czytania

Przegląd Didaxi

Model produktu, główne warstwy treści i logika stojąca za wielokrotnie używalną publikacją edukacyjną.

5 min czytania

Tematy i tagi

Jak klasyfikacja strukturalna i elastyczne etykiety współpracują bez ograniczania przyszłego wykorzystania treści.