Add basic layout for Help window

abecirovic3 · Apr 21, 2022 · 92cf8f5 · 92cf8f5
1 parent 03f30c5
commit 92cf8f5
Show file tree

Hide file tree

Showing 18 changed files with 263 additions and 232 deletions.
diff --git a/out/production/MIC-1-Simulator/Translation.properties b/out/production/MIC-1-Simulator/Translation.properties
@@ -93,4 +93,13 @@ program-exec-stop=Izvr\u0161enje programa prekinuto
 load-code-file=Da li ste sigurni da \u017Eelite u\u010Ditati novu kodnu datoteku
 load-code-example=Da li ste sigurni da \u017Eelite u\u010Ditati novi primjer
 end-program-exec-warn=Da li ste sigurni da \u017Eelite prekinuti trenutno izvr\u0161enje programa
-firstNToStack=Prvih n brojeva na stek
+firstNToStack=Prvih n brojeva na stek
+app-description=MIC-1 Simulator je interaktivni simulator oglednog procesora MIC-1, opisanog u ud\u017Ebeniku "Structured Computer Organization", autora Andrew S. Tanenbaum. Aplikacija je prvenstveno namjenjena studentima elektrotehni\u010Dkog fakulteta u Sarajevu, ali naravno svako je dobrodo\u0161ao da istu koristi. Ideja jeste da korisnik kroz kori\u0161tenje aplikacije stekne bolji uvid u rad oglednog procesora MIC-1. Korisniku je omogu\u0107eno da napi\u0161e kod koriste\u0107i set dosupnih instrukcija, zatim da isti pokrene i izvr\u0161ava kroz cikluse procesora. Tokom izvr\u0161avanja instrukcija korisnik mo\u017Ee da prati stanje memorije, kontrolne memorije, procesorskih registara, kao i pojedina\u010Dnih komponenti samog procesora.
+how-to=Upute
+app-use=O kori\u0161tenju aplikacije
+useful-tips=Korisni savjeti
+get-involved=Uklju\u010Dite se
+key-shortcuts=Kratice
+report-bugs=Prijavite bug-ove
+help-development=Pomognite u razvoju
+icons=Ikone
diff --git a/out/production/MIC-1-Simulator/Translation_bs_BA.properties b/out/production/MIC-1-Simulator/Translation_bs_BA.properties
@@ -93,4 +93,13 @@ program-exec-stop=Izvr\u0161enje programa prekinuto
 load-code-file=Da li ste sigurni da \u017Eelite u\u010Ditati novu kodnu datoteku
 load-code-example=Da li ste sigurni da \u017Eelite u\u010Ditati novi primjer
 end-program-exec-warn=Da li ste sigurni da \u017Eelite prekinuti trenutno izvr\u0161enje programa
-firstNToStack=Prvih n brojeva na stek
+firstNToStack=Prvih n brojeva na stek
+app-description=MIC-1 Simulator je interaktivni simulator oglednog procesora MIC-1, opisanog u ud\u017Ebeniku "Structured Computer Organization", autora Andrew S. Tanenbaum. Aplikacija je prvenstveno namjenjena studentima elektrotehni\u010Dkog fakulteta u Sarajevu, ali naravno svako je dobrodo\u0161ao da istu koristi. Ideja jeste da korisnik kroz kori\u0161tenje aplikacije stekne bolji uvid u rad oglednog procesora MIC-1. Korisniku je omogu\u0107eno da napi\u0161e kod koriste\u0107i set dosupnih instrukcija, zatim da isti pokrene i izvr\u0161ava kroz cikluse procesora. Tokom izvr\u0161avanja instrukcija korisnik mo\u017Ee da prati stanje memorije, kontrolne memorije, procesorskih registara, kao i pojedina\u010Dnih komponenti samog procesora.
+how-to=Upute
+app-use=O kori\u0161tenju aplikacije
+useful-tips=Korisni savjeti
+get-involved=Uklju\u010Dite se
+key-shortcuts=Kratice
+report-bugs=Prijavite bug-ove
+help-development=Pomognite u razvoju
+icons=Ikone
diff --git a/out/production/MIC-1-Simulator/Translation_en_US.properties b/out/production/MIC-1-Simulator/Translation_en_US.properties
@@ -93,4 +93,13 @@ program-exec-stop=Program execution aborted
 load-code-file=Are you sure you want to load a new code file
 load-code-example=Are you sure you want to load an example
 end-program-exec-warn=Are you sure you want to abort current program execution
