ortfodb

package module

Go to main page

Versions in this module

v1

v1.6.1

Apr 27, 2024

v1.6.0

Apr 27, 2024

Changes in this version

+ const PatternYAMLSeparator

+ var EmptyLayoutCell = "empty"

+ func LogTiming(job string, args []interface{}, timeTaken time.Duration)

+ func TimeTrack(start time.Time, job string, args ...interface{})

type ColorPalette

+ func (colors *ColorPalette) SortBySaturation()

type Database

+ func (db Database) FindMedia(mediaEmbed Media, workID string) (found bool, media Media)

+ func (db Database) FindWork(idOrAlias string) (work Work, found bool)

type LocalizedContent

+ Abbreviations Abbreviations

type Media

+ Hash string

+ type PreviouslyBuiltDatabase struct

type RunContext

+ func (ctx *RunContext) PreviouslyBuiltDatabase() Database

+ func (ctx *RunContext) PreviouslyBuiltMedia(workID string, embedDeclaration Media) (media Media, work Work, found bool)

+ func (ctx *RunContext) PreviouslyBuiltWork(id string) (work Work, found bool)

+ func (ctx *RunContext) UseMediaCache(filename string, embedDeclaration Media, workID string) (newHash string, used bool, media Media, err error)

type Tag

+ func (t Tag) DisplayName() string

+ func (t Tag) URLFriendlyName() string

type Technology

+ func (t Technology) DisplayName() string

+ func (t Technology) URLFriendlyName() string

+ type Work struct

+ BuiltAt time.Time

+ Content LocalizableContent

+ DescriptionHash string

+ ID string

+ Metadata WorkMetadata

+ Partial bool

+ func (w Work) Colors(language string) ColorPalette

+ func (w Work) ThumbnailBlock(language string) Media

+ func (w Work) ThumbnailPath(language string, size int) FilePathInsideMediaRoot

+ func (work Work) FirstParagraph(lang string) (found bool, paragraph ContentBlock)

v1.5.0

Apr 20, 2024

Changes in this version

+ var LogFilePath string

+ var PrependDateToLogs = false

+ func BuildIsFinished() bool

+ func ReleaseBuildLock(outputFilename string) error

type ColorPalette

+ func (colors ColorPalette) MergeWith(other ColorPalette) ColorPalette

+ type MediaConfiguration struct

+ At string

+ type TagsConfiguration struct

+ Repository string

+ type TechnologiesConfiguration struct

+ Repository string

v1.4.1

Apr 17, 2024

Changes in this version

+ func DisplayError(msg string, err error, fmtArgs ...interface{})

+ func DisplayWarning(msg string, err error, fmtArgs ...interface{})

+ func LogCustomNoColor(verb string, color string, message string, fmtArgs ...interface{})

+ func LogDebug(message string, fmtArgs ...interface{})

+ func LogDebugNoColor(message string, fmtArgs ...interface{})

+ func LogError(message string, fmtArgs ...interface{})

+ func LogInfo(message string, fmtArgs ...interface{})

+ func LogWarning(message string, fmtArgs ...interface{})

+ func Print(a ...interface{})

+ func Printf(format string, a ...interface{})

+ func Println(a ...interface{})

+ func ShowingColors() bool

v1.4.0

Apr 16, 2024

Changes in this version

+ var BuiltinNativeExporters = []Exporter

type CustomExporter

+ Manifest ExporterManifest

+ func DownloadExporter(name string, url string, config map[string]any) (*CustomExporter, error)

+ func LoadExporter(name string, manifestRaw []byte, config map[string]any) (*CustomExporter, error)

v1.3.0

Apr 16, 2024

v1.2.0

Apr 14, 2024

Changes in this version

+ var AvailableJSONSchemas = []string

+ func ExporterManifestJSONSchema() *jsonschema.Schema

+ func GetExporterOptions[ConcreteOptionsType any](e Exporter, opts ExporterOptions) ConcreteOptionsType

