help

package module
v0.0.0-...-202965d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2017 License: MIT Imports: 9 Imported by: 0

README

QOR Help

QOR Help provides a way to add help documents to QOR Admin

Usage

First, add QOR Help table to the database.

db.DB.AutoMigrate(&help.QorHelpEntry{})

Then add QOR Help to QOR Admin.

Admin.NewResource(&help.QorHelpEntry{})

Now start your application. You should see a question mark icon appears at the top right corner of QOR Admin interface, click the icon, a slide panel should appear, the Admin user could get knowledge from here directly.

License

Released under the MIT License.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Global = "dashboard"

Functions

This section is empty.

Types

type Categories

type Categories struct {
	RawValue   string
	Categories []string
}

func (*Categories) Scan

func (categories *Categories) Scan(data interface{}) (err error)

func (Categories) Value

func (categories Categories) Value() (driver.Value, error)

type QorHelpEntry

type QorHelpEntry struct {
	gorm.Model
	Title      string
	Categories Categories
	Body       string `gorm:"size:65532"`
}

func (*QorHelpEntry) ConfigureQorResource

func (qorHelpEntry *QorHelpEntry) ConfigureQorResource(res resource.Resourcer)

func (QorHelpEntry) ResourceName

func (QorHelpEntry) ResourceName() string

func (QorHelpEntry) ToParam

func (QorHelpEntry) ToParam() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL