Merge pull request #2 from BeziCZ/main

Refaktor na FEKT.tex 2.0, korektura starých otázek přidání nových

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Build all template PDF and release it
 # Feel free to increment this counter in your attempts to do things
 # the smart way instead of the easy way.
 #
-# total_hours_wasted = 17
+# total_hours_wasted = 19
 
 
 on:
@@ -20,10 +20,10 @@ jobs:
   # build šablony
   build:
     runs-on: ubuntu-latest
-
+    
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # kompilace
       - name: Build ${{ matrix.dir }}
@@ -34,14 +34,14 @@ jobs:
           root_file: main.tex
 
       - name: Set env
-        run: echo "NAME=$(grep -F "\newcommand{\subject}" main.tex | cut -d'{' -f 3 | cut -d'}' -f 1)" >> $GITHUB_ENV
+        run: echo "NAME=$(grep -F "\newcommand{\name}" main.tex | cut -d'{' -f 3 | cut -d'}' -f 1)" >> $GITHUB_ENV
 
       # nahrání pro pozdější stažení
       - name: Upload artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           # název zip souboru se specifickým jménem předmětu
-          name: ${{ env.NAME }}
+          name: "FEKT.tex"
           # co se má uložit do zip souboru
           path: main.pdf
 
@@ -55,21 +55,21 @@ jobs:
 
     steps:
     - name: Set up Git repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Create tag
       id: create_tag
       run: |
         tag=build-$(date +%Y%m%d-%H%M%S)
-        echo "::set-output name=tag::$tag"
+        echo "TAG=$tag" >> "$GITHUB_OUTPUT"
     - name: Create Release
       id: create_release
-      uses: actions/create-release@v1
+      uses: actions/create-release@latest
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        tag_name: ${{ steps.create_tag.outputs.tag }}
-        release_name: ${{ steps.create_tag.outputs.tag }}
+        tag_name: ${{ steps.create_tag.outputs.TAG }}
+        release_name: ${{ steps.create_tag.outputs.TAG }}
         draft: false
         prerelease: false
 
@@ -80,26 +80,28 @@ jobs:
     needs: [ build, release ]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set env
       run: echo "NAME=$(grep -F "\newcommand{\subject}" main.tex | cut -d'{' -f 3 | cut -d'}' -f 1)" >> $GITHUB_ENV
 
     # stažení dříve nahráneho zip souboru v subjects jobu
     - name: Download artifact
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v4
       with:
-        name: ${{ env.NAME }}
+        name: "FEKT.tex"
 
+    - name: Display structure of downloaded files
+      run: ls -R
     # přidání do releasu
     - name: Upload artifact to Release
-      uses: actions/upload-release-asset@v1
+      uses: actions/upload-release-asset@latest
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         upload_url: ${{ needs.release.outputs.upload_url }}
         # cesta k souboru
         asset_path: ./main.pdf
         # název v releasu
-        asset_name: ${{ env.NAME }}.pdf
-        asset_content_type: application/pdf
+        asset_name: MPC-KRY.pdf
+        asset_content_type: application/pdf

README.md

@@ -7,55 +7,40 @@ Dokument obsahuje základní nastavení a představení různých funkcí.
 
 Nejjednodušší je stáhnout tento repozitář jako zip a nahrát jej do online LaTeX compileru [Overleaf](https://overleaf.com).
 
-## GitHub releases
-
-S pomocí GitHub Actions je nyní možné používat GitHub release na vydání nové verze pdf.
-Stačí pouze nový commit v `main` větvi a GitHub Actions se o build a release postará.
-Taktéž máme workflow pro kontrolu příchozích Pull Requestů, který neprojde pokud build selže.
-Nejnovější release této šablony můžete vidět [zde](https://github.com/VUT-FEKT-IBE/FEKT.tex/releases/latest).
-
-_Pozn.: Build se týká pouze souboru [`main.tex`](main.tex), proto byste neměli přidávat jiné hlavní .tex soubory._
-
-### Co neupravovat: `shared.tex`
-
-Obsah souboru [`shared.tex`](shared.tex) obsahuje kompletní nastavení stylu dokumentu.
-Nikdy jej neupravujte, všechna případná doplnění provádějte v souboru `main.tex`.
-V budoucnu tak bude možné vyměnit váš zkopírovaný soubor za novější a nepřijdete tak o žádné změny, které jste provedli.
-
-Pokud zakládáte dlouhodobější projekt, proveďte následující krok:
-
-- Zkopírujte git hash nejnovějšího commitu na GitHubu
-- Vložte jej na třetí řádek v `shared.tex`
-
-![Git hash commitu](images/github-commit-hash.png)
-
-Takto budete mít lepší přehled o verzi vašeho `shared.tex` a budou se vám lépe kontrolovat aktualizace.
-
-### Co upravovat: `main.tex`
+### Co upravit: `main.tex`
 
 Soubor [`main.tex`](main.tex) pak obsahuje konkrétní nastavení dokumentu.
 
 | Příkaz       | Popis | Příklad |
 |--------------|-------|---------|
-| \subject     | Kód předmětu | BPC-SPR |
-| \subjectname | Název předmětu | Softwarové právo |
+| \name        | Nadpis | BPC-SPR |
+| \subname     | Podnadpis | Softwarové právo |
 | \authors     | Seznam autorů dokumentu | A, B, C |
 | \corrections | Seznam korektorů gramatiky či oprav formátování | C, A |
-| \docdesc     | (nepovinný) Popis dokumentu | Poznámky k předmětu |
-| \docgroup    | (nepovinný) Cílová skupina dokumentu | Informační bezpečnost, FEKT VUT |
-| \docurl      | (nepovinný) URL repozitáře | https://github.com/... |
+| \docdesc     | Popis dokumentu | Poznámky k předmětu |
+| \docgroup    | Cílová skupina dokumentu | Informační bezpečnost, FEKT VUT |
+| \docurl      | URL repozitáře | https://github.com/... |
 
-Tento soubor si zkopírujte pouze jednou na začátku, k jeho aktualizacím by docházet nemělo.
+Tyto příkazy jsou definovány v samém vrcholu dokumentu.
+Pokud je smažete nebo zakomentujete, v dokumentu se nevyskytnou.
 
 ### Kam psát: `text/`
 
-Kam budete psát samotný text dokumentu je na vás.
+Dokumenty je zvykem členit do souvislých částí (kapitol), které se ukládají do složky `text/`.
+
+Nejprve smažte soubor `text/00_fekt-tex`, protože ten pouze ukazuje jak tuto šablonu použít.
+Poté vytvořte dokument nový, například `text/01_uvod.tex`. Do něj budete psát obsah samotný.
+Pro každou novou kapitolu vytvořte samostatný soubor, kód se vám tak bude lépe udržovat.
 
-Tento repozitář je připravený pro větší dokumenty a obsah se vkládá do `text/01.tex`.
-Pro každý nově vytvořený soubor musíte také přidat `\include{}` ve vašem `main.tex`.
+## Údržba
 
-Pokud vytváříte menší dokument, může pro vás být přehlednější složku `text/` nepoužívat a vytvořit si nový textový soubor `text.tex` hned v kořenové složce; v tomto případě pak upravte `\include{}` volání ve vašem `main.tex`.
+Své úpravy stylu dokumentu provádějte pouze ve spodní části souboru, v kategorii DOKUMENT.
 
-### Rozšíření pro případ více dokumentů
+Když dojde k aktualizaci FEKT.tex, můžete otevřít zdrojový soubor `main.tex` a zkopírovat z něj vše mezi kategoriemi OBECNÉ NASTAVENÍ až DOKUMENT.
 
-Pokud vytváříte více dokumentů v jednom repozitáři (viz státnicové otázky [bakalářského](https://github.com/VUT-FEKT-IBE/BPC-IBE-SZZ) a [magisterského](https://github.com/VUT-FEKT-IBE/MPC-IBE-SZZ) programu), můžete vytvořit soubor `.repo.tex`, který je načten a zpracován. V něm lze definovat proměnné platné pro celý repozitář a není tak nutné upravovat jednu hodnotu (např. popis dokumentu) ve všech `main` souborech, ale pouze v jednom kořenovém.
+### GitHub releases
+
+S pomocí GitHub Actions je nyní možné používat GitHub release na vydání nové verze pdf.
+Stačí pouze nový commit v `main` větvi a GitHub Actions se o build a release postará.
+Taktéž máme workflow pro kontrolu příchozích Pull Requestů, který neprojde pokud build selže.
+Nejnovější release této šablony můžete vidět [zde](https://github.com/VUT-FEKT-IBE/FEKT.tex/releases/latest).