type CustomExporter

+ func (e *CustomExporter) Description() string

+ func (e *CustomExporter) VerifyRequiredPrograms() error

type Exporter

+ Description func() string

type ExporterManifest

+ Requires []string

+ type LocalizeExporter struct

+ func (e *LocalizeExporter) After(ctx *RunContext, opts ExporterOptions, db *Database) error

+ func (e *LocalizeExporter) Before(ctx *RunContext, opts ExporterOptions) error

+ func (e *LocalizeExporter) Description() string

+ func (e *LocalizeExporter) Export(ctx *RunContext, opts ExporterOptions, work *AnalyzedWork) error

+ func (e *LocalizeExporter) Name() string

+ func (e *LocalizeExporter) OptionsType() any

+ type LocalizeExporterOptions struct

+ FilenameTemplate string

type SqlExporter

+ func (e *SqlExporter) Description() string

v1.1.0

Apr 14, 2024

Changes in this version

+ var BuiltinExporters = []Exporter

+ var BuiltinYAMLExporters = []string

+ func ExporterLogCustom(exporter Exporter, verb string, color string, message string, ...)

+ func ExporterLogCustomNoFormatting(exporter Exporter, verb string, color string, message string)

+ func LogCustomNoFormatting(verb string, color string, message string)

+ func ValidateAsJSONSchema(typ any, yaml bool, values any) []gojsonschema.ResultError

+ func ValidateExporterOptions(exporter Exporter, opts ExporterOptions) error

type Configuration

+ Exporters map[string]map[string]interface{}

+ type CustomExporter struct

+ func (e *CustomExporter) After(ctx *RunContext, opts ExporterOptions, db *Database) error

+ func (e *CustomExporter) Before(ctx *RunContext, opts ExporterOptions) error

+ func (e *CustomExporter) Export(ctx *RunContext, opts ExporterOptions, work *AnalyzedWork) error

+ func (e *CustomExporter) Name() string

+ func (e *CustomExporter) OptionsType() any

+ type Exporter interface

+ After func(ctx *RunContext, opts ExporterOptions, built *Database) error

+ Before func(ctx *RunContext, opts ExporterOptions) error

+ Export func(ctx *RunContext, opts ExporterOptions, work *AnalyzedWork) error

+ Name func() string

+ OptionsType func() any

+ type ExporterCommand struct

+ Log []string

+ Run string

+ type ExporterManifest struct

+ After []ExporterCommand

+ Before []ExporterCommand

+ Data map[string]any

+ Description string

+ Name string

+ Verbose bool

+ Work []ExporterCommand

+ type ExporterOptions interface

type Flags

+ ExportersToUse []string

type RunContext

+ Exporters []Exporter

+ func (ctx *RunContext) DownloadExporter(name string, url string, config map[string]any) (*CustomExporter, error)

+ func (ctx *RunContext) ExporterOptions(exporter Exporter) (ExporterOptions, error)

+ func (ctx *RunContext) FindExporter(name string) (Exporter, error)

+ func (ctx *RunContext) LoadExporter(name string, manifestRaw string, config map[string]any) (*CustomExporter, error)

+ func (ctx *RunContext) RunExporters(work *AnalyzedWork) error

+ type SqlExporter struct

+ func (e *SqlExporter) After(ctx *RunContext, opts ExporterOptions, built *Database) error

+ func (e *SqlExporter) Before(ctx *RunContext, opts ExporterOptions) error

+ func (e *SqlExporter) Export(ctx *RunContext, opts ExporterOptions, work *AnalyzedWork) error

+ func (e *SqlExporter) Name() string

+ func (e *SqlExporter) OptionsType() any

+ type SqlExporterOptions struct

+ Language string

+ Output string

v1.0.0

Apr 13, 2024

Changes in this version

+ const DefaultConfigurationFilename

+ const DefaultScatteredModeFolder

type Configuration

+ ProjectsDirectory string

type Database

