Novinky
Soubor Novinky je způsob, jak sdílet aktuality k danému předmětu.[1] Platforma Courses soubor s novinkami automaticky vykreslí uživatelům obdobně, jako kdyby byl psán v AsciiDoc nebo jiném podporovaném formátu.
V rámci Courses jsou předmětové novinky zobrazovány také na hlavní stránce (Rozcestník) u jednotlivých předmětů.
Novinky také poskytují otevřené API a jsou poskytovány ve formátu JSON
, lze je tak pohodlně navázat na další služby.
Courses na základě verzování souborů[2] detekují pro každou novinku:
- Autora a datum publikování
- Změnu nebo smazání novinky
Tyto parametry lze ručně přepsat, viz Přepsání atributů.
Prerekvizity
Pro soubor Novinky platí následující:
- Musí být verzován gitem a zároveň umístěn v kořenovém adresáři projektu pod jménem
NEWS.adoc
- Musí obsahovat název dokumentu (např.
= Novinky
) - Je psán syntaxí AsciiDoc
Vytvoření novinky
Jednotlivé novinky jsou odděleny pomocí nadpisu první úrovně (např. == Nadpis novinky
).
Novinku stačí přidat mezi stávající, a to na vrchol souboru.
Viz ukázkový kód, novinka Rozvrh opakujících studentů
.
Přepsání atributů
- date
- Datum publikování novinky.
Novinka nebude publikována do uplynutí uvedeného data.
Musí být v jednom z následujících formátů:
- ISO 8601:
2019-06-13
,19-06-13
,19-6-13
- Czech:
13. 6. 2019
,13.6.2019
,13.6.19
,13.06.2019
- British English:
13/06/2019
,13/06/19
,13/6/19
- ISO 8601:
- author
Jméno, e-mail nebo odkaz na web autora. E-mail nebo odkaz musí být uveden ve špičatých závorkách.
Příklady:
"Kevin Flynn"
,"Kevin Flynn <flynn@encom.com>"
,"Kevin Flynn <https://encom.com/~flynn>"
Úprava nebo odstranění novinky
V rámci úprav souboru novinky nekombinujte více typů úprav (vytvoření nové, úprava stávajících nebo odstranění novinky) najednou během jednoho commitu.
Ukázka využití
Jeden z předmětů využívající novinky je předmět BI-ZMA.
- Předmětová stránka https://courses.fit.cvut.cz/BI-ZMA/
- Zdrojový repozitář na GitLab https://gitlab.fit.cvut.cz/BI-ZMA/bi-zma/