core

package

v0.0.20 Latest Latest Go to latest Published: Mar 9, 2026 License: BSD-3-Clause Imports: 46 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/speedata/xts

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func AddDir(dirname string) error
func FindFile(filename string) (string, error)
func FindFontFiles() []string
func FontFolder() (string, error)
func InitDirs(basedir string) error
func RunXTS(cfg *XTSConfig) error
type PublishingInfo
type TypesettingError
- func (te TypesettingError) Error() string
type VTrace
type XTSConfig

Constants ¶

View Source

const (
	// SDNAMESPACE is the speedata XTS layout rules namespace
	SDNAMESPACE string = "urn:speedata.de/2021/xts/en"
	// XHTMLNAMESPACE is used for literal HTML elements inside <HTML>
	XHTMLNAMESPACE string = "urn:speedata.de/2021/xhtml"
	// LevelNotice is used for messages from Message
	LevelNotice = slog.Level(2)
)

Variables ¶

View Source

var (

	// Version is a semantic version
	Version string
)

Functions ¶

func AddDir ¶

func AddDir(dirname string) error

AddDir recursively adds a directory to the file list

func FindFile ¶

func FindFile(filename string) (string, error)

FindFile returns the full path to the file name.

func FindFontFiles ¶

func FindFontFiles() []string

FindFontFiles returns a list of all font files (otf,ttf)

func FontFolder ¶

func FontFolder() (string, error)

FontFolder

func InitDirs ¶

func InitDirs(basedir string) error

InitDirs starts indexing the files.

func RunXTS ¶

func RunXTS(cfg *XTSConfig) error

RunXTS is the entry point

Types ¶

type PublishingInfo ¶ added in v0.0.19

type PublishingInfo struct {
	Pages    int
	FileSize int64
}

PublishingInfo contains information about a previous publishing run.

type TypesettingError ¶ added in v0.0.3

type TypesettingError struct {
	Logged  bool
	Msg     string
	Command string // layout command name, e.g. "DefineColor"
	Line    int    // line in the layout file, 0 if unknown
}

A TypesettingError is an error with optional layout position information.

func (TypesettingError) Error ¶ added in v0.0.3

func (te TypesettingError) Error() string

type VTrace ¶

type VTrace int

VTrace determines the type of visual tracing

const (
	// VTraceGrid shows the page grid
	VTraceGrid VTrace = iota
	// VTraceAllocation shows allocated cells
	VTraceAllocation
	// VTraceHyphenation shows hyphenation points
	VTraceHyphenation
	// VTraceObjects shows objects
	VTraceObjects
)

type XTSConfig ¶

type XTSConfig struct {
	Datafile     io.Reader
	DumpFile     io.Writer
	FindFile     func(string) (string, error)
	Jobname      string
	Layoutfile   io.Reader
	Mode         []string
	Outfile      io.WriteCloser
	OutFilename  string
	SuppressInfo bool
	Tracing      []string
	Variables    map[string]any
	Info         PublishingInfo
}

XTSConfig is the configuration file for PDF generation.

Source Files ¶

View all Source files

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