foswiki

package

v0.0.0-...-1d4517c Latest Latest Go to latest Published: May 19, 2016 License: MIT Imports: 12 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

This section is empty.

View Source

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

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

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

func NewBase64ImageWriter() *base64ImageWriter

func NewImageConverter(foswikiDoc Doc, imageWriter Base64ImageWriter) *imageConverter

NewImageConverter returns new imageConverter object.

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

type Dir struct {
	HomePath string
}

func (d *Dir) DataPath() string

DataPath returns the file path to the Foswiki data directory.

func (d *Dir) PubPath() string

PubPath returns the file path to the Foswiki pub directory.

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

SubdirsExists check if the needed Foswiki subdirectories exists.

type Doc struct {
	Path string
}

func (d Doc) PageName() string

PageName returns the page name of the current Foswiki document.

func (d Doc) PubDir() string

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

func (d Doc) WebName() string

WebName returns the web name of the current Foswiki document.