people

Documentation

Overview

Package people handles scene persons, their names, aliases and roles.

Index

• Variables
• func Cronjob(db *sql.DB, w io.Writer, directory string, force bool) error
• func DataList(db *sql.DB, w io.Writer, dest string, f Flags) error
• func Filters() []string
• func Fix(db *sql.DB, w io.Writer) error
• func HTML(db *sql.DB, w io.Writer, dest string, f Flags) error
• func Print(db *sql.DB, w io.Writer, f Flags) error
• func Roles() string
• func Tags() []string
• type Flags
  • func (f Flags) HTML(db *sql.DB, w io.Writer, dest string) error

Variables

var (
	ErrCronDir = errors.New("cronjob directory does not exist")
	ErrHTMLDir = errors.New("the directory.html setting is empty")
)

Functions

func Cronjob

func Cronjob(db *sql.DB, w io.Writer, directory string, force bool) error

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

func DataList

func DataList(db *sql.DB, w io.Writer, dest string, f Flags) error

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

func Filters

func Filters() []string

Filters is a Role slice for use with the Cobra filterFlag.

func Fix

func Fix(db *sql.DB, w io.Writer) error

Fix any malformed names found in the database.

func HTML

func HTML(db *sql.DB, w io.Writer, dest string, f Flags) error

HTML prints a snippet listing links to each person.

func Print

func Print(db *sql.DB, w io.Writer, f Flags) error

Print lists people filtered by a role and summaries the results.

func Roles

func Roles() string

Roles or jobs of people.

func Tags

func Tags() []string

Tags are categories of people.

Types

type Flags

type Flags struct {
	Filter   string // Filter people by category.
	Counts   bool   // Counts the person's total files.
	Progress bool   // Progress counter when requesting database data.
}

Flags for people functions.

func (Flags) HTML

func (f Flags) HTML(db *sql.DB, w io.Writer, dest string) error

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