Browse Source

Updated adv docs

Toby Chui 6 years ago
parent
commit
220f61e6cd

BIN
docs/img/10/0.png


BIN
docs/img/11/0.png


BIN
docs/img/11/1.png


BIN
docs/img/11/2.png


BIN
docs/img/11/3.png


BIN
docs/img/11/4.png


BIN
docs/img/11/5.png


BIN
docs/img/11/6.png


BIN
docs/img/11/7.png


BIN
docs/img/11/8.png


BIN
docs/img/11/9.png


BIN
docs/img/11/9.psd


BIN
docs/img/8/0.png


BIN
docs/img/8/1.png


BIN
docs/img/8/2.png


BIN
docs/img/8/3.png


BIN
docs/img/8/4.png


BIN
docs/img/8/5.png


BIN
docs/img/9/0.png


BIN
docs/img/9/0.psd


BIN
docs/img/9/1.png


BIN
docs/img/watermark.png


BIN
docs/img/watermark.psd


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

@@ -1,4 +1,4 @@
-["Welcome to ArOZ Online System!"]
+["Welcome to ArOZ Online!"]
 <img class="ts fluid image" src="img/banner.png"></img>
 
 <img src="https://img.shields.io/badge/Build-Community-brightgreen"> <img src="https://img.shields.io/badge/Device-Raspberry%20Pi%203B%2B%20%2F%204B-red"> <img src="https://img.shields.io/badge/香港制造-Hong%20Kong-blueviolet">

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

@@ -0,0 +1,6 @@
+["Default Viewer Modules"]
+# Default Viewer Modules
+ArOZ Online System provides a few default viewer modules for simpler file formats. The system currently support opening .pdf, .gcode and .stl file by default using the build in viewer tools come with the system. Hence, even if you remove all WebApp modules, you can still browse these types of files.
+
+Here is an example of the build in default viewer modules.
+![](img/10/0.png)

+ 81 - 0
docs/lang/en-HK/11.md

@@ -0,0 +1,81 @@
+["MyHost and File Explorer"]
+![](img/11/0.png)
+# MyHost and File Explorer
+ArOZ Online System provides two main way to manage files and drives on the host devices. They are the "MyHost" tool included in the Desktop Module and the "File Explorer" included in the ArOZ Online System Core. In this page, we will introduce you to the two file / drive manager and how to use them to manage your files on the Host Device.
+
+
+## MyHost
+MyHost is a disk management tool included in the Desktop Module. It shows all the local disk and *remote disk* information on the ArOZ Online System. 
+
+*Remote Disk function is only available on the Full Version or aCloudX edition* 
+
+### Local Disk Management
+You can see all the disk mounted on your local file system through the myHost > Host Devices tab. 
+
+If you are hosting on a Linux device like the Raspberry Pi, you would see the drives denoted by the mount points.
+
+![](img/11/5.png)
+
+Or if you are deploying the ArOZ Online System on a Windows based device, you will see the drives are denoted by its drive letter.
+
+![](img/11/1.png)
+
+If you are using the Full Version of aCloud or aCloudX Edition, you will see the following tab by clicking "Network Drives" tab. Through this interface, you can access network location with tokens generated beforehand.
+
+![](img/11/3.png)
+
+### Media Discovery
+MyHost also provide basic media discovery interface for finding files or documents through out the internal storage spaces. 
+
+![](img/11/4.png)
+
+### Read Only File Viewer
+ArOZ Online System by default do not allow access out of the ArOZ Online Root (AOR). Hence, for all the files outside of AOR, it is either read-only nor not readable. The MyHost provide an interface for listing files in different directory but do not allow starting or browsing their contents.
+
+![](img/11/2.png)
+
+## File Explorer
+File Explorer is the most important service in the ArOZ Online System. It provides file system bridging function to the underlaying Linux file system, allow users to open, copy, move, and create files and folders. 
+
+Here is an example of the File Explorer interface under VDI mode.
+
+![](img/11/6.png)
+
+### UMFilename - Upload Manager File Naming Methods
+Some filename uploaded to the ArOZ Online System contains wierd, unsupported characters. This might cause by many different reasons like OS upgrade, opening ArOZ Online with a computer that use different lanuages or file copy and paste from a Linux PC to a Linux PC. To solve this issue, we used a new naming method called "umfilename" and "hexfoldername" method. As their name suggest, it is very simple to understand.
+
+<table class="ts table">
+<thead>
+<tr>
+<th>File Naming Method</th>
+<th>Encode Method</th>
+<th>Represent Color</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Default (UTF-8)</td>
+<td>None</td>
+<td>White</td>
+</tr>
+<tr>
+<td>UM-Filename</td>
+<td>"inith" + bin2hex({original_filename}) + "." + {original_ext}</td>
+<td>Blue</td>
+</tr>
+<tr>
+<td>HEX-Foldername</td>
+<td>bin2hex({original_foldername})</td>
+<td>Green</td>
+</tr>
+</tbody>
+</table>
+
+However in the ArOZ Online File Explorer, all the filenames and foldername will be shown in "human readable format". Hence, color code is used to seperate between different encoded names. Here is an example with hexfoldername and umfilename.
+
+![](img/11/8.png)
+
+### More Functions
+File Explorer also provide more functions other than file operations. For example, zip and download, file properties viewing and **Default Opening Module** for a particular file extension. More about **Default Opening Module** will be documented in the Developer sections.
+
+![](img/11/9.png)

