diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 0e163d2..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,13 +0,0 @@ -# Jak zgłaszać poprawki - -Poprawki zgłaszamy przez Pull Request. - -Najczęstsze dobre zmiany: - -- poprawienie literówki, -- oznaczenie prawidłowej odpowiedzi jako `-|`, -- usunięcie błędnej odpowiedzi, -- dopisanie źródła w komentarzu `//`, -- dodanie brakującego obrazka do `img/`. - -Nie zmieniaj formatu pliku na pełny Markdown, JSON, CSV ani HTML. To repozytorium używa prostego formatu QAML opisanego w `README.md`. diff --git a/README.md b/README.md index bc843dd..62cca28 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,30 @@ -# Baza pytań quizu +# Fizyka-Machen -To repozytorium zawiera dane quizu: `pytania.txt` oraz opcjonalny katalog `img/` z obrazkami używanymi w pytaniach. +Repozytorium zawiera bazę pytań do quizu z Fizyki. -Kod aplikacji nie jest częścią tego repozytorium. Zmiany w pytaniach należy zgłaszać przez Pull Request. +W repozytorium znajdują się dane quizu: `pytania.txt` oraz opcjonalnie katalog `img/` z obrazkami używanymi w pytaniach. Kod aplikacji nie jest częścią tego repozytorium. -## QAML — Question Answer Markdown Lines +## Jak zgłaszać poprawki -QAML to prosty liniowy format zapisu pytań testowych wielokrotnego wyboru. +Poprawki zgłaszamy przez Pull Request. -Format wygląda jak Markdown, ale jego składnia strukturalna jest znacznie prostsza. Parser nie analizuje pełnego Markdowna. Interpretuje wyłącznie początki linii: +Logowanie w systemie nie wymaga weryfikacji e-mail. Można podać dowolne dane; system jest w pełni anonimowy. + +Najczęstsze dobre zmiany: + +- poprawienie literówki, +- oznaczenie prawidłowej odpowiedzi jako `-|`, +- usunięcie błędnej odpowiedzi, +- dopisanie źródła w komentarzu `//`, +- dodanie brakującego obrazka do `img/`. + +Nie zmieniaj formatu pliku na pełny Markdown, JSON, CSV ani HTML. To repozytorium używa prostego formatu QAML opisanego niżej. + +## QAML + +QAML, czyli Question Answer Markdown Lines, to prosty liniowy format zapisu pytań testowych wielokrotnego wyboru. + +Parser interpretuje wyłącznie początki linii: - linia pytania, - linia odpowiedzi błędnej, @@ -36,12 +52,9 @@ Ile wynosi $2 + 2$? ## Reguły składni -### 1. Pytanie +### Pytanie -Pytaniem jest każda niepusta linia, która: - -- nie zaczyna się od znaku `-`, -- nie zaczyna się od `//`. +Pytaniem jest każda niepusta linia, która nie zaczyna się od `-` ani `//`. Pytanie musi mieścić się w jednej linii. @@ -58,9 +71,9 @@ Zaznacz zdania prawdziwe dotyczące indukcji matematycznej. ``` -Drugi zapis zostanie zinterpretowany jako dwa osobne pytania. +Druga linia zostanie zinterpretowana jako osobne pytanie. -### 2. Odpowiedź błędna +### Odpowiedź błędna Odpowiedź błędna zaczyna się od pojedynczego myślnika `-`. @@ -73,7 +86,7 @@ Poprawne są oba style: Parser usuwa znak `-`, a następnie przycina białe znaki z początku i końca odpowiedzi. -### 3. Odpowiedź poprawna +### Odpowiedź poprawna Odpowiedź poprawna zaczyna się od `-|`. @@ -86,21 +99,10 @@ Poprawne są oba style: Parser usuwa prefiks `-|`, a następnie przycina białe znaki z początku i końca odpowiedzi. -### 4. Pytania jednokrotnego i wielokrotnego wyboru +### Liczba poprawnych odpowiedzi Format dopuszcza dowolną liczbę poprawnych odpowiedzi, w tym zero poprawnych odpowiedzi albo wszystkie odpowiedzi poprawne. -Pytanie jednokrotnego wyboru: - -```text -Ile wynosi $2 + 2$? -- 3 --| 4 -- 5 -``` - -Pytanie wielokrotnego wyboru: - ```text Wskaż liczby pierwsze -| 2 @@ -109,22 +111,20 @@ Wskaż liczby pierwsze -| 5 ``` -Parser nie narzuca liczby poprawnych odpowiedzi. Zero poprawnych odpowiedzi może oznaczać zadanie, w którym żadna odpowiedź nie jest prawdziwa, a oznaczenie wszystkich odpowiedzi jako `-|` może oznaczać zadanie, w którym wszystkie odpowiedzi są prawdziwe. +Parser nie narzuca liczby poprawnych odpowiedzi. -### 5. Komentarze +### Komentarze Komentarzem jest linia zaczynająca się od `//`. -Przykłady: - ```text // Sterna 2024/2025 B // Formanowicz 2021-2022 ``` -Komentarze są ignorowane przez parser demonstracyjny. Można ich używać jako nagłówków sekcji, źródeł, dat albo notatek. +Komentarze są ignorowane przez parser. Można ich używać jako nagłówków sekcji, źródeł, dat albo notatek. -### 6. Puste linie +### Puste linie Puste linie są ignorowane. Można ich używać do oddzielania pytań, odpowiedzi lub sekcji. @@ -136,12 +136,6 @@ Dozwolony jest inline LaTeX między pojedynczymi znakami dolara: Ile wynosi $\binom{n}{k}$? ``` -Dozwolony przykład: - -```text --| Liczba kombinacji wynosi $\binom{n}{k}$. -``` - Nie jest częścią formalnej składni: ```text @@ -150,20 +144,12 @@ a^2 + b^2 = c^2 $$ ``` -oraz: - -```text -\[ a^2 + b^2 = c^2 \] -``` - -Parser demonstracyjny nie waliduje poprawności LaTeX-a. Traktuje zapis `$...$` jako zwykły fragment tekstu. +Parser nie waliduje poprawności LaTeX-a. ## HTML i obrazki HTML jest dopuszczony jako część treści pytania lub odpowiedzi. -Przykład: - ```text Zaznacz funkcję odpowiadającą obrazkowi -| $f(x) = x^2$ @@ -174,8 +160,6 @@ Jeżeli `pytania.txt` odwołuje się do obrazka przez `img/...`, plik musi istni ## Jedna linia = jeden element -To najważniejsza zasada formatu. - Każde pytanie i każda odpowiedź muszą mieścić się w jednej fizycznej linii. Poprawnie: @@ -194,7 +178,7 @@ $f(x) = x^2$. -| Funkcja jest parzysta. ``` -Parser potraktuje drugą linię jako nowe pytanie. +Druga linia zostanie zinterpretowana jako nowe pytanie. ## Walidacja lokalna