-firstNToStack=First n numbers to stack
+firstNToStack=First n numbers to stack
+app-description=MIC-1 Simulator is an interactive simulator for the MIC-1 cpu, described in Andrew S. Tanenbaum's textbook Structured Computer Organization. The application is primarily intended to be used by the students of the Faculty of Electrical Engineering in Sarajevo, but everyone is welcome to use it. The idea is that the user, while using the application, gains better understanding of the principles behind the MIC-1 cpu. The user is able to write code using the supported instruction set, to run the code and to see it being executed through the cpu cycles. While the instructions are being executed the user can keep track of the memory state, control memory state, cpu registers and the different cpu components.
+how-to=How to
+app-use=Use the application
+useful-tips=Useful tips
+get-involved=Get involved
+key-shortcuts=Key shortcuts
+report-bugs=Report bugs
+help-development=Help develop
+icons=Icons
diff --git a/out/production/MIC-1-Simulator/fxml/about.fxml b/out/production/MIC-1-Simulator/fxml/about.fxml
@@ -1,104 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<?import javafx.scene.control.*?>
 <?import javafx.scene.image.*?>
 <?import javafx.scene.layout.*?>
-<?import javafx.scene.text.*?>
 
-<AnchorPane stylesheets="@../css/styles.css" xmlns="http://javafx.com/javafx/16" xmlns:fx="http://javafx.com/fxml/1">
+<AnchorPane stylesheets="@../css/styles.css" xmlns="http://javafx.com/javafx/16" xmlns:fx="http://javafx.com/fxml/1" fx:controller="sample.AboutController">
    <children>
       <ImageView fx:id="imageView" fitHeight="500.0" fitWidth="500.0" pickOnBounds="true" preserveRatio="true">
          <image>
             <Image url="@../img/aboutFront.png" />
          </image>
       </ImageView>
-      <AnchorPane fx:id="anchorPaneBack" opacity="0.0" prefHeight="500.0" prefWidth="500.0">
-         <children>
-            <Label fx:id="creditsLabel" opacity="0.89" text="%credits" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="20.0">
-               <font>
-                  <Font size="48.0" />
-               </font>
-            </Label>
-            <HBox AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="100.0">
-               <children>
-                  <Label text="%icons-download" textFill="#ffbd59">
-                     <font>
-                        <Font size="14.0" />
-                     </font>
-                  </Label>
-                  <Label text=": https://www.flaticon.com/" textFill="#ffbd59">
-                     <font>
-                        <Font size="14.0" />
-                     </font>
-                  </Label>
-               </children>
-            </HBox>
-            <Label text="%icon-authors" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="130.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="%run-button" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="160.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="  https://www.flaticon.com/authors/pixel-perfect" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="180.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="%load-file-button" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="210.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="  https://www.flaticon.com/authors/iconixar" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="230.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="%new-file-button" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="260.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="  https://www.flaticon.com/authors/smashicons" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="280.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="%save-button" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="310.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="  https://www.freepik.com" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="330.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="%language-circles" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="360.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Label text="  https://www.flaticon.com/packs/countrys-flags" textFill="#ffbd59" AnchorPane.leftAnchor="20.0" AnchorPane.topAnchor="380.0">
-               <font>
-                  <Font size="14.0" />
-               </font>
-            </Label>
-            <Hyperlink fx:id="backLink" alignment="CENTER" disable="true" onAction="#backAction" prefWidth="100.0" text="%back" textAlignment="CENTER" textFill="#ffbd59" AnchorPane.leftAnchor="300.0" AnchorPane.topAnchor="430.0">
-               <font>
-                  <Font size="16.0" />
-               </font>
-            </Hyperlink>
-         </children>
-      </AnchorPane>
-      <Hyperlink fx:id="creditsLink" alignment="CENTER" layoutX="217.0" layoutY="443.0" onAction="#showCreditsAction" prefWidth="100.0" text="%credits" textFill="WHITE" AnchorPane.leftAnchor="200.0" AnchorPane.topAnchor="430.0">
-         <font>
-            <Font size="16.0" />
-         </font>
-      </Hyperlink>
    </children>
 </AnchorPane>
