update english docs

Author: cg33

SUMMARY.md

@@ -17,10 +17,14 @@
         * [New Theme](en/admin/theme.md)
         * [File Upload](en/admin/file.md)
         * [Cli](en/admin/cli.md)
+        * [Customize auth user table](en/admin/auth.md)
+        * [Set up CDN](en/admin/cdn.md)
     * [Pages]()
         * [Page Modules](en/pages/modules.md)
         * [Customize Your Page](en/pages/pages.md)
         * [Customize Login Page](en/pages/login.md)  
+    * [CI tests]()
+        * [CI tests](en/tests/ci.md)        
     * [Architecture]()
         * [Introduction](en/architecture/introduction.md)
     * [Development]()
@@ -29,7 +33,6 @@
         * [Plugins Development](en/development/plugins.md)  
     * [Template Development]()
         * [Template Introducation](en/development/template/template.md)
-        * [Form Development](en/development/template/form.md)         
         * [Components](en/development/template/components.md) 
     * [Plan](en/plan.md) 
 * [简体中文](zh/README.md)
@@ -63,15 +66,15 @@
         - [页面模块化](zh/pages/modules.md)    
         - [自定义页面](zh/pages/pages.md)   
         - [修改登录界面](zh/pages/login.md)
-    - [ci测试]
+    - [ci测试]()
         - [ci测试](zh/tests/ci.md)
     - [项目架构]()
         - [架构介绍](zh/architecture/introduction.md)
     - [项目开发]()
         - [代码规范](zh/development/code_style.md)
         - [适配器](zh/development/adapter.md)
         - [插件](zh/development/plugins.md)  
-    - [模板开发](zh/development/template/template.md)
+    - [模板开发]()
         - [模板介绍](zh/development/template/template.md)     
         - [组件开发](zh/development/template/components.md) 
     - [发展规划](zh/plan.md)  

en/README.md

@@ -1,14 +1,14 @@
 # Introduction
 ------
 
-GoAdmin is a data visualization management platform, providing a complete set of visual ui calls to golang programs, and a built-in sql relational database management backend plugin.
+GoAdmin is a framework, providing a complete set of visual UI calls to golang programs, and a built-in sql relational database management backend plugin.
 <br>
 <br>
-Before we build a management backend, we needed at least one back office engineer, a front-end engineer, to take at least a week.
-Now with GoAdmin, we don't need front-end engineers. Our back-end engineers don't even need to know the front-end knowledge. We can build a complete back-end management system in half an hour.
-If your requirements are not complicated, just simple crud, then all you need are serveral golang files, and all files can be packaged into a single binary file, which is very convenient for distribution and deployment.
+In the past, when we try to build an administrative platform, we needed at least one backend IT engineer, a front-end IT engineer, taking at least a week work.
+Now with GoAdmin, we don't need front-end IT engineers. Our back-end IT engineers don't even need to know the front-end knowledge. We can build a complete administrative platform or a data visualization platform in half an hour.
+If your requirements are not so complicated, just simple crud, then all you need are serveral golang files, and all files can be packaged into a single binary file, which is very convenient for distribution and deployment.
 
