Merge pull request #29 from securityguy/master

Fix example code so that it compiles and added as a go file

Author: nguyenthenguyen

README.md

@@ -3,19 +3,23 @@
 The following constitutes the bare minimum required to replace text in DOCX document.
 ``` go
 
+package main
+
 import (
+	"strconv"
+
 	"github.com/nguyenthenguyen/docx"
 )
 
 func main() {
 	// Read from docx file
-	r, err := docx.ReadDocxFile("./template.docx")
+	r, err := docx.ReadDocxFile("./TestDocument.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)
 	}
@@ -38,12 +42,12 @@ func main() {
 
 	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")
-	
+	docx3.ReplaceImage("word/media/image1.png", "./new.png")
+
 	// replace the last image
-	imageIndex := docxRaw.ImagesLen()
-	d.ReplaceImage("word/media/image" strconv.Itoa(imageIndex) + ".png", "./new.png")
+	imageIndex := docx3.ImagesLen()
+	docx3.ReplaceImage("word/media/image"+strconv.Itoa(imageIndex)+".png", "./new.png")
+	docx3.WriteToFile("./new_result_3.docx")
 
 	r.Close()
 }

example/example.go

@@ -0,0 +1,51 @@
+package main
+
+import (
+	"strconv"
+
+	"github.com/nguyenthenguyen/docx"
+)
+
+// Note - this sample code does not perform error checking, etc.
+
+func main() {
+
+	// Read from docx file
+	r, err := docx.ReadDocxFile("./TestDocument.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.
+	docx3.ReplaceImage("word/media/image1.png", "./new.png")
+
+	// replace the last image
+	imageIndex := docx3.ImagesLen()
+	docx3.ReplaceImage("word/media/image"+strconv.Itoa(imageIndex)+".png", "./new.png")
+	docx3.WriteToFile("./new_result_3.docx")
+
+	r.Close()
+}