update

Author: cg33

SUMMARY.md

@@ -73,6 +73,5 @@
         - [插件](zh/development/plugins.md)  
     - [模板开发](zh/development/template/template.md)
         - [模板介绍](zh/development/template/template.md)     
-        - [表单组件开发](zh/development/template/form.md)         
         - [组件开发](zh/development/template/components.md) 
     - [发展规划](zh/plan.md)  

zh/development/adapter.md

@@ -2,7 +2,7 @@
 ---
 
 适配器的作用是实现web框架context与GoAdmin自身context的转换。
-制作一个adapter需要实现以下方法：
+开发一个adapter需要实现以下接口方法：
 
 ```go
 package adapter
@@ -12,62 +12,45 @@ import (
 	"github.com/GoAdminGroup/go-admin/template/types"
 )
 
-// WebFrameWork is a interface which is used as an adapter of
-// framework and goAdmin. It must implement two methods. Use registers
-// the routes and the corresponding handlers. Content writes the
-// response to the corresponding context of framework.
 type WebFrameWork interface {
-	Use(interface{}, []plugins.Plugin) error
-	Content(interface{}, types.GetPanelFn)
+	// 返回web框架的名字
+	Name() string
+
+	// Use 方法将插件中的路由和控制器映射关系插入到web框架中，第一个参数为web框架引擎
+	Use(app interface{}, plugins []plugins.Plugin) error
+
+	// Content 方法将回调参数返回的面板html写入到web框架的context中，也就是第一个参数
+	Content(ctx interface{}, fn types.GetPanelFn, navButtons ...types.Button)
+
+	// User 方法返回认证用户模型
+	User(ctx interface{}) (models.UserModel, bool)
+
+	// AddHandler 增加路由与控制器到web框架中
+	AddHandler(method, path string, handlers context.Handlers)
+
+	// 禁止web框架日志输出
+	DisableLog()
+
+	// 静态目录文件服务器
+	Static(prefix, path string)
+
+	// 辅助函数
+	// ================================
+
+	SetApp(app interface{}) error
 	SetConnection(db.Connection)
 	GetConnection() db.Connection
 	SetContext(ctx interface{}) WebFrameWork
 	GetCookie() (string, error)
 	Path() string
 	Method() string
-	PjaxHeader() string
+	FormParam() url.Values
+	IsPjax() bool
 	Redirect()
 	SetContentType()
 	Write(body []byte)
 	CookieKey() string
 	HTMLContentType() string
-	Name() string
-	User(ci interface{}) (models.UserModel, bool)
-	SetApp(app interface{}) error
-	AddHandler(method, path string, plug plugins.Plugin)
-}
-```
-
-## Use
-
-**Use**接收两个参数，第一个参数类型为**interface{}**，是web框架的context，第二参数为插件数组。返回值是一个**error**。
-**Use**的作用是利用传入的插件数组，将web框架的路由与将插件数组中的控制器方法关联起来，实现web框架与GoAdmin插件方法的对应。比如插件example中：
-
-```go
-"/admin/example" => ShowExample(ctx *context.Context)
-```
-
-通过```Use```的处理后将注入到web框架中。
-
-## Content
-
-**Content**方法接收两个参数，第一个参数类型为**interface{}**，是web框架的context，第二参数为**types.GetPanel**类型。
-
-类型如下：
-
-```go
-type GetPanel func(ctx interface{}) (Panel, error)
-```
-
-**Content**的作用就是自定义页面的时候，传入web框架的context，然后往web框架的context写入自定页面内容的返回。
-
-## init
-
-**init**方法往engine中注入该适配器，从而能够被别人去使用。
-
-```go
-func init() {
-	engine.Register(new(Beego))
 }
 ```
 

zh/development/plugins.md

@@ -1,31 +1,65 @@
 # 插件开发
 ---
 
-一个插件需要实现对应的三个接口，如：
+一个插件需要实现对应的四个接口，如：
 
 ```go
-// Plugin as one of the key components of goAdmin has three
-// methods. GetRequest return all the path registered in the
-// plugin. GetHandler according the url and method return the
-// corresponding handler. InitPlugin init the plugin which do
-// something like init the database and set the config and register
-// the routes. The Plugin must implement the three methods.
+// 插件是GoAdmin的重要组成部分。不同插件有不同的功能特性。
 type Plugin interface {
 
-    // 以下这两个接口内容基本是固定的，可参考后面的example插件，照写即可
-
-    // 获取请求
-    GetRequest() []context.Path
-    
     // 获取控制器方法
-    GetHandler(url, method string) context.Handlers
+    GetHandler() context.HandlerMap
 
     // 初始化插件，接口框架的服务列表
-	InitPlugin(services service.List)
+    InitPlugin(services service.List)
+    
+    // 插件名字
+    Name() string
+    
+    // 插件路由前缀
+	Prefix() string
+}
+```
+
+新建一个自己的插件必须继承```plugin.Base```。如以下例子：
+
+```go
+package example
+
+import (
+	c "github.com/GoAdminGroup/go-admin/modules/config"
+	"github.com/GoAdminGroup/go-admin/modules/service"
+	"github.com/GoAdminGroup/go-admin/plugins"
+)
+
+type Example struct {
+	*plugins.Base
+}
+
+func NewExample() *Example {
+	return &Example{
+		Base: &plugins.Base{PlugName: "example", URLPrefix: "example"},
+	}
+}
+
+func (e *Example) InitPlugin(srv service.List) {
+	e.InitBase(srv)
+	e.App = e.initRouter(c.Prefix(), srv)
+}
+
+func (e *Example) initRouter(prefix, srv service.List) {
+
+	app := context.NewApp()
+    route := app.Group(prefix)
+    // 加入认证中间件
+	route.GET("/show/me/something", auth.Middleware(db.GetConnection(srv)), func(ctx *context.Context){
+        // 控制器逻辑
+    })
+	return app
 }
 ```
 
-参考例子：<br>
+更多源码：<br>
 
 - [开发一个源码插件](https://github.com/GoAdminGroup/go-admin/blob/master/plugins/example/example.go)
 - [开发一个二进制插件](https://github.com/GoAdminGroup/go-admin/blob/master/plugins/example/go_plugin/main.go)