Quellcode durchsuchen

Merge branch 'master' of https://github.com/tobychui/ArOZ-Online-System

Toby Chui vor 5 Jahren
Ursprung
Commit
73afc94d47
2 geänderte Dateien mit 117 neuen und 5 gelöschten Zeilen
  1. 50 0
      docs/lang/dev-en-HK/3.md
  2. 67 5
      docs/lang/dev-zh-HK/0.md

+ 50 - 0
docs/lang/dev-en-HK/3.md

@@ -0,0 +1,50 @@
+["Making the WebApp"]
+# Making the WebApp
+ArOZ Online WebApps are similar to those used in other systems. It is made out of HTML5, CSS and Javascript.
+You can program the WebApps with tools that you have already familarized and program with your own fashion.
+
+Here are a few tips for you while designing an ArOZ Online friendly WebApp.
+
+- Design with responsive, it need to fit on both mobile and desktop devices.
+- Use ao_module wrapper. Do not call directly to ArOZ System Script unless it is necessary.
+- Try not to depends on other module if possible. If a certain package is required, provide a GUI for the installation process.
+- Try not to use database and use file system if possible. If database is required, use portable database software like SQLite instead of non-portable one like MySQL.
+
+
+### Mobile Interface and UTF-8
+ArOZ Online System needs to support languages from all over the world. Hence, all WebApps should be written in UTF-8 if possible.
+Moreover, to fit Mobile Interfaces on Andriod or iOS devices, some extra meta data should be added to the header as well.
+
+```
+<meta charset="UTF-8">
+<meta name="apple-mobile-web-app-capable" content="yes" />
+<meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=0.8, maximum-scale=0.8"/>
+```
+
+*You might want to change the initial-scale and maximum-scale value from the setting above.*
+
+### Style Matching
+ArOZ Online System default css is based on TocasUI. You can find the source of the css file at ```AOR/script/tocas/tocas.css```. 
+To include it inside your module, put the following line in the header section.
+
+```
+<link rel="stylesheet" href="../script/tocas/tocas.css">
+<script src="../script/tocas/tocas.js"></script>
+```
+
+## Additional Headers
+Now, assume you have finished your WebApp module, you can now intergrate it to the ArOZ Online System. ArOZ Online System provide three kinds of interfaces for user to access the services on top of the host device.
+
+1. Standard WebView (Grid Menu)
+2. Progressive Web Apps (PWA Mode)
+3. Virtual Desktop Mode (VDI Mode)
+
+### Standard WebView
+The Standard WebView is the basic viewing method of ArOZ Online System. WebApp Modules are accessed through normal web browser.
+In this mode, WebApps are viewed just like a normal webpage with no ArOZ Online System additional features. 
+
+### Progressive Web Apps 
+Progressive Web Apps are user experiences that have the reach of the web. Mobile users can add ArOZ Online Modules to their devices' local app menu just like a normal app.
+
+
+

+ 67 - 5
docs/lang/dev-zh-HK/0.md

@@ -1,9 +1,71 @@
-["Developer Documentation"]
-![](img/devdoc.png)
-# Developer Documentation
-Welcome to the documentation for developers. 
+["觀迎來到開發者文件!"]
+![](img/devdoc/banner.png)
+# 開發者文件
+觀迎來到開發者文件
+
+***如果您只想要部署或使用系統的,請參閱另一份文件。***
+
+## 觀迎來到ArOZ Online System
+多實際操作是學習的好方法。 本文件將會解釋如何去開發一個全新的WebApp模組,你將可能需要使用到HTML + CSS + PHP + Javascript。請放心,在建立WebApp的過程你會感覺到如建立普通網站一樣簡單。
+ 
+ 本文件的簡稱,術語如下表所列。
+ 
+<table class="ts table">
+<thead>
+	<tr>
+	<th>簡寫</th>
+	<th>全寫</th>
+	<th>意思</th>
+	</tr>
+</thead>
+<tbody>
+<tr>
+<td>AOR</td>
+<td>ArOZ Online 根目錄</td>
+<td>PHP的根目錄,大部份情況下位於 /var/www/html/AOB/</td>
+</tr>
+<tr>
+<td>AOB</td>
+<td>ArOZ Online Beta</td>
+<td>Beta 版的 ArOZ Online System.有些WebApp是使用ArOZ Online Beta來表達其版本.</td>
+</tr>
+<tr>
+<td>File Explorer</td>
+<td>ArOZ File System 子系統橋接器</td>
+<td>橋接底層Linux的系統。 位於 ./SystemAOB/functions/file_system/*</td>
+</tr>
+<tr>
+<td>JWT</td>
+<td>Json Web Token</td>
+<td>請查閱 https://jwt.io//</td>
+</tr>
+<tr>
+<td>UMfilename<br></td>
+<td>Upload Manager Unicode Encoding File Naming Method (上傳管理用檔名萬國碼表示方式)</td>
+<td>可以使用原本不受支援的檔名。使用"inith"為檔名開頭,接著是十六進制化後的檔名</td>
+</tr>
+<tr>
+<td>HEXfoldername</td>
+<td>十六進制化資料夾名稱<br></td>
+<td>十六進制化後可以使用原本不受支援的資料夾名稱</td>
+</tr>
+<tr>
+<td>VDI</td>
+<td>Virtual Desktop Mode (虛擬桌面模式)</td>
+<td>Desktop模組 + function_bar.php</td>
+</tr>
+</tbody>
+</table>
+
+## 系統內置 IDE
+ArOZ Online System 允許於運作時同時修改系統,令你的程式可節省等待時間。
+我們建議使用Notepad++ / NotepadA (ArOZ Online WebApp 模組)來開發你的WebApp。當然你亦可以使用其他IDE如Vim / VSCode。總括而言,修改方式可分成以下2類
+
+1. 遠端修改,例如透過 Samba or SSH / WinSCP
+2. 直接於ArOZ Online使用WebApp(例如NotepadA)修改
+
+關於 NotepadA 的更多資訊請參閱使用手冊。
 
-***If you are normal users whom want to deploy and use the system, read the standard documentation instead.***