-here is very simple example which show you how it work: [https://github.com/GoAdminGroup/example](https://github.com/GoAdminGroup/example)
+Here is a super simple example which quickly shows you how it works: [https://github.com/GoAdminGroup/example](https://github.com/GoAdminGroup/example)
 
 
 ## Features
@@ -18,9 +18,9 @@ here is very simple example which show you how it work: [https://github.com/GoAd
 - Support plug-ins(working on it)
 - Provided different ui theme(only Adminlte now, others are coming soon.)
 
-## Demo
+## Online Demo
 
-[https://demo.go-admin.com](https://demo.go-admin.com/admin/login)
+[https://demo.go-admin.com](https://demo.go-admin.com)
 
 ## Dependencies
 
@@ -35,10 +35,12 @@ here is very simple example which show you how it work: [https://github.com/GoAd
 
 ## Community
 
-[Community](http://forum.go-admin.cn)
+[Community](http://discuss.go-admin.com)
 
 ## Backers
 
 Your support will help me do better! 
 
-<a href="https://opencollective.com/go-admin#backers" target="_blank"><img src="https://opencollective.com/go-admin/backers.svg?width=890"></a>
+<a href="https://opencollective.com/go-admin#backers" target="_blank"><img src="https://opencollective.com/go-admin/backers.svg?width=890"></a>
+
+[Support Paypal too](https://www.paypal.me/cg80333)

en/admin/auth.md

@@ -0,0 +1,42 @@
+# Customize authentication user table
+---
+
+The authentication user table of the framework is the most basic information, if you need to customize a lot of extra information, such as mobile phone/IP/gender, etc. You can custom an authentication user table.
+
+First, you need to prepare your own user table. Such as: goadmin_super_manager。And then modify configuration item ```auth_user_table``` in the global configuration. Then generate data model file, overwriting the official user table model file: 
+
+**Note: the user table fields remain with the official line, then on the basis of the official user table field extension.**
+
+```go
+import (
+    ...
+    "github.com/GoAdminGroup/go-admin/engine"
+    ...
+)
+
+func main() {
+
+    ...
+
+    eng := engine.Default()
+
+	cfg := config.Config{
+        ...
+		AuthUserTable: "goadmin_super_manager",
+        ...
+    }
+
+    if err := eng.AddConfig(cfg).
+        // Super administrator access, data model logic can refer to the official documents:https://github.com/GoAdminGroup/go-admin/blob/master/plugins/admin/modules/table/generators.go#L40
+        AddGenerator("manager", GetGoAdminSuperManager).
+        // Ordinary users to access
+        AddGenerator("normal_manager", GetGoAdminSuperNormalManager).
+        ...
+        Use(r); err != nil {
+        panic(err)
+    }
+
+    ...
+    
+}
+```

en/admin/cdn.md

@@ -0,0 +1,13 @@
+# Setting CDN
+---
+
+For your website set up CDN, static resources need to be placed into your CDN website.
+
+The official built-in themes of static resources:
+
+- [adminlte](https://github.com/GoAdminGroup/themes/tree/master/adminlte/resource/assets/dist)
+- [sword](https://github.com/GoAdminGroup/themes/tree/master/sword/resource/assets/dist)
+
+After set up your cdn, you should keep the assets/dist directory. Which means if your cdn address is https://xxxx-cdn.xxxx.com. Then the resource request url is like: https://xxxx-cdn.xxxx.com/assets/dist/css/..../xxxx.css
+
+To take effect also need to set in the global configuration: asset_url items.

en/admin/form/basic.md

@@ -208,4 +208,27 @@ formList.SetInsertFn(func(values form2.Values) error {
 formList.SetUpdateFn(func(values form2.Values) error {
       // values are the form parameters
 	})  
-```
+```
+
+### Form update process
+
+In chronological order as follows: 
+
+- FormPanel.Validator           data validate
+- FormPanel.PreProcessFn        data pre process
+- FormPanel.UpdateFn/InsertFn   update/insert
+- FormPanel.PostHook            hook
+
+The corresponding setting APIs:
+
+```go
+
+formList.SetPostValidator()
+formList.SetPreProcessFn()
+formList.SetPostHook()
+formList.SetUpdateFn()
+formList.SetInsertFn()
+
+```
+
+In the PostHook callback function, you can get the update/insert resutl by calling```values.PostError()```.

en/admin/form/components.md

@@ -64,6 +64,17 @@ formList.AddField("url", "url", db.Varchar, form.Url)
 formList.AddField("ip", "ip", db.Varchar, form.Ip)
 ```
 
+### Code
+```go
+formList.AddField("code", "code", db.Text, form.Code)
+formList.AddField("code", "code", db.Text, form.Code).FieldOptionExt(map[string]interface{}{
+    "theme": "monokai",
+    "font_size": 14,
+    "language": "php",
+    "options": "{useWorker: false}",
+})
+```
+
 ### Color
 
 ```go
@@ -107,21 +118,6 @@ formList.AddField("sex", "sex", db.Int, form.SelectSingle).
 
 ### Select
 
-### SelectSingle
-
-```go
-formList.AddField("sex", "sex", db.Int, form.SelectSingle).
-        // Options, Text is the display content, Value is the corresponding value.
-		FieldOptions(types.FieldOptions{
-            {Text: "man",Value: "0"},
-            {Text: "women",Value: "1"},
-        }).
-        // Default option.
-        FieldDefault("0")
-```
-
-### Select
-
 ```go
 formList.AddField("drink", "drink", db.Int, form.Select).
         // Options, Text is the display content, Value is the corresponding value.
@@ -139,6 +135,10 @@ formList.AddField("drink", "drink", db.Int, form.Select).
                 Text: "red bull",
                 Value: "red bull",
             },
+        }).
+        // returns a []string  here, the corresponding value is ultimately responds field values of this column, the corresponding value is displayed when edit form
+        FieldDisplay(func(model types.FieldModel) interface{} {
+            return []string{"beer"}
         })
 ```
 
@@ -154,6 +154,18 @@ formList.AddField("gender", "gender", db.Int, form.Radio).
         FieldDefault("0")
 ```
 
+### Switch
+
+```go
+formList.AddField("site", "site", db.Int, form.Switch).
+        // // Options, Text is the display content, Value is the corresponding value.
+		FieldOptions(types.FieldOptions{
+			{Text: trueStr, Value: "true"},
+			{Text: falseStr, Value: "false"},
+		})
+        FieldDefault("0") // Set default value
+```
+
 ### SelectBox
 
 ```go
@@ -173,6 +185,10 @@ formList.AddField("fruit", "fruit", db.Int, form.SelectBox).
                 Text: "pear",
                 Value: "pear",
             },
+        }).
+        // returns a []string  here, the corresponding value is ultimately responds field values of this column, the corresponding value is displayed when edit form
+        FieldDisplay(func(model types.FieldModel) interface{} {
+            return []string{"pear"}
         })
 ```
 

en/admin/module.md

@@ -44,6 +44,9 @@ func main() {
 
     // get mysql connection
     conn := eng.MysqlConnection()
+
+    // get mssql connection
+    conn := eng.MssqlConnection()
 
     // get postgresql connection
     conn := eng.PostgresqlConnection()
@@ -96,6 +99,8 @@ import (
 
 func main() {
 
+    // pass the global connection object, then call the helper methods
+
     // query
     db.WithDriver(globalConn).Table("users").Select("id", "name").First()
 
@@ -119,6 +124,76 @@ func main() {
 
 ```
 
+You can use APIs of the ```Connection``` too.
+
+```go
+// Connection is a connection handler of database.
+type Connection interface {
+
+    // Initialize
+	InitDB(cfg map[string]config.Database) Connection
+
+	// Get the driver name
+	Name() string
+
+    // Close the connection
+	Close() []error
+
+	// Get the default delimiter
+	GetDelimiter() string
+
+    // Get the sql.DB
+	GetDB(key string) *sql.DB
+
+	// Query with the default connection
+	Query(query string, args ...interface{}) ([]map[string]interface{}, error)
+
+	// Exec with the default connection
+	Exec(query string, args ...interface{}) (sql.Result, error)
+
+	// Query with the specify connection which is the key of Databases of config.Config.
+	QueryWithConnection(conn, query string, args ...interface{}) ([]map[string]interface{}, error)
+
+	// Exec  with the specify connection which is the key of Databases of config.Config.
+	ExecWithConnection(conn, query string, args ...interface{}) (sql.Result, error)
+
+    // Transaction operations:
+
+    // begin the transaction
+    BeginTx() *sql.Tx
+	QueryWithTx(tx *sql.Tx, query string, args ...interface{}) ([]map[string]interface{}, error)
+	ExecWithTx(tx *sql.Tx, query string, args ...interface{}) (sql.Result, error)
+	BeginTxWithReadUncommitted() *sql.Tx
+	BeginTxWithReadCommitted() *sql.Tx
+	BeginTxWithRepeatableRead() *sql.Tx
+	BeginTxWithLevel(level sql.IsolationLevel) *sql.Tx
+	BeginTxWithReadUncommittedAndConnection(conn string) *sql.Tx
+	BeginTxWithReadCommittedAndConnection(conn string) *sql.Tx
+	BeginTxWithRepeatableReadAndConnection(conn string) *sql.Tx
+	BeginTxAndConnection(conn string) *sql.Tx
+	BeginTxWithLevelAndConnection(conn string, level sql.IsolationLevel) *sql.Tx	
+}
+```
+
+Also you can use the orm, for example, ```gorm``
+
+```go
+package main
+
+import (
+    ...
+    "github.com/jinzhu/gorm"
+    ...
+)
+
+func initORM() {
+    // conn is the global connection object
+    orm, _ := gorm.Open("mysql", conn.GetDB("default"))
+    // See more about gorm: https://gorm.io
+}
+```
+
+
 ## User Authentication Module
 
 When we write the page content, need to get the corresponding login user, and to validate its information, need to use user authentication module.
@@ -154,14 +229,32 @@ func main() {
 
         // Verify the permissions
         if !user.CheckPermission("dashboard") {
-            return types.Panel{}, errors.New("没有权限") 
+            return types.Panel{}, errors.New("no permission") 
         }
 
         // Verify the roles
         if !user.CheckRole("operator") {
-            return types.Panel{}, errors.New("没有权限") 
+            return types.Panel{}, errors.New("no permission") 
         }
 	})
     ...
 }
+```
+
+Retrieve the auth user model in the data model functions:
+
+```go
+
+import (
+    ...
+    "github.com/GoAdminGroup/go-admin/modules/auth"
+    "github.com/GoAdminGroup/go-admin/plugins/admin/models"
+    ...
+)
+
+func GetUserTable(ctx *context.Context) table.Table {
+    // retrieve the auth user.
+    user = auth.Auth(ctx)
+}
+
 ```