instructions

Edycja ustawień ogólnych.md

@@ -0,0 +1,56 @@
+# Edycja ustawień ogólnych
+
+
+Uruchom program i przejdź do zakładki USTAWIENIA.
+
+---
+
+### Kodowanie wyjściowe dla pliku poczty
+
+W tym polu należy wybrać kodowanie, w jakim ma być zapisany plik csv z danymi uczniów do importu w panelu administracyjnym serwisu szkoły
+
+### Kodowanie wyjściowe dla pliku office
+
+W tym polu należy wybrać kodowanie, w jakim ma być zapisany plik csv z danymi uczniów do importu w panelu administracyjnym serwisu portal.office.com
+
+### Domena (używana w mailu)
+
+W tym polu należy wpisać domenę serwisu szkoły. Będzie ona używana w mailu każdego uzytkownika. Przykład: jan.kowalski2023a@**losobolew.pl**
+
+### Quota (MB)
+
+W tym polu należy wpisać ilość miejsca (w megabajtach) przeznaczoną dla każdego użytkownika na przechowywanie maili. Te dane są używane w pliku wyjściowym poczty. 
+
+Przykład: jan.kowalski2023a@losobolew.pl,1234567u:JK,**500**
+
+### Kraj (zapisany w danych na office)
+
+W tym polu należy wpisać nazwę kraju zamieszkania użytkowników. Będzie ona wykorzystywana w pliku wyjściowym office oraz widoczna w profilu użytkownika w serwisie office.
+
+Przykład: jan.kowalski2023a@losobolew.pl,Jan,Kowalski,Jan Kowalski,uczeń,1b LO,,,,,,,,,**Rzeczpospolita Polska**
+
+### Nagłówek dla pliku wyjściowego poczty
+
+Jeżeli chcesz aby w pierwszej linii pliku wyjściowego dla poczty znajdował się nagłowek, zaznacz opcję "Umieść w pliku". Zawartość nagłówka można edytować w polu tekstowym po lewej.
+
+### Nagłówek dla pliku wyjściowego office
+
+Jeżeli chcesz aby w pierwszej linii pliku wyjściowego dla office znajdował się nagłowek, zaznacz opcję "Umieść w pliku". Zawartość nagłówka można edytować w polu tekstowym po lewej.
+
+### Rozpoczęcie roku szkolnego (DD | MM)
+
+W tych polach należy wpisać datę rozpoczęcia roku szkolnego (z reguły). W pierwszym polu (po lewo) należy wpisać dzień, a w drugim (po prawo) miesiąc. Te dane są używane do obliczania roku w znaczniku klasy (przykładowy znacznik klasy: 2023a). W przypadku generowania plików na nowy rok szkolny przed jego rozpoczęciem, należy wprowadzić datę dzisiejszą lub wcześniejszą.
+
+### Dane o szkołach
+
+W tym polu należy wprowadzić dane każdej szkoły w zespole szkół (po jednej szkole w linijce). Wymagane są trzy "kolumny danych". Są one odzielone znakami `<spacja>|<spacja>`.
+
+W pierwszej kolumnie należy wpisać oznaczenie szkoły (dowolne bez spacji, najlepiej jak najkrótsze). Te dane będą używane w znaczniku klasy, jeżeli w trzeciej kolumnie została wybrana opcja "1".
+
+W drugiej kolmnie należy wpisać liczbę klas w danej szkole. Te dane używane są do obliczenia roku w znaczniku klasy.
+
+W trzeciej kolumnie można wybrać opcję "1" lub "0" (Prawda/Fałsz). Wybierz "1" jeżeli chcesz, aby w znaczniku klasy znajdowało się oznaczenie szkoły (przykład: 2023bs). Wybierz "0" jeżeli chcesz, aby w znaczniku klasy znajdowała się litera klasy (przykład: 2023a).
+
+---
+
+Aby zapisać ustawienia należy wcisnąć przycisk ZAPISZ. Aby anulować zmiany wciśnij przycisk Anuluj

Generowanie plików wyjściowych.md

