4.0 Beta (Build 20242)

This commit is contained in:
2020-08-29 20:43:36 +02:00
Unverified
parent 65cfcfe67b
commit 1655e17bbe
14 changed files with 327 additions and 33 deletions

View File

@@ -7,6 +7,62 @@
<title>Generator CSV</title>
</head>
<body>
<p>XD</p>
<p id = "about-program-image">
<br>
<br>
<br>
<img src = '../assets/documentation-page/about-program/icon.png'>
<br>
<br>
<br>
</p>
<h1>
Generator CSV
</h1>
<p id = "about-program-main-text">
<b>Autorzy:</b>
</p>
<p id = "about-program-text-centered">
Mateusz Skoczek (styczeń 2019 - wrzesień 2020)<br>
<br>
<b>dla ZSP Sobolew</b><br>
</p>
<br>
<br>
<br>
<hr>
<br>
<br>
<p>
<b>Inne informacje:</b><br>
<br><br>
Język programowania, użyty w programie: <b>Python</b><br>
<br>
Biblioteki:
</p>
<b>
<ul>
<li>sys</li>
<li>os</li>
<li>time</li>
<li>codecs</li>
<li>pathlib</li>
<li>shutil</li>
</ul>
</b>
<p>
<br>
Biblioteki GUI:
</p>
<b>
<ul>
<li>tkinter</li>
<li>pillow</li>
</ul>
</b>
<p>
<br>
Języki, użyte do stworzenia strony z instrukcją i dokumentacją techniczną: <b>HTML</b>, <b>CSS</b>, <b>JavaScript</b>
</p>
</body>
</html>

View File

@@ -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;
}

View File

@@ -7,6 +7,6 @@
<title>Generator CSV</title>
</head>
<body>
<p>w sumie jeszcze nie wiem co tu dam</p>
<p id = "description-text">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</p>
</body>
</html>

View File