+ func LoadDatabase(at string, skipValidation bool) (database Database, err error)

type RunContext

+ func (ctx *RunContext) ReplicateAll(targetDatabase string, works Database) error

+ func (ctx *RunContext) ReplicateDescription(work AnalyzedWork) (string, error)

+ func (ctx *RunContext) ReplicateOne(targetDatabase string, work AnalyzedWork) error

v0

v0.3.2

Apr 12, 2024

Changes in this version

type WorkMetadata

+ DatabaseMetadata DatabaseMeta

v0.3.1

Apr 12, 2024

v0.3.0

Apr 12, 2024

Changes in this version

+ func LastGitCommitDate(workingDirectory string) (time.Time, error)

v0.2.0

Apr 12, 2024

Changes in this version

type Flags

+ ProgressInfoFile string

+ type ProgressInfoEvent struct

+ Details []string

+ Phase BuildPhase

+ WorkID string

+ WorksDone int

+ WorksTotal int

type RunContext

+ ProgressInfoFile string

+ func (ctx *RunContext) DisplayError(msg string, err error, fmtArgs ...interface{})

+ func (ctx *RunContext) DisplayWarning(msg string, err error, fmtArgs ...interface{})

+ func (ctx *RunContext) StartProgressBar(total int)

+ func (ctx *RunContext) StopProgressBar()

v0.1.3

Apr 11, 2024

Changes in this version

+ const Version

+ func ConfigurationJSONSchema() string

+ func DatabaseJSONSchema() string

+ func TagsRepositoryJSONSchema() string

+ func TechnologiesRepositoryJSONSchema() string

v0.1.2

Apr 11, 2024

Changes in this version

type Configuration

+ Tags struct{ ... }

+ Technologies struct{ ... }

type RunContext

+ TagsRepository []Tag

+ TechnologiesRepository []Technology

+ func (ctx *RunContext) DetectTags(workId string, techs []Technology) (detecteds []Tag, err error)

+ func (ctx *RunContext) DetectTechnologies(workId string) (detecteds []Technology, err error)

+ func (ctx *RunContext) FindTag(name string) (result Tag, ok bool)

+ func (ctx *RunContext) FindTechnology(name string) (result Technology, ok bool)

+ func (ctx *RunContext) LoadTagsRepository() ([]Tag, error)

+ func (ctx *RunContext) LoadTechnologiesRepository() ([]Technology, error)

+ type Tag struct

+ Aliases []string

+ Description string

+ DetectConditions struct{ ... }

+ LearnMoreAt string

+ Plural string

+ Singular string

+ func (t Tag) Detect(ctx *RunContext, workId string, techs []Technology) (bool, error)

+ func (t Tag) ReferredToBy(name string) bool

+ func (t Tag) String() string

+ type Technology struct

+ Aliases []string

+ Autodetect []string

+ By string

+ Description string

+ Files []string

+ LearnMoreAt string

+ Name string

+ Slug string

+ func (t Technology) Detect(ctx *RunContext, workId string) (bool, error)

+ func (t Technology) ReferredToBy(name string) bool

+ func (t Technology) String() string

v0.1.1

Mar 19, 2024

v0.1.0

Dec 30, 2023

Changes in this version

+ const PatternAbbreviationDefinition

+ const PatternLanguageMarker

+ const RuneAutoplay

+ const RuneHideControls

+ const RuneLoop

+ var ThumbnailableContentTypes = []string

+ func AcquireBuildLock(outputFilename string) error

+ func AnalyzeAudio(file *os.File) uint

+ func BuildLockFilepath(outputFilename string) string

+ func DetectStartDate(workingDirectory string) (time.Time, error)

+ func DisplayValidationErrors(errors []gojsonschema.ResultError, filename string)

+ func FirstGitCommitDate(workingDirectory string) (time.Time, error)

+ func GatherPages(inside string) (paths []string, err error)

+ func HandleAltMediaEmbedSyntax(markdownRaw string) string

+ func LoadConfiguration(filename string, loadInto *Configuration) error

+ func LogCustom(verb string, color string, message string, fmtArgs ...interface{})

+ func MarkdownToHTML(markdownRaw string) string

+ func ParseDescription[Metadata interface{}](ctx *RunContext, markdownRaw string) (metadata Metadata, blocks map[string][]ContentBlock, ...)

+ func ParseYAMLHeader[Metadata interface{}](descriptionRaw string) (Metadata, string)

+ func ReadDescriptionFile(directory string) (string, error)

+ func ReplicateAll(ctx *RunContext, targetDatabase string, works []AnalyzedWork) error

+ func ReplicateDescription(work AnalyzedWork) (string, error)

+ func ReplicateOne(targetDatabase string, work AnalyzedWork) error

+ func ResolveBlockID(blocks []ContentBlock, language string, blockRef string) (string, error)

+ func RunCommandReplicate(args docopt.Opts) error

+ func SplitOnLanguageMarkers(markdownRaw string) (string, map[string]string)

+ func StartProgressBar(total int)

+ func ValidateConfiguration(configFilepath string) (bool, []gojsonschema.ResultError, error)

+ type Abbreviations map[string]string

+ type AnalyzedBlogPage struct

+ BuiltAt time.Time

+ Content map[string]LocalizedContent

+ Hash string

+ ID string

+ Metadata BlogMetadata

+ Partial bool

+ type AnalyzedWork struct

+ BuiltAt string

+ Content LocalizableContent

+ DescriptionHash string

+ ID string

+ Metadata WorkMetadata

+ Partial bool

+ func SortWorksByDate(works []AnalyzedWork) []AnalyzedWork

+ func (w AnalyzedWork) Colors(language string) ColorPalette

+ func (w AnalyzedWork) ThumbnailBlock(language string) Media

+ func (w AnalyzedWork) ThumbnailPath(language string, size int) FilePathInsideMediaRoot

+ func (work AnalyzedWork) FirstParagraph(lang string) (found bool, paragraph ContentBlock)

+ type Blog map[string]AnalyzedBlogPage

+ func BuildBlog(inside string) (blog Blog, err error)

+ type BlogMetadata struct

+ AdditionalMetadata map[string]interface{}

+ Aliases []string

+ Date time.Time

+ Private bool

+ Projects []string

+ Tags []string

+ Thumbnail FilePathInsidePortfolioFolder

+ type BuildMetadata struct

+ PreviousBuildDate time.Time

+ type BuildPhase string

+ const PhaseBuilding

+ const PhaseBuilt

+ const PhaseMediaAnalysis

+ const PhaseThumbnails

+ const PhaseUnchanged

+ type BuildSteps struct

+ ExtractColors ExtractColorsConfiguration

+ MakeGifs MakeGIFsConfiguration

+ MakeThumbnails MakeThumbnailsConfiguration

+ type ColorPalette struct

+ Primary string

+ Secondary string

+ Tertiary string

+ func ExtractColors(filename string) (ColorPalette, error)

+ func (colors ColorPalette) Empty() bool

+ type Configuration struct

+ BuildMetadataFilepath string

+ ExtractColors ExtractColorsConfiguration

+ IsDefault bool

+ MakeGifs MakeGIFsConfiguration

+ MakeThumbnails MakeThumbnailsConfiguration

+ Media struct{ ... }

+ ScatteredModeFolder string

+ func DefaultConfiguration() Configuration

+ func NewConfiguration(filename string, databaseDirectory string) (Configuration, error)

+ type ContentBlock struct

+ Anchor string

+ ID string

+ Index int

+ Type ContentBlockType

+ func ContentBlockByID(id string, blocks []ContentBlock) (block ContentBlock, ok bool)

+ func (b ContentBlock) AsLink() Link

+ func (b ContentBlock) AsMedia() Media

+ func (b ContentBlock) AsParagraph() Paragraph

+ type ContentBlockType string

+ func (t ContentBlockType) IsLink() bool

+ func (t ContentBlockType) IsMedia() bool

+ func (t ContentBlockType) IsParagraph() bool

+ func (t ContentBlockType) String() string

+ type Database map[string]AnalyzedWork

+ func (w Database) AsSlice() []AnalyzedWork

+ func (w Database) GroupWorksByYear() [][]AnalyzedWork

+ func (w Database) Languages() []string

+ func (w Database) Meta() DatabaseMeta

+ func (w Database) Partial() bool

+ func (w Database) Works() map[string]AnalyzedWork

+ func (w Database) WorksByDate() []AnalyzedWork

+ func (w Database) WorksSlice() []AnalyzedWork

+ type DatabaseMeta struct

+ Partial bool

+ type ExtractColorsConfiguration struct

+ DefaultFiles []string

+ Enabled bool

+ Extract []string

+ type FilePathInsideMediaRoot string

+ func (f FilePathInsideMediaRoot) URL(origin string) string

+ func (p FilePathInsideMediaRoot) Absolute(ctx *RunContext) string

+ type FilePathInsidePortfolioFolder string

+ func (f FilePathInsidePortfolioFolder) Absolute(ctx *RunContext, workID string) string

+ func (p FilePathInsidePortfolioFolder) RelativeToMediaRoot(ctx *RunContext, workID string) FilePathInsideMediaRoot

+ type Flags struct

+ Config string

+ Minified bool

+ NoCache bool

+ Scattered bool

+ Silent bool

+ WorkersCount int

+ type Footnotes map[string]HTMLString

+ type HTMLString string

+ func (html HTMLString) Markdown() string

+ func (s HTMLString) String() string

+ type ImageDimensions struct

+ AspectRatio float32

+ Height int

+ Width int

+ func AnalyzePDF(filename string) (dimensions ImageDimensions, pagesCount uint, err error)

+ func AnalyzeVideo(filename string) (dimensions ImageDimensions, duration uint, hasSound bool, err error)

+ func GetImageDimensions(file *os.File) (ImageDimensions, error)

+ func GetSVGDimensions(file *os.File) (ImageDimensions, error)

+ type Layout [][]LayoutCell

+ func ResolveLayout(metadata WorkMetadata, language string, blocks []ContentBlock) (Layout, error)

+ func (layout Layout) BlockIDs() (blockIDs []string)

+ func (layout Layout) Normalize() (normalized Layout)

+ type LayoutCell string

+ type Link struct

+ Text HTMLString

+ Title string

+ URL string

+ type LocalizableContent map[string]LocalizedContent

+ func (c LocalizableContent) Localize(lang string) LocalizedContent

+ type LocalizedContent struct

+ Blocks []ContentBlock

+ Footnotes Footnotes

+ Layout Layout

+ Title HTMLString

+ type MakeGIFsConfiguration struct

+ Enabled bool

+ FileNameTemplate string

+ type MakeThumbnailsConfiguration struct

+ Enabled bool

+ FileNameTemplate string

+ InputFile string

+ Sizes []int

+ type Media struct

+ Alt string

+ Analyzed bool

+ Attributes MediaAttributes

+ Caption string

+ Colors ColorPalette

+ ContentType string

+ Dimensions ImageDimensions

+ DistSource FilePathInsideMediaRoot

+ Duration float64

+ HasSound bool

+ Online bool

+ RelativeSource FilePathInsidePortfolioFolder

+ Size int

+ Thumbnails ThumbnailsMap

+ ThumbnailsBuiltAt string

+ func FindMedia(works Database, mediaEmbed Media, workID string) (found bool, media Media, builtAt time.Time)

+ func (m Media) Thumbnailable() bool

+ type MediaAttributes struct

+ Autoplay bool

+ Controls bool

+ Loop bool

+ Muted bool

+ Playsinline bool

+ func ExtractAttributesFromAlt(alt string) (string, MediaAttributes)

+ type Paragraph struct

+ Content HTMLString

+ func ReplaceAbbreviations(paragraph Paragraph, currentLanguageAbbreviations Abbreviations) Paragraph

+ type ParsedWork AnalyzedWork

+ type Project struct

+ Ctx *RunContext

+ Description ParsedWork

+ DescriptionRaw string

+ ID string

+ func (p *Project) ProjectPath() string

+ type RunContext struct

+ BuildMetadata BuildMetadata

+ Config *Configuration

+ DatabaseDirectory string

+ Flags Flags

+ OutputDatabaseFile string

+ PreviousBuiltDatabase Database

+ func PrepareBuild(databaseDirectory string, outputFilename string, flags Flags, ...) (*RunContext, error)

+ func (ctx *RunContext) AnalyzeMediaFile(workID string, embedDeclaration Media) (usedCache bool, analyzedMedia Media, anchor string, err error)

+ func (ctx *RunContext) Build(descriptionRaw string, outputFilename string, workID string) (AnalyzedWork, error)

+ func (ctx *RunContext) BuildAll(databaseDirectory string, outputFilename string, flags Flags, ...) (Database, error)

+ func (ctx *RunContext) BuildBlogPage(inside string, path string) (page AnalyzedBlogPage, err error)

+ func (ctx *RunContext) BuildSome(include string, databaseDirectory string, outputFilename string, flags Flags, ...) (Database, error)

+ func (ctx *RunContext) ComputeOutputThumbnailFilename(media Media, blockID string, projectID string, targetSize int, lang string) FilePathInsideMediaRoot

+ func (ctx *RunContext) ComputeProgressTotal() (workDirectories []fs.DirEntry, err error)

+ func (ctx *RunContext) CreateDescriptionFile(workId string, metadataItems []string) error

+ func (ctx *RunContext) DescriptionFilename(databaseDirectory string, workID string) string

+ func (ctx *RunContext) HandleMedia(workID string, blockID string, embedDeclaration Media, language string) (media Media, anchor string, err error)

+ func (ctx *RunContext) IncrementProgress()

+ func (ctx *RunContext) LogDebug(message string, fmtArgs ...interface{})

+ func (ctx *RunContext) LogError(message string, fmtArgs ...interface{})

+ func (ctx *RunContext) LogInfo(message string, fmtArgs ...interface{})

+ func (ctx *RunContext) LogWarning(message string, fmtArgs ...interface{})

+ func (ctx *RunContext) MakeThumbnail(media Media, targetSize int, saveTo string) error

+ func (ctx *RunContext) ParseSingleLanguageDescription(markdownRaw string) (title HTMLString, blocks []ContentBlock, footnotes Footnotes, ...)

+ func (ctx *RunContext) PathToWorkFolder(workID string) string

+ func (ctx *RunContext) ReleaseBuildLock(outputFilename string) error

+ func (ctx *RunContext) Status(workID string, phase BuildPhase, details ...string)

+ func (ctx *RunContext) UpdateBuildMetadata()

+ func (ctx *RunContext) UseCache(filename string, embedDeclaration Media, workID string) (used bool, media Media)

+ func (ctx *RunContext) WriteBuildMetadata() error

+ func (ctx *RunContext) WriteDatabase(works Database, flags Flags, outputFilename string, partial bool)

+ type ThumbnailsMap map[int]FilePathInsideMediaRoot

+ func (thumbnails ThumbnailsMap) Closest(size int) FilePathInsideMediaRoot

+ type TitleStyle string

+ type WorkMetadata struct

+ AdditionalMetadata map[string]interface{}

+ Aliases []string

+ Colors ColorPalette

+ Finished string

+ MadeWith []string

+ PageBackground string

+ Private bool

+ Started string

+ Tags []string

+ Thumbnail FilePathInsidePortfolioFolder

+ TitleStyle TitleStyle

+ WIP bool

+ func (m WorkMetadata) CreatedAt() time.Time

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