@@ -0,0 +1,23 @@
+# Generowanie plików wyjściowych
+
+### Krok 1
+
+W pierwszej kolejności należy przygotować pliki wejściowe oraz stworzyć presety formatu dla tych plików, według instrukcji w sekcji "Tworzenie i edytowanie format presetu dla danego pliku źródłowego" (jednego presetu formatu można używac do kilku plików jeżeli pliki mają ten sam format i to samo kodowanie)
+
+### Krok 2
+
+Przejdź do zakładki GENERATOR CSV. Możesz przetworzyć naraz 4 pliki wejściowe. Dla każdego pliku należy wybrać jego lokalizację (wpisać ją w polu, oznaczonym kolorem czerwonym na poniższym zdjęciu, lub otworzyć okno wyboru lokalizacji za pomocą przycisku "Przeglądaj" i tam wybrać plik. Następnie należy wybrać preset formatu, odpowiedni dla pliku wejściowego, w polu oznaczonym kolorem zielonym na poniższym zdjęciu.
+
+<img src='assets/generate-input-file-settings.png'>
+
+### Krok 3
+
+Wybierz lokalizację zapisu pliku wyjściowego dla serwisu szkoły, wpisując lokalizację wraz z nazwą pliku w polu, oznaczonym kolorem czerwonym na poniższym zdjęciu, lub otwierając okno wyboru lokalizacji za pomocą przycisku "Przeglądaj" obok tego pola i tam wybierając plik.
+
+Wybierz lokalizację zapisu pliku wyjściowego dla serwisu portal.office.com, wpisując lokalizację wraz z nazwą pliku w polu, oznaczonym kolorem zielonym na poniższym zdjęciu, lub otwierając okno wyboru lokalizacji za pomocą przycisku "Przeglądaj" obok tego pola i tam wybierając plik.
+
+<img src='assets/generate-output-file-settings.png'>
+
+### Krok 4
+
+Aby rozpocząć generowanie wciśnij przycisk START i potwierdź komunikat. Pliki wyjściowe zostaną zapisane w wybranych lokalizacjach. Przed importem upewnij się że w plikach nie występują błędy.

Home.md

@@ -1 +0,0 @@
-test

Przywracanie domyślnego wyglądu programu.md

@@ -0,0 +1,9 @@
+# Przywracanie domyślnego wyglądu programu
+
+### Krok 1
+
+Uruchom program i przejdź do zakładki USTAWIENIA.
+
+### Krok 2
+
+Naciśnij przycisk "Przywróć domyślne ustawienia wyglądu". Po potwierdzeniu i ponownym uruchomieniu programu, wygląd zostanie przywrócony do ustawień fabrycznych.

Przywracanie domyślnych ustawień ogólnych programu.md

@@ -0,0 +1,9 @@
+# Przywracanie domyślnych ustawień ogólnych programu
+
+### Krok 1
+
+Uruchom program i przejdź do zakładki USTAWIENIA.
+
+### Krok 2
+
+Naciśnij przycisk "Przywróć domyślne ustawienia ogólne". Po potwierdzeniu i ponownym uruchomieniu programu, ustawienia zostaną przywrócone do ustawień fabrycznych.

Tworzenie i edytowanie format presetu dla danego pliku źródłowego.md

@@ -0,0 +1,87 @@
+# Tworzenie i edytowanie format presetu dla danego pliku źródłowego
+
+Dane dla przykładu:
+
+<img src = 'assets/example-input-data.png'>
+
+W praktyce układ danych wygląda tak (* - nieznaczące dla programu dane):
+
+```
+[imię] [nazwisko]
+[klasa] [szkoła]
+[login], [haslo*]
+```
+
+Uruchom program i otwórz zakładkę FORMAT DANYCH. W pierwszej kolejności należy nadać nazwę presetowi formatu w polu zaznaczonym poniżej lub wybrać preset już istniejący z listy rozwijanej
+
+<img src='assets/input-name.png'>
+
+Aby przejść do edycji presetu należy wcisnąć przycisk WCZYTAJ
+
+---
+
+### Typ osoby
+
+Wybierz odpowiednią opcję w zależności od tego jakich osób dane znajdują się w pliku wejściowym
+
+### Separator pomiędzy danymi
+
+W tym polu należy wpisać znaki, które oddzielają zbiór danych pojeńczych osób. Jeżeli zbiór danych odziela znak końca wiersza (wciśnięcie ENTER) należy wpisać `<enter>` (ilość zależna od ilości znaków końca wiersza). Niedozwolone znaki to litery, cyfry oraz * i \\. Dla przykładowych danych będzie to "`<enter><enter>`"
+
+### Separator pomiędzy wierszami
+
+W tym polu należy wpisać znaki, które oddzielają wiersze. Zazwyczaj jest to jeden znak końca wiersza. Jeżeli wiersze odziela znak końca wiersza (wciśnięcie ENTER) należy wpisać `<enter>` (ilość zależna od ilości znaków końca wiersza). Niedozwolone znaki to litery, cyfry oraz * i \\. Dla przykładowych danych będzie to "`<enter>`"
+
+### Separatory pomiędzy danymi
+
+W tym polu należy wpisać znaki, które oddzielają pojedyńcze dane. Każdy kolejny separator musi być zapisany w następnej linijce. Jeżeli dane odziela znak końca wiersza (wciśnięcie ENTER) należy wpisać `<enter>` (ilość zależna od ilości znaków końca wiersza). Niedozwolone znaki to litery, cyfry oraz * i \\. Dla przykładowych danych będzie to (`<spacja>` należy zastąpić prawdziwą spacją):
+
+```
+,<spacja>
+<spacja>
+```
+
+### Prawa kolumna - pozycja danych w zbiorze
+
+W tej sekcji należy dla każdego typu danych ustawić jego położenie w zbiorze. Typy SZKOŁA i KLASA nie są istotne jeżeli w sekcji TYP OSOBY zosła zaznaczona opcja Nauczyciele. Dla przykładowych danych uczniów bedzie to:
+
+<table>
+    <tr>
+        <th></th>
+        <th>Wiersz</th>
+        <th>Pozycja w wierszu</th>
+    </tr>
+    <tr>
+        <td>Login</td>
+        <td>3</td>
+        <td>1</td>
+    </tr>
+    <tr>
+        <td>Imię</td>
+        <td>1</td>
+        <td>1</td>
+    </tr>
+    <tr>
+        <td>Nazwisko</td>
+        <td>1</td>
+        <td>2</td>
+    </tr>
+    <tr>
+        <td>Szkoła</td>
+        <td>2</td>
+        <td>2</td>
+    </tr>
+    <tr>
+        <td>Klasa</td>
+        <td>2</td>
+        <td>1</td>
+    </tr>
+</table>
+
+### Prawa kolumna - Kodowanie
+
+W tym polu należy wybrać kodowanie pliku wejściowego.
+
+---
+
+Aby zapisać preset należy wcisnąć przycisk ZAPISZ. Aby anulować tworzenie należy wcisnąć przycisk Anuluj

Usuwanie presetów formatu.md

@@ -0,0 +1,17 @@
+# Usuwanie presetów formatu
+
+### Krok 1
+
+Uruchom program i przejdź do zakładki USTAWIENIA.
+
+### Krok 2
+
+Naciśnij przycisk "Zarządzaj presetami formatu".
+
+### Krok 3
+
+Zaznacz presety formatu które chcesz usunąć.
+
+### Krok 4
+
+Naciśnij przycisk "Usuń zaznaczone"

Zaawansowana edycja ustawień programu i wyglądu.md

@@ -0,0 +1,15 @@
+# Zaawansowana edycja ustawień programu i wyglądu
+
+### Krok 1
+
+Otwórz menu start i wpisz "%appdata%"
+
+### Krok 2
+
+Przejdź do folderu "Generator CSV"
+
+### Krok 3
+
+Za ustawienia programu odpowiedzialny jest plik "config.cfg", a za wygląd plik "style.cfg". Użyj dowolnego edytora plików tekstowych, do edycji tych plików. Więcej informacji o tych plikach znajduje się w Dokumentacji technicznej.
+
+Aby przywrócić te pliki do stanu fabrycznego wykonaj kroki z sekcji odpowiednio "Przywracanie domyślnych ustawień ogólnych programu" lub "Przywracanie domyślnego wyglądu programu"