foswiki

Documentation

Index

• Variables
• func NewBase64Image(fileName string, data []byte) (*base64Image, error)
• func NewBase64ImageWriter() *base64ImageWriter
• func NewImageConverter(foswikiDoc Doc, imageWriter Base64ImageWriter) *imageConverter
• type Base64ImageWriter
• type Dir
  • func (d *Dir) DataPath() string
  • func (d *Dir) PubPath() string
  • func (d *Dir) SubdirsExists() (bool, error)
• type Doc
  • func (d Doc) PageName() string
  • func (d Doc) PubDir() string
  • func (d Doc) WebName() string

Variables

var FOSWIKI_SUBDIRS = map[string]string{
	"DATA": "data",
	"PUB":  "pub",
}

Functions

func NewBase64Image

func NewBase64Image(fileName string, data []byte) (*base64Image, error)

NewBase64 read a Foswiki image as base64 byte array and extract image metadata.

func NewBase64ImageWriter

func NewBase64ImageWriter() *base64ImageWriter

func NewImageConverter

func NewImageConverter(foswikiDoc Doc, imageWriter Base64ImageWriter) *imageConverter

NewImageConverter returns new imageConverter object.

Types

type Base64ImageWriter

type Base64ImageWriter interface {
	WriteImage(string, *base64Image) error
}

type Dir

type Dir struct {
	HomePath string
}

func (*Dir) DataPath

func (d *Dir) DataPath() string

DataPath returns the file path to the Foswiki data directory.

func (*Dir) PubPath

func (d *Dir) PubPath() string

PubPath returns the file path to the Foswiki pub directory.

func (*Dir) SubdirsExists

func (d *Dir) SubdirsExists() (bool, error)

SubdirsExists check if the needed Foswiki subdirectories exists.

type Doc

type Doc struct {
	Path string
}

func (Doc) PageName

func (d Doc) PageName() string

PageName returns the page name of the current Foswiki document.

func (Doc) PubDir

func (d Doc) PubDir() string

PubDir returns the path to the Foswiki pub folder for the current Foswiki document.

func (Doc) WebName

func (d Doc) WebName() string

WebName returns the web name of the current Foswiki document.