diff --git a/assets/documentation-page/about-program/icon.png b/assets/documentation-page/about-program/icon.png new file mode 100644 index 0000000..e0314ab Binary files /dev/null and b/assets/documentation-page/about-program/icon.png differ diff --git a/assets/documentation-page/how-to-use/example-input-data.png b/assets/documentation-page/how-to-use/example-input-data.png new file mode 100644 index 0000000..ad321b9 Binary files /dev/null and b/assets/documentation-page/how-to-use/example-input-data.png differ diff --git a/assets/documentation-page/how-to-use/generate-input-file-settings.png b/assets/documentation-page/how-to-use/generate-input-file-settings.png new file mode 100644 index 0000000..cbd2c1c Binary files /dev/null and b/assets/documentation-page/how-to-use/generate-input-file-settings.png differ diff --git a/assets/documentation-page/how-to-use/generate-output-file-settings.png b/assets/documentation-page/how-to-use/generate-output-file-settings.png new file mode 100644 index 0000000..0487107 Binary files /dev/null and b/assets/documentation-page/how-to-use/generate-output-file-settings.png differ diff --git a/assets/documentation-page/how-to-use/input-name.png b/assets/documentation-page/how-to-use/input-name.png new file mode 100644 index 0000000..94522b6 Binary files /dev/null and b/assets/documentation-page/how-to-use/input-name.png differ diff --git a/dev-changelog.txt b/dev-changelog.txt index ed16d73..855ad40 100644 --- a/dev-changelog.txt +++ b/dev-changelog.txt @@ -116,4 +116,9 @@ 4.0 Beta (Build 20241.2) - Dodanie do paska tytułu programVersionStage -- Pzzygotowanie strony na dokumentację i instrukcję \ No newline at end of file +- Pzzygotowanie strony na dokumentację i instrukcję + +4.0 Beta (Build 20242) +- Ukończenie instrukcji +- Ukończenie sekcji strony "O programie" +- Ukończenie sekcji strony "Opis" \ No newline at end of file diff --git a/documentation/about_program.html b/documentation/about_program.html index 32e1bfc..646817c 100644 --- a/documentation/about_program.html +++ b/documentation/about_program.html @@ -7,6 +7,62 @@ Generator CSV -

XD

+

+
+
+
+ +
+
+
+

+

+ Generator CSV +

+

+ Autorzy: +

+

+ Mateusz Skoczek (styczeń 2019 - wrzesień 2020)
+
+ dla ZSP Sobolew
+

+
+
+
+
+
+
+

+ Inne informacje:
+

+ Język programowania, użyty w programie: Python
+
+ Biblioteki: +

+ + + +

+
+ Biblioteki GUI: +

+ + + +

+
+ Języki, użyte do stworzenia strony z instrukcją i dokumentacją techniczną: HTML, CSS, JavaScript +

