docx

README

Simple Google Go (Golang) library for replacing text in Microsoft Word (.docx) file

The following constitutes the bare minimum required to replace text in DOCX document.

import (
	"github.com/nguyenthenguyen/docx"
)

func main() {
	// Read from docx file
	r, err := docx.ReadDocxFile("./template.docx")
	// Or read from memory
	// r, err := docx.ReadDocxFromMemory(data io.ReaderAt, size int64)
	
	// Or read from a filesystem object:
	// r, err := docx.ReadDocxFromFS(file string, fs fs.FS)
	
	if err != nil {
		panic(err)
	}
	docx1 := r.Editable()
	// Replace like https://golang.org/pkg/strings/#Replace
	docx1.Replace("old_1_1", "new_1_1", -1)
	docx1.Replace("old_1_2", "new_1_2", -1)
	docx1.ReplaceLink("http://example.com/", "https://github.com/nguyenthenguyen/docx", 1)
	docx1.ReplaceHeader("out with the old", "in with the new")
	docx1.ReplaceFooter("Change This Footer", "new footer")
	docx1.WriteToFile("./new_result_1.docx")

	docx2 := r.Editable()
	docx2.Replace("old_2_1", "new_2_1", -1)
	docx2.Replace("old_2_2", "new_2_2", -1)
	docx2.WriteToFile("./new_result_2.docx")

	// Or write to ioWriter
	// docx2.Write(ioWriter io.Writer)

	docx3 := r.Editable()
	//Currently only swaps apples for apples i.e. png to png, and not png to jpeg etc.
	d.ReplaceImage("word/media/image1.png", "./new.png")
	docx3.WriteToFile("./new_result_3.docx")
	
	// replace the last image
	imageIndex := docxRaw.ImagesLen()
	d.ReplaceImage("word/media/image" strconv.Itoa(imageIndex) + ".png", "./new.png")

	r.Close()
}

Documentation

Index

• Constants
• type Docx
  • func (d *Docx) GetContent() string
  • func (d *Docx) ImagesLen() int
  • func (d *Docx) Replace(oldString string, newString string, num int) (err error)
  • func (d *Docx) ReplaceData(data map[string]interface{}) (err error)
  • func (d *Docx) ReplaceFooter(oldString string, newString string) (err error)
  • func (d *Docx) ReplaceHeader(oldString string, newString string) (err error)
  • func (d *Docx) ReplaceImage(oldImage string, newImage string) (err error)
  • func (d *Docx) ReplaceLink(oldString string, newString string, num int) (err error)
  • func (d *Docx) ReplaceRaw(oldString string, newString string, num int)
  • func (d *Docx) SetContent(content string)
  • func (d *Docx) Write(ioWriter io.Writer) (err error)
  • func (d *Docx) WriteToFile(path string) (err error)
• type ReplaceDocx
  • func ReadDocx(reader ZipData) (*ReplaceDocx, error)
  • func ReadDocxFile(path string) (*ReplaceDocx, error)
  • func ReadDocxFromFS(file string, fs fs.FS) (*ReplaceDocx, error)
  • func ReadDocxFromMemory(data io.ReaderAt, size int64) (*ReplaceDocx, error)
  • func (r *ReplaceDocx) Close() error
  • func (r *ReplaceDocx) Editable() *Docx
• type ZipData
• type ZipFile
• type ZipInMemory

Constants

const NEWLINE = "<w:br/>"

const TAB = "</w:t><w:tab/><w:t>"

To get Word to recognize a tab character, we have to first close off the previous text element. This means if there are multiple consecutive tabs, there are empty <w:t></w:t> in between but it still seems to work correctly in the output document, certainly better than other combinations I tried.

Types

type Docx

type Docx struct {
	// contains filtered or unexported fields
}

func (*Docx) GetContent

func (d *Docx) GetContent() string

func (*Docx) ImagesLen

func (d *Docx) ImagesLen() int

func (*Docx) Replace

func (d *Docx) Replace(oldString string, newString string, num int) (err error)

func (*Docx) ReplaceData

func (d *Docx) ReplaceData(data map[string]interface{}) (err error)

func (*Docx) ReplaceFooter

func (d *Docx) ReplaceFooter(oldString string, newString string) (err error)

func (*Docx) ReplaceHeader

func (d *Docx) ReplaceHeader(oldString string, newString string) (err error)

func (*Docx) ReplaceImage

func (d *Docx) ReplaceImage(oldImage string, newImage string) (err error)

func (*Docx) ReplaceLink

func (d *Docx) ReplaceLink(oldString string, newString string, num int) (err error)

func (*Docx) ReplaceRaw

func (d *Docx) ReplaceRaw(oldString string, newString string, num int)

func (*Docx) SetContent

func (d *Docx) SetContent(content string)

func (*Docx) Write

func (d *Docx) Write(ioWriter io.Writer) (err error)

func (*Docx) WriteToFile

func (d *Docx) WriteToFile(path string) (err error)

type ReplaceDocx

type ReplaceDocx struct {
	// contains filtered or unexported fields
}

func ReadDocx

func ReadDocx(reader ZipData) (*ReplaceDocx, error)

func ReadDocxFile

func ReadDocxFile(path string) (*ReplaceDocx, error)

func ReadDocxFromFS

func ReadDocxFromFS(file string, fs fs.FS) (*ReplaceDocx, error)

ReadDocxFromFS opens a docx file from the file system

func ReadDocxFromMemory

func ReadDocxFromMemory(data io.ReaderAt, size int64) (*ReplaceDocx, error)

func (*ReplaceDocx) Close

func (r *ReplaceDocx) Close() error

func (*ReplaceDocx) Editable

func (r *ReplaceDocx) Editable() *Docx

type ZipData

type ZipData interface {
	// contains filtered or unexported methods
}

Contains functions to work with data from a zip file

type ZipFile

type ZipFile struct {
	// contains filtered or unexported fields
}

Type for zip files read from disk

type ZipInMemory

type ZipInMemory struct {
	// contains filtered or unexported fields
}

Type for in memory zip files