@@ -7,6 +7,157 @@
<title>Generator CSV</title>
</head>
<body>
<p>no siema</p>
<button class="accordion"><b>Tworzenie/edytowanie format presetu dla danego pliku źródłowego</b></button>
<div class="panel">
<p>Dane dla przykładu:</p>
<img src = '../assets/documentation-page/how-to-use/example-input-data.png'><br>
<p>W praktyce układ danych wygląda tak (* - nieznaczące dla programu dane):</p>
<p>[imię] [nazwisko]<br>[klasa] [szkoła]<br>[login], [haslo*]</p>
<p>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</p>
<img width = '700px' src = '../assets/documentation-page/how-to-use/input-name.png'><br>
<p> Aby przejśc do edycji presetu należy wcisnąć przycisk WCZYTAJ</p>
<br>
<h5>Typ osoby</h5>
<p>Wybierz odpowiednią opcję w zależności od tego jakich osób dane znajdują się w pliku wejściowym</p>
<h5>Separator pomiędzy danymi</h5>
<p>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ć &ltenter&gt (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 "<u>&ltenter&gt&ltenter&gt</u>"</p>
<h5>Separator pomiędzy wierszami</h5>
<p>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ć &ltenter&gt (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 "<b>&ltenter&gt</b>"</p>
<h5>Separatory pomiędzy danymi</h5>
<p>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ć &ltenter&gt (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ć):<br>"""<br><u>,<br></u><br>"""</p>
<h5>Prawa kolumna - pozycja danych w zbiorze</h5>
<p>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:</p>
<table>
<tr>
<th></th>
<th>Wiersz</th>
<th>Pozycja<br>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>
<h5>Prawa kolumna - Kodowanie</h5>
<p>W tym polu należy wybrać kodowanie pliku wejściowego.</p>
<br>
<p><b>Aby zapisać preset należy wcisnąć przycisk ZAPISZ. Aby anulować tworzenie należy wcisnąć przycisk Anuluj</b></p>
</div>
<button class="accordion"><b>Edycja ustawień ogólnych</b></button>
<div class="panel">
<p>Uruchom program i przejdź do zakładki USTAWIENIA.</p>
<br>
<h5>Kodowanie wyjściowe dla pliku poczty</h5>
<p>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</p>
<h5>Kodowanie wyjściowe dla pliku office</h5>
<p>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</p>
<h5>Domena (używana w mailu)</h5>
<p>W tym polu należy wpisać domenę serwisu szkoły. Będzie ona używana w mailu każdego uzytkownika. Przykład: jan.kowalski2023a@<b>losobolew.pl</b></p>
<h5>Quota (MB)</h5>
<p>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,<b>500</b></p>
<h5>Kraj (zapisany w danych na office)</h5>
<p>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,,,,,,,,,<b>Rzeczpospolita Polska</b></p>
<h5>Rozpoczęcie roku szkolnego (DD | MM)</h5>
<p>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).</p>
<h5>Dane o szkołach</h5>
<p>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 "<u>|</u>".<br>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".<br>W drugiej kolmnie należy wpisać liczbę klas w danej szkole. Te dane używane są do obliczenia roku w znaczniku klasy.<br>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).</p>
<br>
<p><b>Aby zapisać ustawienia należy wcisnąć przycisk ZAPISZ. Aby anulować zmiany wciśnij przycisk Anuluj</b></p>
</div>
<button class="accordion"><b>Generowanie plików wyjściowych</b></button>
<div class="panel">
<h5>Krok 1</h5>
<p>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)</p>
<h5>Krok 2</h5>
<p>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.</p>
<img width = '700px' src = '../assets/documentation-page/how-to-use/generate-input-file-settings.png'><br>
<h5>Krok 3</h5>
<p>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.<br>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.</p>
<img width = '700px' src = '../assets/documentation-page/how-to-use/generate-output-file-settings.png'><br>
<h5>Krok 4</h5>
<p>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.</p>
</div>
<button class="accordion"><b>Usuwanie presetów formatu</b></button>
<div class="panel">
<h5>Krok 1</h5>
<p>Uruchom program i przejdź do zakładki USTAWIENIA.</p>
<h5>Krok 2</h5>
<p>Naciśnij przycisk "Zarządzaj presetami formatu".</p>
<h5>Krok 3</h5>
<p>Zaznacz presety formatu które chcesz usunąć.</p>
<h5>Krok 4</h5>
<p>Naciśnij przycisk "Usuń zaznaczone"</p>
</div>
<button class="accordion"><b>Przywracanie domyślnych ustawień ogólnych programu</b></button>
<div class="panel">
<h5>Krok 1</h5>
<p>Uruchom program i przejdź do zakładki USTAWIENIA.</p>
<h5>Krok 2</h5>
<p>Naciśnij przycisk "Przywróć domyślne ustawienia ogólne". Po potwierdzeniu i ponownym uruchomieniu programu, ustawienia zostaną przywrócone do ustawień fabrycznych.</p>
</div>
<button class="accordion"><b>Przywracanie domyślnego wyglądu programu</b></button>
<div class="panel">
<h5>Krok 1</h5>
<p>Uruchom program i przejdź do zakładki USTAWIENIA.</p>
<h5>Krok 2</h5>
<p>Naciśnij przycisk "Przywróć domyślne ustawienia wyglądu". Po potwierdzeniu i ponownym uruchomieniu programu, wygląd zostanie przywrócony do ustawień fabrycznych.</p>
</div>
<button class="accordion"><b>Zaawansowana edycja ustawień programu i wyglądu</b></button>
<div class="panel">
<h5>Krok 1</h5>
<p>Otwórz menu start i wpisz "%appdata%"</p>
<h5>Krok 2</h5>
<p>Przejdź do folderu "Generator CSV"</p>
<h5>Krok 3</h5>
<p>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.<br>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"</p>
</div>
<script>
var acc = document.getElementsByClassName("accordion");
var i;
for (i = 0; i < acc.length; i++) {
acc[i].addEventListener("click", function() {
/* Toggle between adding and removing the "active" class,
to highlight the button that controls the panel */
this.classList.toggle("active");
/* Toggle between hiding and showing the active panel */
var panel = this.nextElementSibling;
if (panel.style.display === "block") {
panel.style.display = "none";
} else {
panel.style.display = "block";
}
});
}
</script>
</body>
</html>

View File

@@ -7,22 +7,24 @@
<title>Generator CSV</title>
</head>
<body>
<header>
<img id = "header-image" src = "../assets/documentation-page/icon.png">
<div id = "header-text">
<p>GENERATOR CSV</p>
</div>
</header>
<nav>
<ul id = "menu-ul">
<li id = "menu-li"><a href = "about_program.html" target = "content">O programie</a></li>
<li id = "menu-li"><a href = "how_to_use.html" target = "content">Jak używać?</a></li>
<li id = "menu-li"><a href = "program_documentation.html" target = "content">Dokumentacja programistyczna</a></li>
<li id = "menu-li"><a href = "other.html" target = "content">Inne</a></li>
</ul>
</nav>
<section>
<iframe name = "content" src = "about_program.html"></iframe>
</section>
<div id = "outer">
<header>
<img id = "header-image" src = "../assets/documentation-page/icon.png">
<div id = "header-text">
<p>GENERATOR CSV</p>
</div>
<nav>
<ul id = "menu-ul">
<li id = "menu-li"><a href = "description.html" target = "content">Opis</a></li>
<li id = "menu-li"><a href = "how_to_use.html" target = "content">Jak używać?</a></li>
<li id = "menu-li"><a href = "program_documentation.html" target = "content">Dokumentacja techniczna</a></li>
<li id = "menu-li"><a href = "about_program.html" target = "content">O programie</a></li>
</ul>
</nav>
</header>
<section>
<iframe name = "content" src = "description.html"></iframe>
</section>
</div>
</body>
</html>

View File

@@ -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;
}

View File

@@ -7,6 +7,6 @@
<title>Generator CSV</title>
</head>
<body>
<p>siema siema kurwa witam</p>
<p>nic</p>
</body>
</html>