Przeglądaj źródła

Updated dev docs

Toby Chui 5 lat temu
rodzic
commit
e345237a96

BIN
docs/img/12/0.png


BIN
docs/img/12/0.psd


BIN
docs/img/devdoc.png


BIN
docs/img/devdoc.psd


BIN
docs/img/devdoc/banner.png


BIN
docs/img/devdoc/banner.psd


BIN
docs/img/enddoc.png


BIN
docs/img/enddoc.psd


+ 63 - 1
docs/lang/dev-en-HK/0.md

@@ -1,9 +1,71 @@
 ["Developer Documentation"]
-![](img/devdoc.png)
+![](img/devdoc/banner.png)
 # Developer Documentation
 Welcome to the documentation for developers. 
 
 ***If you are normal users whom want to deploy and use the system, read the standard documentation instead.***
 
+## Welcome to the ArOZ Online System
+ Willing to try new stuffs is a great way to learn something new. In this developer documentation, as the author of the system, I will try to explain how to develop a brand new WebApp module for the ArOZ Online System with the skills you already known: HTML + CSS + PHP + Javascript. Trust me, it is as simple as building a website.
+ 
+ In this documentation, the following terms are uses to denote some basic concepts in ArOZ Online Systems. Here is a list of them.
+ 
+<table class="ts table">
+<thead>
+	<tr>
+	<th>Short Form</th>
+	<th>Full Nam</th>
+	<th>Meaning</th>
+	</tr>
+</thead>
+<tbody>
+<tr>
+<td>AOR</td>
+<td>ArOZ Online Root</td>
+<td>The nearest root of a PHP script files. In most case, it is in /var/www/html/AOB/</td>
+</tr>
+<tr>
+<td>AOB</td>
+<td>ArOZ Online Beta</td>
+<td>`The Beta phrase of ArOZ Online System. Some modules use ArOZ Online Beta to denote their versions.</td>
+</tr>
+<tr>
+<td>File Explorer</td>
+<td>ArOZ File System Bridge Sub-system</td>
+<td>The sub-system that bridge the under-laying Linux File System. Located inside ./SystemAOB/functions/file_system/*</td>
+</tr>
+<tr>
+<td>JWT</td>
+<td>Json Web Token</td>
+<td>See https://jwt.io/ for more information/</td>
+</tr>
+<tr>
+<td>UMfilename<br></td>
+<td>Upload Manager Unicode Encoding File Naming Method</td>
+<td>The method to encode non-unicode string into Hexadecimal filename. Commonly start with prefix "inith" and follows by a hexified filename.</td>
+</tr>
+<tr>
+<td>HEXfoldername</td>
+<td>Hexified Folder Name<br></td>
+<td>Folder names that represent non-unicode or non-filename compatible character using hexadecimal encoding.</td>
+</tr>
+<tr>
+<td>VDI</td>
+<td>Virtual Desktop Mode</td>
+<td>aka Web Desktop Mode launched using functional_bar + Desktop Module</td>
+</tr>
+</tbody>
+</table>
+
+## In-System Programming IDE
+ArOZ Online System allows developer to perform realtime development within the system itself. This is speically useful while programming on the go.
+We recommend using either Notepad++ or NotepadA (ArOZ Online WebApp module) to develop your new WebApp. Of course you can also use other development tools like VSCode or Vim if you know how to exit Vim, but in most of the case the editing method boils down to these two.
+
+1. Edit remotely, either through Samba or SSH / WinSCP
+2. Direct edit on ArOZ Online Web Desktop Interface usng in system programming tools like NotepadA
+
+Know more about NotepadA - a Notepad++ like tool for ArOZ Online System over here.
+
+
 
 

+ 15 - 5
docs/lang/en-HK/12.md

@@ -1,6 +1,16 @@
-["End of Documentation"]
-![](img/enddoc.png)
-# End of Documentation
-Congratulations! This is the end of the documentation.
+["List Menu"]
+# List Menu
+List Menu is a general purpose menu design to perform tasks like launching applications, shortcuts to different media files, access to file explorer and settings. You can also launch some build in utilities from the menu and perform basic file search on the bottom search bar.
 
-If you want to know more about the system or develop your own ArOZ Online WebApp Module, feel free to take a look at the development documentation which start with a prefix "dev-". Click ![here](index.html) to exit the documentation reader.
+Here are some example of the list menu functions.
+
+![](img/12/0.png)
+
+## Power Options
+You should be noted that the power options on the list menu are ***REAL POWER BUTTON OF THE HOST DEVICE***. That means if you shut down the server from a remote location, you will need to restart it manually.
+
+## List Menu Icons
+The icons are loaded from each of the module's img/ directory. If a filename ```small_icon.png``` is found, this image file will be used as icon. Or otherwise, ```function_icon.png``` will be used. Hence, you might see some icons are too small to read if you are installing third party modules. In most of the case, it is the problem from the module itself instead of the list menu's issue. 
+
+## "Help / Support" button not working?
+Yes, this is normal if you are using the community edition. Help or Support is only provided to users that is using pre-built systems distributed by OEM manufacturer. In this case, the "Help and Support" button will be linked back to OEM's webpage.  Hence, in community edition, as the button is not programmed, no "Help and Support" will be shown when clicked.

+ 6 - 0
docs/lang/en-HK/13.md

@@ -0,0 +1,6 @@
+["End of Documentation"]
+![](img/enddoc.png)
+# End of Documentation
+Congratulations! This is the end of the documentation.
+
+If you want to know more about the system or develop your own ArOZ Online WebApp Module, feel free to take a look at the development documentation which start with a prefix "dev-". Click ![here](index.html) to exit the documentation reader.

+ 1 - 1
docs/lang/en-HK/8.md

@@ -6,7 +6,7 @@ VDI mode is powered by Float-Window system. It combines multiple WebApps and sys
 
 In VDI mode, Function Bar provide Float Window management functions and navigations to different tools and utilities on the user interface. List Menu provide a quick way to launch WebApps from a list and Device Mounting Manager shows the current mounted external storage devices like USB drives and HDD. Float Windows system in VDI mode allows multiple WebApps to be opened in one browser tab by initializing WebApps in iframes, which also provide a sandbox function for javascripts. The maximum number of Float Windows that can be opened in VDI mode is limited to 50 Windows. This value might increase in the future after the mainstream browsers support iframe multithreading.
 
-The name of the corrisponding elements on the VDI mode is shown in the diagram below.
+The name of the corresponding elements on the VDI mode is shown in the diagram below.
 
 ![](img/8/0.png)