groups

Documentation

Overview

Package groups deals with group names and their initialisms.

Index

• Variables
• func Cronjob(force bool) error
• func Fix() error
• func Initialism(name string) (string, error)
• func Slug(s string) string
• func Variations(name string) ([]string, error)
• func Wheres() []string
• type Request
  • func (r Request) DataList(name string) error
  • func (r Request) HTML(name string) error
  • func (r Request) Print() (total int, err error)

Variables

var (
	ErrCJDir  = errors.New("cronjob directory does not exist")
	ErrCJFile = errors.New("cronjob file to save html does not exist")
	ErrCfg    = errors.New("the directory.html setting is empty")
)

Functions

func Cronjob

func Cronjob(force bool) error

Cronjob is used for system automation to generate dynamic HTML pages.

func Fix

func Fix() error

Fix any malformed group names found in the database.

func Initialism

func Initialism(name string) (string, error)

Initialism returns a named group initialism or acronym.

func Slug

func Slug(s string) string

Slug takes a string and makes it into a URL friendly slug.

func Variations

func Variations(name string) ([]string, error)

Variations creates format variations for a named group.

func Wheres

func Wheres() []string

Wheres are group categories.

Types

type Request

type Request request.Flags

Request flags for group functions.

func (Request) DataList

func (r Request) DataList(name string) error

DataList prints an auto-complete list for HTML input elements.

func (Request) HTML

func (r Request) HTML(name string) error

HTML prints a snippet listing links to each group, with an optional file count.

func (Request) Print

func (r Request) Print() (total int, err error)

Print a list of organisations or groups filtered by a name and summarizes the results.