ai-thesis/README.md
2024-05-11 18:41:27 +02:00

108 lines
3.6 KiB
Markdown

Organizacja pracy nad pracą magisterską/inżynierską
===================================================
Te wytyczne dotyczą prac magisterskich prowadzonych przez prof. UAM
dr. hab. Filipa Gralińskiego i prof. dr. hab. Krzysztofa Jassema.
W dalszym ciągu zakładamy, że _NAME_ oznacza imię i nazwisko studenta
pisane małymi literami, bez polskich znaków diakrytycznych, minus zamiast spacji
(np. `jan-kowalski`).
Przygotowanie środowiska pracy
------------------------------
1. Student powinien w serwisie https://git.wmi.amu.edu.pl/ założyć
repozytorium o nazwie `msc-`_NAME_ (dla pracy magisterskiej) lub
`eng-`_NAME_ (dla pracy inżynierskiej). Podczas zakładania
repozytorium proszę zaznaczyć, że repozytorium ma być prywatne:
![Repozytorium powinno być prywatne](git-private.png)
Proszę **nie** inicjalizować repozytorium, repozytorium ma być puste
na początku.
![Nie inicjalizować repozytorium](git-non-init.png)
Po założeniu repozytorium student powinien poprzez opcję _Settings /
Collabotors_ dać prawo zapisu Filipowi Gralińskiemu:
![Prawo zapisu](git-collaborators.png)
2. Filip Graliński umieszcza w repozytorium początek (szablon) pracy.
Student może edytować pracę albo korzystając z repozytorium, albo
pracując w serwisie [Overleaf](https://www.overleaf.com). W tym drugim
przypadku należy przesłać do Filipa Gralińskiego adres e-mail użyty w
serwisie Overleaf (i wcześniej założyć tam konto) — Filip Graliński
udostępni pracę.
3. Filip Graliński przygotowuje zadanie na serwerze ciągłej integracji Jenkins.
4. Student powinien skonfigurować połączenie repozytorium git z
serwerem Jenkins:
<https://laboratoria.wmi.amu.edu.pl/uslugi/zasoby-dla-projektow/jenkins/>, punkt
_Konfiguracja repozytorium Git_ (**NIE** _Konfiguracja Jenkins_!!!).
Jako _długi łańcuch znaków z konfiguracji Jenkinsa_ należy wpisać kod
przesłany przez Filipa Gralińskiego.
Najczęściej popełniane błędy w LaTeX-u
--------------------------------------
### Znaki specjalne
Myślnik (pauza) nie powinien być zapisywany jako minus, tylko jako znak Unikodowy —, można też
w źródle LaTeX-owym używać kombinacji znaków _--_.
Na przykład, zamiast:
Polska ma flagę biało-czerwoną, a Ukraina - niebiesko-źółtą
należy pisać:
Polska ma flagę biało-czerwoną, a Ukraina — niebiesko-źółtą
albo
Polska ma flagę biało-czerwoną, a Ukraina -- niebiesko-źółtą
(W wyrazach złożonych /biało-czerwoną/, /niebiesko-żółtą/ itd. — zostaje minus/łącznik/dywiz!)
Używamy „ładnych” cudzysłowów, np. zamiast:
Ala powiedziała "Basia ma psa".
należy pisać używając wprost znaków Unikodowych:
Ala powiedziała „Basia ma psa”.
lub LaTeX-owych oznaczeń (dwa przecinki dla cudzysłowu otwierającego, dwa apostrofy — dla zamykającego):
Ala powiedziała ,,Basia ma psa''.
### Wzory matematyczne
Nienumerowane wzory matematyczne powinny być zakończone znakiem
interpunkcyjnym, tak jak logicznie wynika z budowy otaczającego tekstu. Po wzorze
często należy też stosować _\noindent_ żeby zablokować wcięcie akapitowe.
Na przykład, zamiast:
Szybkość jest dana wzorem
\[a+b\]
gdzie $a$ to coś tam, a $b$ -- to coś tam innego.
należy napisać:
Szybkość jest dana wzorem
\[a+b,\]
\noindent gdzie $a$ to coś tam, a $b$ -- to coś tam innego.
### Odwołania do rysunków i tabel
W języku polskim w odwołaniach do rysunków i tabel, słowo „rysunek” i
„tabela” powinny być pisane małymi literami (`rysunek~\ref{...}`, `tabela~\ref{...}`),
w języku angielskim — wielkimi (`Figure~\ref{...}`, `Table~\ref{...}`).