ucs

Documentation

Overview

package ucs provides Universal Category System (UCS) category and filename utilities.

Index

• type Category
  • func Categories() ([]Category, error)
• type Filename
  • func (f Filename) Render(ext string) string

Types

type Category

type Category struct {
	Category    string
	SubCategory string
	CatID       string
	CatShort    string
	Synonyms    string
}

Category is UCS category.

func Categories

func Categories() ([]Category, error)

Categories returns the full list of UCS categories.

The builtin CSV file is used as a datasource unless UCS_CSV_FILE is set, in which case that file will be used instead. Compatible CSV files are availble at https://universalcategorysystem.com.

type Filename

type Filename struct {
	CatID     string
	FXName    string
	CreatorID string
	SourceID  string
	UserData  string
}

Filename is a UCS filename. Individual segments *must not* contain underscores, because underscores are used to separate segments in the rendered filename.

func (Filename) Render

func (f Filename) Render(ext string) string

Render returns the assembled filename with the given extension:

CatID_FXName_CreatorID_SourceID_UserData.Extention