main.go

/*
MIT License

Copyright (c) 2025 Misael Monterroca
Copyright (c) 2020-2023 fumiama (original go-docx)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

package main

import (
	"fmt"
	"log"
	"strings"

	docx "github.com/mmonterroca/docxgo"
	"github.com/mmonterroca/docxgo/domain"
)

func main() {
	// Create a new document
	doc := docx.NewDocument()

	// Example 1: Add page numbers to footer
	if err := addPageNumbers(doc); err != nil {
		log.Fatalf("Failed to add page numbers: %v", err)
	}

	// Example 2: Add Table of Contents
	if err := addTableOfContents(doc); err != nil {
		log.Fatalf("Failed to add TOC: %v", err)
	}

	// Example 3: Add content with headings
	if err := addContent(doc); err != nil {
		log.Fatalf("Failed to add content: %v", err)
	}

	// Example 4: Add hyperlinks
	if err := addHyperlinks(doc); err != nil {
		log.Fatalf("Failed to add hyperlinks: %v", err)
	}

	// Save the document
	if err := doc.SaveAs("fields_example.docx"); err != nil {
		log.Fatalf("Failed to save document: %v", err)
	}

	fmt.Println("Document created successfully: fields_example.docx")
	fmt.Println("\nNote: Open the document in Word and press F9 to update all fields.")
}

// addPageNumbers adds page numbers to the default footer
func addPageNumbers(doc domain.Document) error {
	// Get the default section
	section, err := doc.DefaultSection()
	if err != nil {
		return fmt.Errorf("get default section: %w", err)
	}

	// Get the default footer
	footer, err := section.Footer(domain.FooterDefault)
	if err != nil {
		return fmt.Errorf("get footer: %w", err)
	}

	// Add a paragraph to the footer
	para, err := footer.AddParagraph()
	if err != nil {
		return fmt.Errorf("add paragraph: %w", err)
	}

	// Set center alignment
	para.SetAlignment(domain.AlignmentCenter)

	// Add text before page number
	run1, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add run: %w", err)
	}
	run1.AddText("Page ")

	// Add page number field
	run2, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add run: %w", err)
	}
	pageField := docx.NewPageNumberField()
	run2.AddField(pageField)

	// Add text after page number
	run3, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add run: %w", err)
	}
	run3.AddText(" of ")

	// Add total page count field
	run4, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add run: %w", err)
	}
	pageCountField := docx.NewPageCountField()
	run4.AddField(pageCountField)

	return nil
}

// addTableOfContents adds a TOC at the beginning of the document
func addTableOfContents(doc domain.Document) error {
	// Add TOC heading
	heading, err := doc.AddParagraph()
	if err != nil {
		return fmt.Errorf("add heading: %w", err)
	}
	heading.SetStyle("Heading1")
	run, err := heading.AddRun()
	if err != nil {
		return fmt.Errorf("add run: %w", err)
	}
	run.AddText("Table of Contents")

	// Add TOC paragraph
	tocPara, err := doc.AddParagraph()
	if err != nil {
		return fmt.Errorf("add TOC paragraph: %w", err)
	}

	// Create TOC field with custom options
	tocOptions := map[string]string{
		"levels":     "1-3",  // Include heading levels 1-3
		"hyperlinks": "true", // Enable hyperlinks
	}
	tocField := docx.NewTOCField(tocOptions)

	// Add TOC field to paragraph
	tocRun, err := tocPara.AddRun()
	if err != nil {
		return fmt.Errorf("add TOC run: %w", err)
	}
	tocRun.AddField(tocField)

	// Add page break after TOC
	doc.AddPageBreak()

	return nil
}

// addContent adds sample content with headings
func addContent(doc domain.Document) error {
	sections := []struct {
		heading string
		content string
		level   string
	}{
		{
			heading: "Introduction",
			content: "This document demonstrates the use of fields in Word documents. Fields are dynamic elements that can display automatically calculated values such as page numbers, dates, or cross-references.",
			level:   "Heading1",
		},
		{
			heading: "Page Numbering",
			content: "The footer contains page numbers that are automatically calculated. The format used is 'Page X of Y', where X is the current page and Y is the total number of pages.",
			level:   "Heading2",
		},
		{
			heading: "Table of Contents",
			content: "The TOC at the beginning is generated from the heading styles in the document. In Word, you can update it by right-clicking and selecting 'Update Field', or by pressing F9.",
			level:   "Heading2",
		},
		{
			heading: "Hyperlinks",
			content: "Hyperlinks are also implemented as fields. They allow linking to external URLs or internal bookmarks.",
			level:   "Heading2",
		},
		{
			heading: "Advanced Features",
			content: "Additional field types supported include STYLEREF for running headers, SEQ for sequence numbering, and custom fields for specialized needs.",
			level:   "Heading1",
		},
		{
			heading: "Cross-References",
			content: "Cross-references can be created using REF fields, allowing you to reference other parts of the document by bookmark name.",
			level:   "Heading2",
		},
		{
			heading: "Date and Time",
			content: "DATE and TIME fields automatically insert the current date or time, with optional formatting switches.",
			level:   "Heading2",
		},
	}

	var lastHeading1 string
	const sequenceBookmarkName = "_RefFigureSequence1"
	const sequenceBookmarkID = "200"
	sequenceNumber := "1"

	for _, section := range sections {
		// Add heading
		heading, err := doc.AddParagraph()
		if err != nil {
			return fmt.Errorf("add heading: %w", err)
		}
		heading.SetStyle(section.level)
		run, err := heading.AddRun()
		if err != nil {
			return fmt.Errorf("add run: %w", err)
		}
		run.AddText(section.heading)

		if section.level == "Heading1" {
			lastHeading1 = section.heading
		}

		// Add content
		para, err := doc.AddParagraph()
		if err != nil {
			return fmt.Errorf("add paragraph: %w", err)
		}
		contentRun, err := para.AddRun()
		if err != nil {
			return fmt.Errorf("add content run: %w", err)
		}
		contentRun.AddText(section.content)

		if section.heading == "Date and Time" {
			datePara, err := doc.AddParagraph()
			if err != nil {
				return fmt.Errorf("add date paragraph: %w", err)
			}
			dateLabelRun, err := datePara.AddRun()
			if err != nil {
				return fmt.Errorf("add date label run: %w", err)
			}
			dateLabelRun.AddText("Current date: ")

			dateFieldRun, err := datePara.AddRun()
			if err != nil {
				return fmt.Errorf("add date field run: %w", err)
			}
			dateField := docx.NewField(domain.FieldTypeDate)
			if err := dateField.SetCode(`DATE \@ "MMMM d, yyyy"`); err != nil {
				return fmt.Errorf("configure date field: %w", err)
			}
			if err := dateFieldRun.AddField(dateField); err != nil {
				return fmt.Errorf("add date field: %w", err)
			}

			timePara, err := doc.AddParagraph()
			if err != nil {
				return fmt.Errorf("add time paragraph: %w", err)
			}
			timeLabelRun, err := timePara.AddRun()
			if err != nil {
				return fmt.Errorf("add time label run: %w", err)
			}
			timeLabelRun.AddText("Current time: ")

			timeFieldRun, err := timePara.AddRun()
			if err != nil {
				return fmt.Errorf("add time field run: %w", err)
			}
			timeField := docx.NewField(domain.FieldTypeTime)
			if err := timeField.SetCode(`TIME \@ "HH:mm"`); err != nil {
				return fmt.Errorf("configure time field: %w", err)
			}
			if err := timeFieldRun.AddField(timeField); err != nil {
				return fmt.Errorf("add time field: %w", err)
			}

			timePara.SetSpacingAfter(200)
		} else if section.heading == "Advanced Features" {
			stylePara, err := doc.AddParagraph()
			if err != nil {
				return fmt.Errorf("add style-ref paragraph: %w", err)
			}
			styleRun, err := stylePara.AddRun()
			if err != nil {
				return fmt.Errorf("add style-ref label run: %w", err)
			}
			styleRun.AddText("Running header (STYLEREF Heading 1): ")

			styleFieldRun, err := stylePara.AddRun()
			if err != nil {
				return fmt.Errorf("add style-ref field run: %w", err)
			}
			styleField := docx.NewStyleRefField("Heading 1")
			if err := styleField.SetCode(`STYLEREF "Heading 1" \* MERGEFORMAT`); err != nil {
				return fmt.Errorf("configure style-ref field: %w", err)
			}
			if setter, ok := styleField.(interface{ SetResult(string) }); ok {
				display := lastHeading1
				if strings.TrimSpace(display) == "" {
					display = "Heading 1 (update fields)"
				}
				setter.SetResult(display)
			}
			if err := styleFieldRun.AddField(styleField); err != nil {
				return fmt.Errorf("add style-ref field: %w", err)
			}

			seqPara, err := doc.AddParagraph()
			if err != nil {
				return fmt.Errorf("add sequence paragraph: %w", err)
			}
			if err := seqPara.SetStyle("Caption"); err != nil {
				return fmt.Errorf("set caption style: %w", err)
			}
			seqLabelRun, err := seqPara.AddRun()
			if err != nil {
				return fmt.Errorf("add sequence label run: %w", err)
			}
			seqLabelRun.AddText("Figure ")

			seqFieldRun, err := seqPara.AddRun()
			if err != nil {
				return fmt.Errorf("add sequence field run: %w", err)
			}
			seqField := docx.NewField(domain.FieldTypeSeq)
			if err := seqField.SetCode(`SEQ Figure \* ARABIC`); err != nil {
				return fmt.Errorf("configure sequence field: %w", err)
			}
			if setter, ok := seqField.(interface{ SetResult(string) }); ok {
				setter.SetResult(sequenceNumber)
			}
			if err := seqFieldRun.AddField(seqField); err != nil {
				return fmt.Errorf("add sequence field: %w", err)
			}

			seqTitleRun, err := seqPara.AddRun()
			if err != nil {
				return fmt.Errorf("add sequence title run: %w", err)
			}
			seqTitleRun.AddText(" – Sample sequence field")

			if bookmarkable, ok := seqPara.(interface{ SetBookmark(string, string) }); ok {
				bookmarkable.SetBookmark(sequenceBookmarkID, sequenceBookmarkName)
			}

			seqPara.SetSpacingAfter(200)
		} else if section.heading == "Cross-References" {
			refPara, err := doc.AddParagraph()
			if err != nil {
				return fmt.Errorf("add cross-reference paragraph: %w", err)
			}
			refIntroRun, err := refPara.AddRun()
			if err != nil {
				return fmt.Errorf("add cross-reference intro run: %w", err)
			}
			refIntroRun.AddText("See ")

			refFieldRun, err := refPara.AddRun()
			if err != nil {
				return fmt.Errorf("add cross-reference field run: %w", err)
			}
			refField := docx.NewField(domain.FieldTypeRef)
			if err := refField.SetCode(fmt.Sprintf("REF %s \\h", sequenceBookmarkName)); err != nil {
				return fmt.Errorf("configure cross-reference field: %w", err)
			}
			if setter, ok := refField.(interface{ SetResult(string) }); ok {
				setter.SetResult(fmt.Sprintf("Figure %s", sequenceNumber))
			}
			if err := refFieldRun.AddField(refField); err != nil {
				return fmt.Errorf("add cross-reference field: %w", err)
			}

			refSuffixRun, err := refPara.AddRun()
			if err != nil {
				return fmt.Errorf("add cross-reference suffix run: %w", err)
			}
			refSuffixRun.AddText(" for the sequence field output above.")

			refPara.SetSpacingAfter(200)
		}

		// Add spacing
		para.SetSpacingAfter(200) // 200 twips
	}

	return nil
}

// addHyperlinks adds example hyperlinks to the document
func addHyperlinks(doc domain.Document) error {
	// Add section heading
	heading, err := doc.AddParagraph()
	if err != nil {
		return fmt.Errorf("add heading: %w", err)
	}
	heading.SetStyle("Heading1")
	run, err := heading.AddRun()
	if err != nil {
		return fmt.Errorf("add run: %w", err)
	}
	run.AddText("Useful Links")

	// Add paragraph with hyperlinks
	para, err := doc.AddParagraph()
	if err != nil {
		return fmt.Errorf("add paragraph: %w", err)
	}

	// Text before link
	textRun, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add text run: %w", err)
	}
	textRun.AddText("For more information, visit ")

	// Hyperlink
	linkRun, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add link run: %w", err)
	}
	linkRun.SetColor(docx.Blue)
	linkRun.SetUnderline(domain.UnderlineSingle)

	hyperlinkField := docx.NewHyperlinkField("https://github.com/mmonterroca/docxgo", "go-docx repository")
	linkRun.AddField(hyperlinkField)

	// Text after link
	textRun2, err := para.AddRun()
	if err != nil {
		return fmt.Errorf("add text run: %w", err)
	}
	textRun2.AddText(" on GitHub.")

	return nil
}