+ 35 - 0
docs/lang/en-HK/8.md

@@ -0,0 +1,35 @@
+["Web Desktop Interface"]
+# Web Desktop Interface
+Web Desktop Interface, aka Virtual Desktop Mode (VDI Mode), is a mode that allow users to use ArOZ Online Cloud System using a OS-Like desktop interface on their web browser. VDI mode support all basics Desktop operations including create shortcuts, window drag-drop, maximize, hide and close, opening files and folders and more.
+
+VDI mode is powered by Float-Window system. It combines multiple WebApps and system services in ArOZ Online barebone into one easy to use interface which looks like a Desktop Interface. Hence, its name “Virtual Desktop Interface”.
+
+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.
+
+![](img/8/0.png)
+
+## Preview
+This is a typical Web Desktop Interface for a normal user. You can see the shortcuts on the left upper corner and a few files on the center of the desktop. Background is changable via right-click menu.
+
+![](img/8/2.png)
+
+And the functions of the Float Windows system is shown as follows.
+
+![](img/8/1.png)
+
+The following image shows the 3 basic modules, Audio, Video and Photo module, running on Virtual Desktop Mode.
+![](img/8/3.png)
+
+## Basic Functions
+The Virtual Desktop Mode provides simple functions for performing many different operations. Including new folder or files, download from URL and background changing functions. The following image shows the beta-phrase desktop right-click menu.
+
+![](img/8/4.png)
+
+Other than desktop based function, the Desktop Mode also support some simple file operations including remove file, move files or rename. However, it is still recommended to use the File Explorer for more complex operations as File Explorer supports asynchronize file operations compare to desktop's synchronize file operation which might freeze when handling large files on Raspberry Pi.
+
+![](img/8/5.png)
+
+
+

+ 50 - 0
docs/lang/en-HK/9.md

@@ -0,0 +1,50 @@
+["PWA-Mode"]
+# Progressive Web Apps Mode
+PWA mode for an ArOZ Online WebApp is not compulsory but it is recommended.
+
+PWA Mode allow ArOZ Online WebApps to be launched on a mobile devices that support PWAs and allow quick startup of the ArOZ Online WebApp services. Here is an example of the File Explorer launched in PWA mode.
+
+![](img/9/0.png)
+
+## Support PWA Mode
+To support PWA Mode, you will need some extra lines of code and a file named <code> manifest.json</code> according to [Google's defination](https://developers.google.com/web/fundamentals/web-app-manifest/).
+
+In simple words, you will need to add this line in the head section of your WebApp
+
+```
+<link rel="manifest" href="manifest.json">
+```
+
+Here is an example <code> manifest.json</code> for ArOZ Online Audio module.
+
+```
+{
+  "name": "ArOZ Audio",
+  "short_name": "AudioA",
+  "icons": [{
+    "src": "img/pwa/128.png",
+      "sizes": "128x128",
+      "type": "image/png"
+    },{
+      "src": "img/pwa/192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    }, {
+      "src": "img/pwa/256.png",
+      "sizes": "256x256",
+      "type": "image/png"
+    }, {
+      "src": "img/pwa/512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }],
+  "start_url": "index.php?mode=pwa",
+  "display": "standalone",
+  "scope": "./",
+  "background_color": "#f7f7f7",
+  "theme_color": "#4286f4"
+}
+```
+And here are the image files included in the img/pwa/ directory.
+
+![](img/9/1.png)

+ 1 - 0
docs/reader.html

@@ -38,6 +38,7 @@ pre{
 	background-color: #1c1c1c;
 	color: white;
 	padding: 10px;
+	overflow-x: auto;
 }
 </style>
 </head>