Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring maker #100

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from
Draft

Refactoring maker #100

wants to merge 23 commits into from

Conversation

Headary
Copy link
Member

@Headary Headary commented Dec 21, 2022

Refaktoring prakticky celý maker, v podstatě s jedinou výjimkou: fkssugar . Kromě toho je všechno přepsaný.
Hlavní motivace:

  • zpříjemnit údžbu
  • umožnit měnit obsah bez nutnosti zásahu do maker
    Aktuální systém obsahuje "konfigurační soubory": <package_name>.def soubory, které TeX najde s pomocí určení TEXINPUTS. Pomocí těchto souborů je možné měnit příkazy fks<pkg>@<variable>, které se následně používají v příkazech. Zároveň se loadují i jazykové varianty "..def", které obsahují redefinice pro daný jazyk. Změna v překladu, stylu, obsahu či přidání jazyka je teď jen otázka přidání či upravení pár konfiguračních souborů.
    Zároveň konfigurační soubory budou žít společně s repozitářem ročníku, tedy pokud v makrech nenastanou nějaké velké změny, které by rozbily redefinice, může mít každý ročník jiný design, patičky, název semináře, whatever, a bude to zpětně kompatibilní.
    Taky tento přístup umožňuje znovupoužitelnost pro jiné semináře/soutěže: stačí přepsat config a seminář/soutěž tam má všechny své věci. Tímto taky i odpadá class option semináře, všechno je na tom nezávislé a může se změnit v konfigurácích.

Věci na dodělání

  • přepsat yearbook a udělat jen kompatibilní
  • upravit makefily a vyhodit z něj nekompatibilní věci (starý xml, vyfuk/fykos class options)
  • přepsat přejmenované příkazy v tempatech (\deadline a \deadlineS->\deadlineUpload a \deadlinePost)
  • stará makra uchovat v separátní větvy / releasu, aby stará repa fungovala na Astrid
  • rozjet na Astrid nová makra pod dockerem, optimálně mít více docker verzí (stable, experimental, legacy)
  • odzkoušet změny a najít bugy (špatně napsané příkazy, zapomenuté staré verze atd.)

@Werkov
Copy link
Member

Werkov commented Feb 24, 2023

Pěkné.

  • Jak na tom (ne)seběhnou ty grafické testy?

  • Kvůli čemu (hlavně) se rozbijí repozitáře volající stará makra?

    • No, ona ta zpětná kompatibilita nikdy nebyla dokonalá. Spoléhalo se na to, že při potřebě starého překladu je třeba checkoutovat i makra z odpovídající doby. Což Astrid automaticky nezvládne.
    • Já chápu, že to není mnoho (volání fksmeta a option na seminář)?
  • Kde se budou uchovávat ty definiční soubory? Aka úpravy z ročníku ze budou propagovat i texmf anebo v texmf nebudou definice vůbec žádné?

@Headary
Copy link
Member Author

Headary commented Feb 24, 2023

Jak na tom (ne)seběhnou ty grafické testy?

Nemám tušení a nijak jsem to neřešil, vzhledem k tomu, že to vypadá, že grafické testy už nějakou dobu nejedou. Nicméně pravděpodobně neprojdou, protože jim budou chybět soubory. Pokud by se ta PDF povedla přeložit, tak by asi vypadala stejně, protože jde hlavně o funkční změny.

Kvůli čemu (hlavně) se rozbijí repozitáře volající stará makra?

Ono se to dost pravděpodobně přeloží, hlavní problém je v tom, že se postupem času ve fksmeta a ostatních nahromadily věci, které ovlivňují samotný obsah finálního PDF (např. licence, patička, text v hlavičce, maketitle...), takže staré dokumenty by mohly vypadat jinak i za použití stejného zdrojáku.

Kde se budou uchovávat ty definiční soubory? Aka úpravy z ročníku ze budou propagovat i texmf anebo v texmf nebudou definice vůbec žádné?

Definice plánuju mít přímo v repozitáři, tedy když se mezi ročníky změní texty nebo vzhled, tak to neovlivní staré repozitáře.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants