|
@@ -1,9 +1,71 @@
|
|
|
["Developer Documentation"]
|
|
|
-
|
|
|
+
|
|
|
# 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.
|
|
|
+
|
|
|
+
|
|
|
|
|
|
|