people

package

v1.11.13 Latest Latest Go to latest Published: Mar 31, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Defacto2/df2

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

func Cronjob ¶ added in v1.6.0

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 ¶ added in v1.11.0

func Tags() []string

Tags are categories of people.

Types ¶

type Flags ¶ added in v1.11.0

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 ¶ added in v1.11.0

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.

Source Files ¶

View all Source files

people.go

Directories ¶

Path	Synopsis
internal
person Package person contains the shared Person object for individual people.	Package person contains the shared Person object for individual people.
role Package role handles the job or activity a person was credited with.	Package role handles the job or activity a person was credited with.

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