\ No newline at end of file diff --git a/documentation/content.css b/documentation/content.css index 37baf1b..3b7d964 100644 --- a/documentation/content.css +++ b/documentation/content.css @@ -1,3 +1,80 @@ +h1 { + color: #C0C0C0; + font-family: 'Segoe UI'; + font-size: 35px; + text-align: center; +} + +h5 { + color: #C0C0C0; + font-family: 'Segoe UI'; + font-size: 15px; +} + p { - color: #C0C0C0 + color: #C0C0C0; + font-family: 'Segoe UI'; +} + +#description-text { + color: #C0C0C0; + font-family: 'Segoe UI'; + font-size: 17px; + line-height: 25px; + text-align: center; +} + +#about-program-image { + text-align: center; +} +#about-program-main-text { + color: #C0C0C0; + font-family: 'Segoe UI'; + font-size: 17px; + line-height: 25px; + text-align: center; +} + +#about-program-text-centered { + text-align: center; +} + +td { + color: #C0C0C0; + font-family: 'Segoe UI'; +} + +th { + color: #C0C0C0; + font-family: 'Segoe UI'; +} + +.accordion { + background-color: #333842; + color: #444; + cursor: pointer; + padding: 18px; + width: 100%; + text-align: left; + border: none; + outline: none; + transition: 0.4s; + color: #C0C0C0; + font-size: 18px; + font-family: 'Segoe UI'; +} + +.active, .accordion:hover { + background-color: #3a3f4b; +} + +.panel { + padding: 0 18px; + background-color: #2e313b; + display: none; + overflow: hidden; +} + +li { + color: #C0C0C0; } \ No newline at end of file diff --git a/documentation/other.html b/documentation/description.html similarity index 54% rename from documentation/other.html rename to documentation/description.html index 9dcbac4..824ae4b 100644 --- a/documentation/other.html +++ b/documentation/description.html @@ -7,6 +7,6 @@ Generator CSV -

w sumie jeszcze nie wiem co tu dam

+

Program "Generator CSV" służy do przetwarzania plików danymi uczniów/nauczycieli i generowania plików wyjściowych w formacie pozwalającym na import danych na stronach szkoły oraz portal.office.com

\ No newline at end of file diff --git a/documentation/how_to_use.html b/documentation/how_to_use.html index a421c3a..663c5ff 100644 --- a/documentation/how_to_use.html +++ b/documentation/how_to_use.html @@ -7,6 +7,157 @@ Generator CSV -

no siema

+ +
+

Dane dla przykładu:

+
+

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

+
+

Aby przejśc 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 (znaki są podkreślone aby je wyróżnić):
"""
, 
 
"""

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
WierszPozycja
w wierszu
Login31
Imię11
Nazwisko12
Szkoła22
Klasa21
+
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

+
+ + +
+

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

+
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łądowy znacznik klasy: 2023a).

+
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 " | ".
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

+
+ + +
+
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/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.

+
+
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.

+
+
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.

+
+ + +
+
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"

+
+ + +
+
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.

+
+ + +
+
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.

+
+ + +
+
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"

+
+ + \ No newline at end of file diff --git a/documentation/index.html b/documentation/index.html index 706d989..685195b 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -7,22 +7,24 @@ Generator CSV -
- -
-

GENERATOR CSV

-
-
- -
- -
+
+
+ +
+

GENERATOR CSV

+
+ +
+
+ +
+
\ No newline at end of file diff --git a/documentation/main.css b/documentation/main.css index 205face..a4d8e5e 100644 --- a/documentation/main.css +++ b/documentation/main.css @@ -1,11 +1,11 @@ -body { +body, html{ background-color: #21242D; margin: 0px; + height: 100%; + width: 100%; } - - header { width: 100%; position: sticky; @@ -38,6 +38,7 @@ nav { #menu-ul { width: 100%; + height: 50px; padding: 0; margin: 0; list-style: none; @@ -48,11 +49,11 @@ nav { float: left; text-align: center; font-family: 'Segoe UI'; - padding: 0.8%; margin-right: 0.05%; margin-left: 0.05%; font-size: 20px; - width: 23.3%; + width: 24.9%; + line-height: 50px; text-decoration: none; color: #C0C0C0; background-color: #2e313b; @@ -65,13 +66,16 @@ nav { - section { width: 100%; } iframe { + float: left; width: 99%; border: none; - margin: 0.5%; + padding: 0.5%; + height: calc(100% - 220px); + overflow: scroll; + position: absolute; } \ No newline at end of file diff --git a/documentation/program_documentation.html b/documentation/program_documentation.html index 7c5586e..deefc17 100644 --- a/documentation/program_documentation.html +++ b/documentation/program_documentation.html @@ -7,6 +7,6 @@ Generator CSV -

siema siema kurwa witam

+

nic

\ No newline at end of file diff --git a/generator.pyw b/generator.pyw index d751bfe..71cdc2c 100644 --- a/generator.pyw +++ b/generator.pyw @@ -16,8 +16,8 @@ class VAR: # Informacje o programie programName = 'Generator CSV' programVersion = '4.0' - programVersionStage = 'Beta' - programVersionBuild = '20241.2' + programVersionStage = '' + programVersionBuild = '20242' programCustomer = 'ZSP Sobolew' programAuthors = ['Mateusz Skoczek'] programToW = ['styczeń', '2019', 'wrzesień', '2020'] @@ -42,7 +42,6 @@ import time as TM import codecs as CD import pathlib as PT import shutil as SU -import subprocess as SP # GUI