diff --git a/out/production/MIC-1-Simulator/fxml/help.fxml b/out/production/MIC-1-Simulator/fxml/help.fxml
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.geometry.*?>
+<?import javafx.scene.control.*?>
+<?import javafx.scene.layout.*?>
+<?import javafx.scene.text.*?>
+
+<VBox maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" spacing="5.0" xmlns="http://javafx.com/javafx/16" xmlns:fx="http://javafx.com/fxml/1" fx:controller="sample.HelpController">
+    <children>
+        <Label text="MIC-1 Simulator">
+            <font>
+                <Font size="18.0" />
+            </font>
+        </Label>
+        <Label prefWidth="590.0" text="%app-description" textAlignment="JUSTIFY" wrapText="true" />
+        <Separator layoutX="15.0" layoutY="209.0" prefWidth="200.0" />
+        <Label text="%how-to">
+            <font>
+                <Font size="18.0" />
+            </font>
+        </Label>
+        <HBox spacing="5.0">
+            <children>
+                <Hyperlink fx:id="appUseLink" onAction="#setTextAreaAction" text="%app-use" />
+            </children>
+        </HBox>
+        <Separator prefWidth="200.0" />
+        <Label layoutX="15.0" layoutY="15.0" text="%useful-tips">
+            <font>
+                <Font size="18.0" />
+            </font>
+        </Label>
+        <HBox layoutX="15.0" layoutY="41.0" spacing="5.0">
+            <children>
+                <Hyperlink fx:id="shortcutsLink" onAction="#setTextAreaAction" text="%key-shortcuts" />
+            </children>
+        </HBox>
+        <Separator layoutX="15.0" layoutY="41.0" prefWidth="200.0" />
+      <Label layoutX="15.0" layoutY="231.0" text="%credits">
+         <font>
+            <Font size="18.0" />
+         </font>
+      </Label>
+      <HBox layoutX="15.0" layoutY="196.0" spacing="5.0">
+         <children>
+            <Hyperlink fx:id="iconsLink" onAction="#setTextAreaAction" text="%icons" />
+         </children>
+      </HBox>
+      <Separator prefWidth="200.0" />
+        <Label layoutX="15.0" layoutY="86.0" text="%get-involved">
+            <font>
+                <Font size="18.0" />
+            </font>
+        </Label>
+        <HBox layoutX="15.0" layoutY="104.0" spacing="5.0">
+            <children>
+                <Hyperlink fx:id="reportBugsLink" onAction="#setTextAreaAction" text="%report-bugs" />
+                <Hyperlink fx:id="helpDevelopLink" layoutX="10.0" layoutY="10.0" onAction="#setTextAreaAction" text="%help-development" />
+            </children>
+        </HBox>
+        <Separator layoutX="15.0" layoutY="133.0" prefWidth="200.0" />
+        <TextArea fx:id="textArea" editable="false" prefHeight="233.0" prefWidth="590.0" wrapText="true">
+            <font>
+                <Font size="15.0" />
+            </font></TextArea>
+        <ButtonBar prefHeight="40.0" prefWidth="200.0">
+            <buttons>
+                <Button mnemonicParsing="false" onAction="#closeAction" text="Close" />
+            </buttons>
+        </ButtonBar>
+    </children>
+    <padding>
+        <Insets bottom="5.0" left="5.0" right="5.0" top="5.0" />
+    </padding>
+</VBox>
diff --git a/out/production/MIC-1-Simulator/fxml/main.fxml b/out/production/MIC-1-Simulator/fxml/main.fxml
@@ -49,6 +49,7 @@
                 <Menu fx:id="helpMenu" mnemonicParsing="false" text="%help">
                   <items>
                     <MenuItem fx:id="aboutMenuItem" mnemonicParsing="false" onAction="#openAboutAction" text="%about" />
+                        <MenuItem fx:id="helpMenuItem" mnemonicParsing="false" onAction="#openHelpAction" text="%help" />
                   </items>
                 </Menu>
               </menus>

diff --git a/out/production/MIC-1-Simulator/sample/AboutController.class b/out/production/MIC-1-Simulator/sample/AboutController.class
diff --git a/out/production/MIC-1-Simulator/sample/Controller.class b/out/production/MIC-1-Simulator/sample/Controller.class
diff --git a/out/production/MIC-1-Simulator/sample/HelpController.class b/out/production/MIC-1-Simulator/sample/HelpController.class
diff --git a/resources/Translation.properties b/resources/Translation.properties
@@ -93,4 +93,13 @@ program-exec-stop=Izvr\u0161enje programa prekinuto
 load-code-file=Da li ste sigurni da \u017Eelite u\u010Ditati novu kodnu datoteku
 load-code-example=Da li ste sigurni da \u017Eelite u\u010Ditati novi primjer
 end-program-exec-warn=Da li ste sigurni da \u017Eelite prekinuti trenutno izvr\u0161enje programa
-firstNToStack=Prvih n brojeva na stek
+firstNToStack=Prvih n brojeva na stek
+app-description=MIC-1 Simulator je interaktivni simulator oglednog procesora MIC-1, opisanog u ud\u017Ebeniku "Structured Computer Organization", autora Andrew S. Tanenbaum. Aplikacija je prvenstveno namjenjena studentima elektrotehni\u010Dkog fakulteta u Sarajevu, ali naravno svako je dobrodo\u0161ao da istu koristi. Ideja jeste da korisnik kroz kori\u0161tenje aplikacije stekne bolji uvid u rad oglednog procesora MIC-1. Korisniku je omogu\u0107eno da napi\u0161e kod koriste\u0107i set dosupnih instrukcija, zatim da isti pokrene i izvr\u0161ava kroz cikluse procesora. Tokom izvr\u0161avanja instrukcija korisnik mo\u017Ee da prati stanje memorije, kontrolne memorije, procesorskih registara, kao i pojedina\u010Dnih komponenti samog procesora.
+how-to=Upute
+app-use=O kori\u0161tenju aplikacije
+useful-tips=Korisni savjeti
+get-involved=Uklju\u010Dite se
+key-shortcuts=Kratice
+report-bugs=Prijavite bug-ove
+help-development=Pomognite u razvoju
+icons=Ikone
diff --git a/resources/Translation_bs_BA.properties b/resources/Translation_bs_BA.properties
@@ -93,4 +93,13 @@ program-exec-stop=Izvr\u0161enje programa prekinuto
 load-code-file=Da li ste sigurni da \u017Eelite u\u010Ditati novu kodnu datoteku
 load-code-example=Da li ste sigurni da \u017Eelite u\u010Ditati novi primjer
 end-program-exec-warn=Da li ste sigurni da \u017Eelite prekinuti trenutno izvr\u0161enje programa
-firstNToStack=Prvih n brojeva na stek
+firstNToStack=Prvih n brojeva na stek
+app-description=MIC-1 Simulator je interaktivni simulator oglednog procesora MIC-1, opisanog u ud\u017Ebeniku "Structured Computer Organization", autora Andrew S. Tanenbaum. Aplikacija je prvenstveno namjenjena studentima elektrotehni\u010Dkog fakulteta u Sarajevu, ali naravno svako je dobrodo\u0161ao da istu koristi. Ideja jeste da korisnik kroz kori\u0161tenje aplikacije stekne bolji uvid u rad oglednog procesora MIC-1. Korisniku je omogu\u0107eno da napi\u0161e kod koriste\u0107i set dosupnih instrukcija, zatim da isti pokrene i izvr\u0161ava kroz cikluse procesora. Tokom izvr\u0161avanja instrukcija korisnik mo\u017Ee da prati stanje memorije, kontrolne memorije, procesorskih registara, kao i pojedina\u010Dnih komponenti samog procesora.
+how-to=Upute
+app-use=O kori\u0161tenju aplikacije
+useful-tips=Korisni savjeti
+get-involved=Uklju\u010Dite se
+key-shortcuts=Kratice
+report-bugs=Prijavite bug-ove
+help-development=Pomognite u razvoju
+icons=Ikone
diff --git a/resources/Translation_en_US.properties b/resources/Translation_en_US.properties
@@ -93,4 +93,13 @@ program-exec-stop=Program execution aborted
 load-code-file=Are you sure you want to load a new code file
 load-code-example=Are you sure you want to load an example
 end-program-exec-warn=Are you sure you want to abort current program execution
-firstNToStack=First n numbers to stack
+firstNToStack=First n numbers to stack
+app-description=MIC-1 Simulator is an interactive simulator for the MIC-1 cpu, described in Andrew S. Tanenbaum's textbook Structured Computer Organization. The application is primarily intended to be used by the students of the Faculty of Electrical Engineering in Sarajevo, but everyone is welcome to use it. The idea is that the user, while using the application, gains better understanding of the principles behind the MIC-1 cpu. The user is able to write code using the supported instruction set, to run the code and to see it being executed through the cpu cycles. While the instructions are being executed the user can keep track of the memory state, control memory state, cpu registers and the different cpu components.
+how-to=How to
+app-use=Use the application
+useful-tips=Useful tips
+get-involved=Get involved
+key-shortcuts=Key shortcuts
+report-bugs=Report bugs
+help-development=Help develop
+icons=Icons