Merge pull request #166 from dolanmiu/feat/table-of-contents

Feat/table of contents

.gitignore

@@ -57,3 +57,6 @@ yarn.lock
 
 # Documents
 My Document.docx
+
+# Temporary folder 
+tmp

demo/demo28.ts

@@ -0,0 +1,43 @@
+// Creates two paragraphs, one with a border and one without
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { File, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
+
+const doc = new File();
+
+// The first argument is an ID you use to apply the style to paragraphs
+// The second argument is a human-friendly name to show in the UI
+doc.Styles.createParagraphStyle("MySpectacularStyle", "My Spectacular Style")
+    .basedOn("Heading1")
+    .next("Heading1")
+    .color("990000")
+    .italics();
+
+// WordprocessingML docs for TableOfContents can be found here:
+// http://officeopenxml.com/WPtableOfContents.php
+
+// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
+// making the entries be hyperlinks for the paragraph
+const toc = new TableOfContents("Summary", {
+    hyperlink: true,
+    headingStyleRange: "1-5",
+    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
+});
+
+doc.addTableOfContents(toc);
+
+doc.addParagraph(new Paragraph("Header #1").heading1().pageBreakBefore());
+doc.addParagraph(new Paragraph("I'm a little text very nicely written.'"));
+
+doc.addParagraph(new Paragraph("Header #2").heading1().pageBreakBefore());
+doc.addParagraph(new Paragraph("I'm a other text very nicely written.'"));
+doc.addParagraph(new Paragraph("Header #2.1").heading2());
+doc.addParagraph(new Paragraph("I'm a another text very nicely written.'"));
+
+doc.addParagraph(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore());
+
+const packer = new Packer();
+
+packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

docs/usage/table-of-contents.md

@@ -0,0 +1,76 @@
+# Table of Contents
+
+You can generate table of contents with `docx`. More information can be found [here](http://officeopenxml.com/WPtableOfContents.php).
+
+>Tables of Contents are fields and, by design, it's content is only generated or updated by Word. We can't do it programatically.
+>This is why, when you open a the file, Word you will prompt the message "This document contains fields that may refer to other files. Do you want to update the fields in this document?".
+>You have say yes to Word generate the content of all table of contents.
+
+The complete documentation can be found [here](https://www.ecma-international.org/publications/standards/Ecma-376.htm) (at Part 1, Page 1251).
+
+## How to
+
+All you need to do is create a `TableOfContents` object and assign it to the document.
+
+```js
+const toc = new TableOfContents("Summary", {
+    hyperlink: true,
+    headingStyleRange: "1-5",
+    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)]
+});
+
+doc.addTableOfContents(toc);
+```
+
+## Table of Contents Properties
+
+Here is the list of all properties that you can use to generate your tables of contents:
+
+| Option | Type | TOC Field Switch | Description |
+| --- | --- | --- | --- |
+|captionLabel|string|`\a`|Includes captioned items, but omits caption labels and numbers. The identifier designated by `text` in this switch's field-argument corresponds to the caption label. Use ``\c`` to build a table of captions with labels and numbers.|
+|entriesFromBookmark|string|`\b`|Includes entries only from the portion of the document marked by the bookmark named by `text` in this switch's field-argument.|
+|captionLabelIncludingNumbers|string|`\c`|Includes figures, tables, charts, and other items that are numbered by a SEQ field (§17.16.5.56). The sequence identifier designated by `text` in this switch's field-argument, which corresponds to the caption label,  shall match the identifier in the corresponding SEQ field.|
+|sequenceAndPageNumbersSeparator|string|`\d`|When used with `\s`, the `text` in this switch's field-argument defines the separator between sequence and page numbers. The default separator is a hyphen (-).|
+|tcFieldIdentifier|string|`\f`|Includes only those TC fields whose identifier exactly matches the `text` in this switch's field-argument (which is typically a letter).|
+|hyperlink|boolean|`\h`|Makes the table of contents entries hyperlinks.|
+|tcFieldLevelRange|string|`\l`|Includes TC fields that assign entries to one of the levels specified by `text` in this switch's field-argument as a range having the form startLevel-endLevel, where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel. TC fields that assign entries to lower levels are skipped.|
+|pageNumbersEntryLevelsRange|string|`\n`|Without field-argument, omits page numbers from the table of contents. Page numbers are omitted from all levels unless a range of entry levels is specified by `text` in this switch's field-argument. A range is specified as for `\l`.|
+|headingStyleRange|string|`\o`|Uses paragraphs formatted with all or the specified range of builtin heading styles. Headings in a style range are specified by `text` in this switch's field-argument using the notation specified as for `\l`, where each integer corresponds to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1). If no heading range is specified, all heading levels used in the document are listed.|
+|entryAndPageNumberSeparator|string|`\p`|`text` in this switch's field-argument specifies a sequence of characters that separate an entry and its page number. The default is a tab with leader dots.|
+|seqFieldIdentifierForPrefix|string|`\s`|For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number. The prefix depends on the type of entry. `text` in this switch's field-argument shall match the identifier in the SEQ field.|
+|stylesWithLevels|StyleLevel[]|`\t`| Uses paragraphs formatted with styles other than the built-in heading styles. `text` in this switch's field-argument specifies those styles as a set of comma-separated doublets, with each doublet being a comma-separated set of style name and table of content level. `\t` can be combined with `\o`.|
+|useAppliedParagraphOutlineLevel|boolean|`\u`|Uses the applied paragraph outline level.|
+|preserveTabInEntries|boolean|`\w`|Preserves tab entries within table entries.|
+|preserveNewLineInEntries|boolean|`\x`|Preserves newline characters within table entries.|
+|hideTabAndPageNumbersInWebView|boolean|`\z`|Hides tab leader and page numbers in web page view (§17.18.102).|
+
+## Examples
+
+```js
+// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
+// making the entries be hyperlinks for the paragraph
+const toc = new TableOfContents("Summary", {
+    hyperlink: true,
+    headingStyleRange: "1-5",
+    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)]
+});
+
+doc.addTableOfContents(toc);
+
+doc.addParagraph(new Paragraph("Header #1").heading1().pageBreakBefore());
+doc.addParagraph(new Paragraph("I'm a little text, very nicely written.'"));
+
+doc.addParagraph(new Paragraph("Header #2").heading1().pageBreakBefore());
+doc.addParagraph(new Paragraph("I'm another text very nicely written.'"));
+doc.addParagraph(new Paragraph("Header #2.1").heading2());
+doc.addParagraph(new Paragraph("I'm another text very nicely written.'"));
+
+doc.addParagraph(new Paragraph("My Spectacular Style #1").style("MySpectacularStyle").pageBreakBefore());
+```
+
+### Complete example
+
+[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo28.ts ":include")
+
+_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo28.ts_

src/export/packer/next-compiler.spec.ts

@@ -19,7 +19,7 @@ describe("Compiler", () => {
             const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name);
 
             expect(fileNames).is.an.instanceof(Array);
-            expect(fileNames).has.length(17);
+            expect(fileNames).has.length(18);
             expect(fileNames).to.include("word/document.xml");
             expect(fileNames).to.include("word/styles.xml");
             expect(fileNames).to.include("docProps/core.xml");
@@ -29,6 +29,7 @@ describe("Compiler", () => {
             expect(fileNames).to.include("word/_rels/header1.xml.rels");
             expect(fileNames).to.include("word/footer1.xml");
             expect(fileNames).to.include("word/footnotes.xml");
+            expect(fileNames).to.include("word/settings.xml");
             expect(fileNames).to.include("word/_rels/footer1.xml.rels");
             expect(fileNames).to.include("word/_rels/document.xml.rels");
             expect(fileNames).to.include("[Content_Types].xml");
@@ -47,7 +48,7 @@ describe("Compiler", () => {
             const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name);
 
             expect(fileNames).is.an.instanceof(Array);
-            expect(fileNames).has.length(25);
+            expect(fileNames).has.length(26);
 
             expect(fileNames).to.include("word/header1.xml");
             expect(fileNames).to.include("word/_rels/header1.xml.rels");

src/export/packer/next-compiler.ts

@@ -23,6 +23,7 @@ interface IXmlifyedFileMapping {
     ContentTypes: IXmlifyedFile;
     AppProperties: IXmlifyedFile;
     FootNotes: IXmlifyedFile;
+    Settings: IXmlifyedFile;
 }
 
 export class Compiler {
@@ -62,6 +63,7 @@ export class Compiler {
     }
 
     private xmlifyFile(file: File): IXmlifyedFileMapping {
+        file.verifyUpdateFields();
         return {
             Document: {
                 data: xml(this.formatter.format(file.Document), true),
@@ -120,6 +122,10 @@ export class Compiler {
                 data: xml(this.formatter.format(file.FootNotes)),
                 path: "word/footnotes.xml",
             },
+            Settings: {
+                data: xml(this.formatter.format(file.Settings)),
+                path: "word/settings.xml",
+            },
         };
     }
 }

src/file/document/body/body.ts

@@ -1,5 +1,5 @@
 import { IXmlableObject, XmlComponent } from "file/xml-components";
-import { Paragraph, ParagraphProperties } from "../..";
+import { Paragraph, ParagraphProperties, TableOfContents } from "../..";
 import { SectionProperties, SectionPropertiesOptions } from "./section-properties/section-properties";
 
 export class Body extends XmlComponent {
@@ -53,6 +53,14 @@ export class Body extends XmlComponent {
         return this.defaultSection;
     }
 
+    public getTablesOfContents(): TableOfContents[] {
+        return this.root.filter((child) => child instanceof TableOfContents) as TableOfContents[];
+    }
+
+    public getParagraphs(): Paragraph[] {
+        return this.root.filter((child) => child instanceof Paragraph) as Paragraph[];
+    }
+
     private createSectionParagraph(section: SectionProperties): Paragraph {
         const paragraph = new Paragraph();
         const properties = new ParagraphProperties();

src/file/document/document.ts

@@ -2,6 +2,7 @@
 import { XmlComponent } from "file/xml-components";
 import { Paragraph } from "../paragraph";
 import { Table } from "../table";
+import { TableOfContents } from "../table-of-contents";
 import { Body } from "./body";
 import { SectionPropertiesOptions } from "./body/section-properties";
 import { DocumentAttributes } from "./document-attributes";
@@ -41,6 +42,11 @@ export class Document extends XmlComponent {
         return this;
     }
 
+    public addTableOfContents(toc: TableOfContents): Document {
+        this.body.push(toc);
+        return this;
+    }
+
     public createParagraph(text?: string): Paragraph {
         const para = new Paragraph(text);
         this.addParagraph(para);
@@ -60,4 +66,12 @@ export class Document extends XmlComponent {
     public get Body(): Body {
         return this.body;
     }
+
+    public getTablesOfContents(): TableOfContents[] {
+        return this.body.getTablesOfContents();
+    }
+
+    public getParagraphs(): Paragraph[] {
+        return this.body.getParagraphs();
+    }
 }

src/file/file.ts

@@ -10,10 +10,12 @@ import { Image, Media } from "./media";
 import { Numbering } from "./numbering";
 import { Bookmark, Hyperlink, Paragraph } from "./paragraph";
 import { Relationships } from "./relationships";
+import { Settings } from "./settings";
 import { Styles } from "./styles";
 import { ExternalStylesFactory } from "./styles/external-styles-factory";
 import { DefaultStylesFactory } from "./styles/factory";
 import { Table } from "./table";
+import { TableOfContents } from "./table-of-contents";
 
 export class File {
     private readonly document: Document;
@@ -26,6 +28,7 @@ export class File {
     private readonly headerWrapper: HeaderWrapper[] = [];
     private readonly footerWrapper: FooterWrapper[] = [];
     private readonly footNotes: FootNotes;
+    private readonly settings: Settings;
 
     private readonly contentTypes: ContentTypes;
     private readonly appProperties: AppProperties;
@@ -105,6 +108,11 @@ export class File {
             sectionPropertiesOptions.footerId = footer.Footer.ReferenceId;
         }
         this.document = new Document(sectionPropertiesOptions);
+        this.settings = new Settings();
+    }
+
+    public addTableOfContents(toc: TableOfContents): void {
+        this.document.addTableOfContents(toc);
     }
 
     public addParagraph(paragraph: Paragraph): void {
@@ -281,4 +289,14 @@ export class File {
     public get FootNotes(): FootNotes {
         return this.footNotes;
     }
+
+    public get Settings(): Settings {
+        return this.settings;
+    }
+
+    public verifyUpdateFields(): void {
+        if (this.document.getTablesOfContents().length) {
+            this.settings.addUpdateFields();
+        }
+    }
 }

src/file/index.ts

@@ -6,4 +6,5 @@ export * from "./media";
 export * from "./drawing";
 export * from "./document";
 export * from "./styles";
+export * from "./table-of-contents";
 export * from "./xml-components";

src/file/paragraph/formatting/style.ts

@@ -1,11 +1,14 @@
 import { Attributes, XmlComponent } from "file/xml-components";
 
 export class Style extends XmlComponent {
-    constructor(type: string) {
+    public readonly styleId: string;
+
+    constructor(styleId: string) {
         super("w:pStyle");
+        this.styleId = styleId;
         this.root.push(
             new Attributes({
-                val: type,
+                val: styleId,
             }),
         );
     }

src/file/paragraph/formatting/tab-stop.spec.ts

@@ -1,7 +1,7 @@
 import { assert } from "chai";
 
 import { Utility } from "../../../tests/utility";
-import { LeftTabStop, MaxRightTabStop } from "./tab-stop";
+import { LeftTabStop, MaxRightTabStop, RightTabStop } from "./tab-stop";
 
 describe("LeftTabStop", () => {
     let tabStop: LeftTabStop;
@@ -28,7 +28,28 @@ describe("LeftTabStop", () => {
 });
 
 describe("RightTabStop", () => {
-    // TODO
+    let tabStop: RightTabStop;
+
+    beforeEach(() => {
+        tabStop = new RightTabStop(100, "dot");
+    });
+
+    describe("#constructor()", () => {
+        it("should create a Tab Stop with correct attributes", () => {
+            const newJson = Utility.jsonify(tabStop);
+            const attributes = {
+                val: "right",
+                pos: 100,
+                leader: "dot",
+            };
+            assert.equal(JSON.stringify(newJson.root[0].root[0].root), JSON.stringify(attributes));
+        });
+
+        it("should create a Tab Stop with w:tab", () => {
+            const newJson = Utility.jsonify(tabStop);
+            assert.equal(newJson.root[0].rootKey, "w:tab");
+        });
+    });
 });
 
 describe("MaxRightTabStop", () => {

src/file/paragraph/formatting/tab-stop.ts

@@ -2,50 +2,52 @@
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 
 export class TabStop extends XmlComponent {
-    constructor(tab: Tab) {
+    constructor(tab: TabStopItem) {
         super("w:tabs");
         this.root.push(tab);
     }
 }
 
 export type TabValue = "left" | "right" | "center" | "bar" | "clear" | "decimal" | "end" | "num" | "start";
+export type LeaderType = "dot" | "hyphen" | "middleDot" | "none" | "underscore";
 
-export class TabAttributes extends XmlAttributeComponent<{ val: TabValue; pos: string | number }> {
+export class TabAttributes extends XmlAttributeComponent<{ val: TabValue; pos: string | number; leader?: LeaderType }> {
-    protected xmlKeys = { val: "w:val", pos: "w:pos" };
+    protected xmlKeys = { val: "w:val", pos: "w:pos", leader: "w:leader" };
 }
 
-export class Tab extends XmlComponent {
+export class TabStopItem extends XmlComponent {
-    constructor(value: TabValue, position: string | number) {
+    constructor(value: TabValue, position: string | number, leader?: LeaderType) {
         super("w:tab");
         this.root.push(
             new TabAttributes({
                 val: value,
                 pos: position,
+                leader,
             }),
         );
     }
 }
 
 export class MaxRightTabStop extends TabStop {
-    constructor() {
+    constructor(leader?: LeaderType) {
-        super(new Tab("right", 9026));
+        super(new TabStopItem("right", 9026, leader));
     }
 }
 
 export class LeftTabStop extends TabStop {
-    constructor(position: number) {
+    constructor(position: number, leader?: LeaderType) {
-        super(new Tab("left", position));
+        super(new TabStopItem("left", position, leader));
     }
 }
 
 export class RightTabStop extends TabStop {
-    constructor(position: number) {
+    constructor(position: number, leader?: LeaderType) {
-        super(new Tab("right", position));
+        super(new TabStopItem("right", position, leader));
     }
 }
 
 export class CenterTabStop extends TabStop {
-    constructor(position: number) {
+    constructor(position: number, leader?: LeaderType) {
-        super(new Tab("center", position));
+        super(new TabStopItem("center", position, leader));
     }
 }

src/file/paragraph/paragraph.ts

@@ -12,7 +12,7 @@ import { KeepLines, KeepNext } from "./formatting/keep";
 import { PageBreak, PageBreakBefore } from "./formatting/page-break";
 import { ISpacingProperties, Spacing } from "./formatting/spacing";
 import { Style } from "./formatting/style";
-import { CenterTabStop, LeftTabStop, MaxRightTabStop, RightTabStop } from "./formatting/tab-stop";
+import { CenterTabStop, LeaderType, LeftTabStop, MaxRightTabStop, RightTabStop } from "./formatting/tab-stop";
 import { NumberProperties } from "./formatting/unordered-list";
 import { Bookmark, Hyperlink } from "./links";
 import { ParagraphProperties } from "./properties";
@@ -30,6 +30,10 @@ export class Paragraph extends XmlComponent {
         }
     }
 
+    public get paragraphProperties(): ParagraphProperties {
+        return this.properties;
+    }
+
     public get Borders(): Border {
         return this.properties.paragraphBorder;
     }
@@ -155,23 +159,23 @@ export class Paragraph extends XmlComponent {
         return this;
     }
 
-    public maxRightTabStop(): Paragraph {
+    public maxRightTabStop(leader?: LeaderType): Paragraph {
-        this.properties.push(new MaxRightTabStop());
+        this.properties.push(new MaxRightTabStop(leader));
         return this;
     }
 
-    public leftTabStop(position: number): Paragraph {
+    public leftTabStop(position: number, leader?: LeaderType): Paragraph {
-        this.properties.push(new LeftTabStop(position));
+        this.properties.push(new LeftTabStop(position, leader));
         return this;
     }
 
-    public rightTabStop(position: number): Paragraph {
+    public rightTabStop(position: number, leader?: LeaderType): Paragraph {
-        this.properties.push(new RightTabStop(position));
+        this.properties.push(new RightTabStop(position, leader));
         return this;
     }
 
-    public centerTabStop(position: number): Paragraph {
+    public centerTabStop(position: number, leader?: LeaderType): Paragraph {
-        this.properties.push(new CenterTabStop(position));
+        this.properties.push(new CenterTabStop(position, leader));
         return this;
     }
 
@@ -232,7 +236,8 @@ export class Paragraph extends XmlComponent {
         return this;
     }
 
-    public get Properties(): ParagraphProperties {
+    public addTabStop(run: Run): Paragraph {
-        return this.properties;
+        this.root.splice(1, 0, run);
+        return this;
     }
 }

src/file/paragraph/run/field.ts

@@ -0,0 +1,26 @@
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class FidCharAttrs extends XmlAttributeComponent<{ type: "begin" | "end" | "separate"; dirty?: boolean }> {
+    protected xmlKeys = { type: "w:fldCharType", dirty: "w:dirty" };
+}
+
+export class Begin extends XmlComponent {
+    constructor(dirty?: boolean) {
+        super("w:fldChar");
+        this.root.push(new FidCharAttrs({ type: "begin", dirty }));
+    }
+}
+
+export class Separate extends XmlComponent {
+    constructor(dirty?: boolean) {
+        super("w:fldChar");
+        this.root.push(new FidCharAttrs({ type: "separate", dirty }));
+    }
+}
+
+export class End extends XmlComponent {
+    constructor(dirty?: boolean) {
+        super("w:fldChar");
+        this.root.push(new FidCharAttrs({ type: "end", dirty }));
+    }
+}

src/file/paragraph/run/page-number.ts

@@ -1,20 +1,9 @@
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 
-class FidCharAttrs extends XmlAttributeComponent<{ type: "begin" | "end" | "separate" }> {
-    protected xmlKeys = { type: "w:fldCharType" };
-}
-
 class TextAttributes extends XmlAttributeComponent<{ space: "default" | "preserve" }> {
     protected xmlKeys = { space: "xml:space" };
 }
 
-export class Begin extends XmlComponent {
-    constructor() {
-        super("w:fldChar");
-        this.root.push(new FidCharAttrs({ type: "begin" }));
-    }
-}
-
 export class Page extends XmlComponent {
     constructor() {
         super("w:instrText");
@@ -22,17 +11,3 @@ export class Page extends XmlComponent {
         this.root.push("PAGE");
     }
 }
-
-export class Separate extends XmlComponent {
-    constructor() {
-        super("w:fldChar");
-        this.root.push(new FidCharAttrs({ type: "separate" }));
-    }
-}
-
-export class End extends XmlComponent {
-    constructor() {
-        super("w:fldChar");
-        this.root.push(new FidCharAttrs({ type: "end" }));
-    }
-}

src/file/paragraph/run/run.ts

@@ -1,6 +1,7 @@
 // http://officeopenxml.com/WPtext.php
 import { Break } from "./break";
 import { Caps, SmallCaps } from "./caps";
+import { Begin, End, Separate } from "./field";
 import {
     Bold,
     BoldComplexScript,
@@ -13,7 +14,7 @@ import {
     SizeComplexScript,
     Strike,
 } from "./formatting";
-import { Begin, End, Page, Separate } from "./page-number";
+import { Page } from "./page-number";
 import { RunProperties } from "./properties";
 import { RunFonts } from "./run-fonts";
 import { SubScript, SuperScript } from "./script";

src/file/settings/index.ts

@@ -0,0 +1,2 @@
+export * from "./settings";
+export * from "./update-fields";

src/file/settings/settings.spec.ts

@@ -0,0 +1,60 @@
+import { expect } from "chai";
+import { Formatter } from "../../export/formatter";
+import { Settings } from "./";
+describe("Settings", () => {
+    describe("#constructor", () => {
+        it("should create a empty Settings with correct rootKey", () => {
+            const settings = new Settings();
+            const tree = new Formatter().format(settings);
+            let keys = Object.keys(tree);
+            expect(keys).is.an.instanceof(Array);
+            expect(keys).has.length(1);
+            expect(keys[0]).to.be.equal("w:settings");
+            expect(tree["w:settings"]).is.an.instanceof(Array);
+            expect(tree["w:settings"]).has.length(1);
+            keys = Object.keys(tree["w:settings"][0]);
+            expect(keys).is.an.instanceof(Array);
+            expect(keys).has.length(1);
+            expect(keys[0]).to.be.equal("_attr");
+        });
+    });
+    describe("#addUpdateFields", () => {
+        const assertSettingsWithUpdateFields = (settings: Settings) => {
+            const tree = new Formatter().format(settings);
+            let keys = Object.keys(tree);
+            expect(keys).is.an.instanceof(Array);
+            expect(keys).has.length(1);
+            expect(keys[0]).to.be.equal("w:settings");
+            const rootArray = tree["w:settings"];
+            expect(rootArray).is.an.instanceof(Array);
+            expect(rootArray).has.length(2);
+            keys = Object.keys(rootArray[0]);
+            expect(keys).is.an.instanceof(Array);
+            expect(keys).has.length(1);
+            expect(keys[0]).to.be.equal("_attr");
+            keys = Object.keys(rootArray[1]);
+            expect(keys).is.an.instanceof(Array);
+            expect(keys).has.length(1);
+            expect(keys[0]).to.be.equal("w:updateFields");
+            const updateFieldsArray = rootArray[1]["w:updateFields"];
+            keys = Object.keys(updateFieldsArray[0]);
+            expect(keys).is.an.instanceof(Array);
+            expect(keys).has.length(1);
+            expect(keys[0]).to.be.equal("_attr");
+            const updateFieldsAttr = updateFieldsArray[0]._attr;
+            expect(updateFieldsAttr["w:val"]).to.be.equal(true);
+        };
+        it("should add a UpdateFields with value true", () => {
+            const settings = new Settings();
+            settings.addUpdateFields();
+            assertSettingsWithUpdateFields(settings);
+        });
+        it("should add a UpdateFields with value true only once", () => {
+            const settings = new Settings();
+            settings.addUpdateFields();
+            assertSettingsWithUpdateFields(settings);
+            settings.addUpdateFields();
+            assertSettingsWithUpdateFields(settings);
+        });
+    });
+});

src/file/settings/settings.ts

@@ -0,0 +1,73 @@
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { UpdateFields } from "./update-fields";
+export interface ISettingsAttributesProperties {
+    wpc?: string;
+    mc?: string;
+    o?: string;
+    r?: string;
+    m?: string;
+    v?: string;
+    wp14?: string;
+    wp?: string;
+    w10?: string;
+    w?: string;
+    w14?: string;
+    w15?: string;
+    wpg?: string;
+    wpi?: string;
+    wne?: string;
+    wps?: string;
+    Ignorable?: string;
+}
+export class SettingsAttributes extends XmlAttributeComponent<ISettingsAttributesProperties> {
+    protected xmlKeys = {
+        wpc: "xmlns:wpc",
+        mc: "xmlns:mc",
+        o: "xmlns:o",
+        r: "xmlns:r",
+        m: "xmlns:m",
+        v: "xmlns:v",
+        wp14: "xmlns:wp14",
+        wp: "xmlns:wp",
+        w10: "xmlns:w10",
+        w: "xmlns:w",
+        w14: "xmlns:w14",
+        w15: "xmlns:w15",
+        wpg: "xmlns:wpg",
+        wpi: "xmlns:wpi",
+        wne: "xmlns:wne",
+        wps: "xmlns:wps",
+        Ignorable: "mc:Ignorable",
+    };
+}
+export class Settings extends XmlComponent {
+    constructor() {
+        super("w:settings");
+        this.root.push(
+            new SettingsAttributes({
+                wpc: "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
+                mc: "http://schemas.openxmlformats.org/markup-compatibility/2006",
+                o: "urn:schemas-microsoft-com:office:office",
+                r: "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+                m: "http://schemas.openxmlformats.org/officeDocument/2006/math",
+                v: "urn:schemas-microsoft-com:vml",
+                wp14: "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
+                wp: "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
+                w10: "urn:schemas-microsoft-com:office:word",
+                w: "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
+                w14: "http://schemas.microsoft.com/office/word/2010/wordml",
+                w15: "http://schemas.microsoft.com/office/word/2012/wordml",
+                wpg: "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
+                wpi: "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
+                wne: "http://schemas.microsoft.com/office/word/2006/wordml",
+                wps: "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
+                Ignorable: "w14 w15 wp14",
+            }),
+        );
+    }
+    public addUpdateFields(): void {
+        if (!this.root.find((child) => child instanceof UpdateFields)) {
+            this.addChildElement(new UpdateFields());
+        }
+    }
+}

src/file/settings/update-fields.spec.ts

@@ -0,0 +1,40 @@
+import { expect } from "chai";
+import { Formatter } from "../../export/formatter";
+import { UpdateFields } from "./";
+const UF_TRUE = {
+    "w:updateFields": [
+        {
+            _attr: {
+                "w:val": true,
+            },
+        },
+    ],
+};
+const UF_FALSE = {
+    "w:updateFields": [
+        {
+            _attr: {
+                "w:val": false,
+            },
+        },
+    ],
+};
+describe("Update Fields", () => {
+    describe("#constructor", () => {
+        it("should construct a Update Fields with TRUE value by default", () => {
+            const uf = new UpdateFields();
+            const tree = new Formatter().format(uf);
+            expect(tree).to.be.deep.equal(UF_TRUE);
+        });
+        it("should construct a Update Fields with TRUE value", () => {
+            const uf = new UpdateFields(true);
+            const tree = new Formatter().format(uf);
+            expect(tree).to.be.deep.equal(UF_TRUE);
+        });
+        it("should construct a Update Fields with FALSE value", () => {
+            const uf = new UpdateFields(false);
+            const tree = new Formatter().format(uf);
+            expect(tree).to.be.deep.equal(UF_FALSE);
+        });
+    });
+});

src/file/settings/update-fields.ts

@@ -0,0 +1,19 @@
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+export interface IUpdateFieldsAttributesProperties {
+    enabled: boolean;
+}
+export class UpdateFieldsAttributes extends XmlAttributeComponent<IUpdateFieldsAttributesProperties> {
+    protected xmlKeys = {
+        enabled: "w:val",
+    };
+}
+export class UpdateFields extends XmlComponent {
+    constructor(enabled: boolean = true) {
+        super("w:updateFields");
+        this.root.push(
+            new UpdateFieldsAttributes({
+                enabled,
+            }),
+        );
+    }
+}

src/file/table-of-contents/alias.ts

@@ -0,0 +1,12 @@
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class AliasAttributes extends XmlAttributeComponent<{ alias: string }> {
+    protected xmlKeys = { alias: "w:val" };
+}
+
+export class Alias extends XmlComponent {
+    constructor(alias: string) {
+        super("w:alias");
+        this.root.push(new AliasAttributes({ alias }));
+    }
+}

src/file/table-of-contents/index.ts

@@ -0,0 +1,2 @@
+export * from "./table-of-contents";
+export * from "./table-of-contents-properties";

src/file/table-of-contents/sdt-content.ts

@@ -0,0 +1,7 @@
+import { XmlComponent } from "file/xml-components";
+
+export class SdtContent extends XmlComponent {
+    constructor() {
+        super("w:sdtContent");
+    }
+}

src/file/table-of-contents/sdt-properties.ts

@@ -0,0 +1,9 @@
+import { XmlComponent } from "file/xml-components";
+import { Alias } from "./alias";
+
+export class SdtProperties extends XmlComponent {
+    constructor(alias: string) {
+        super("w:sdtPr");
+        this.root.push(new Alias(alias));
+    }
+}

src/file/table-of-contents/table-of-contents-instruction.ts

@@ -0,0 +1,75 @@
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { ITableOfContentsOptions } from "./table-of-contents-properties";
+
+enum SpaceType {
+    DEFAULT = "default",
+    PRESERVE = "preserve",
+}
+
+class TextAttributes extends XmlAttributeComponent<{ space: SpaceType }> {
+    protected xmlKeys = { space: "xml:space" };
+}
+
+export class TableOfContentsInstruction extends XmlComponent {
+    private readonly properties: ITableOfContentsOptions;
+
+    constructor(properties: ITableOfContentsOptions = {}) {
+        super("w:instrText");
+
+        this.properties = properties;
+
+        this.root.push(new TextAttributes({ space: SpaceType.PRESERVE }));
+        let instruction = "TOC";
+
+        if (this.properties.captionLabel) {
+            instruction = `${instruction} \\a "${this.properties.captionLabel}"`;
+        }
+        if (this.properties.entriesFromBookmark) {
+            instruction = `${instruction} \\b "${this.properties.entriesFromBookmark}"`;
+        }
+        if (this.properties.captionLabelIncludingNumbers) {
+            instruction = `${instruction} \\c "${this.properties.captionLabelIncludingNumbers}"`;
+        }
+        if (this.properties.sequenceAndPageNumbersSeparator) {
+            instruction = `${instruction} \\d "${this.properties.sequenceAndPageNumbersSeparator}"`;
+        }
+        if (this.properties.tcFieldIdentifier) {
+            instruction = `${instruction} \\f "${this.properties.tcFieldIdentifier}"`;
+        }
+        if (this.properties.hyperlink) {
+            instruction = `${instruction} \\h`;
+        }
+        if (this.properties.tcFieldLevelRange) {
+            instruction = `${instruction} \\l "${this.properties.tcFieldLevelRange}`;
+        }
+        if (this.properties.pageNumbersEntryLevelsRange) {
+            instruction = `${instruction} \\n "${this.properties.pageNumbersEntryLevelsRange}`;
+        }
+        if (this.properties.headingStyleRange) {
+            instruction = `${instruction} \\o "${this.properties.headingStyleRange}`;
+        }
+        if (this.properties.entryAndPageNumberSeparator) {
+            instruction = `${instruction} \\p "${this.properties.entryAndPageNumberSeparator}`;
+        }
+        if (this.properties.seqFieldIdentifierForPrefix) {
+            instruction = `${instruction} \\s "${this.properties.seqFieldIdentifierForPrefix}`;
+        }
+        if (this.properties.stylesWithLevels && this.properties.stylesWithLevels.length) {
+            const styles = this.properties.stylesWithLevels.map((sl) => `${sl.styleName},${sl.level}`).join(",");
+            instruction = `${instruction} \\t "${styles}"`;
+        }
+        if (this.properties.useAppliedParagraphOutlineLevel) {
+            instruction = `${instruction} \\u`;
+        }
+        if (this.properties.preserveTabInEntries) {
+            instruction = `${instruction} \\w`;
+        }
+        if (this.properties.preserveNewLineInEntries) {
+            instruction = `${instruction} \\x`;
+        }
+        if (this.properties.hideTabAndPageNumbersInWebView) {
+            instruction = `${instruction} \\z`;
+        }
+        this.root.push(instruction);
+    }
+}

src/file/table-of-contents/table-of-contents-properties.ts

@@ -0,0 +1,122 @@
+export class StyleLevel {
+    public styleName: string;
+    public level: number;
+
+    constructor(styleName: string, level: number) {
+        this.styleName = styleName;
+        this.level = level;
+    }
+}
+
+/**
+ * Options according to this docs:
+ * https://www.ecma-international.org/publications/standards/Ecma-376.htm
+ * Part 1 - Page 1251
+ *
+ * Short Guide:
+ * http://officeopenxml.com/WPtableOfContents.php
+ */
+export interface ITableOfContentsOptions {
+    /**
+     * \a option - Includes captioned items, but omits caption labels and numbers.
+     * The identifier designated by text in this switch's field-argument corresponds to the caption label.
+     * Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.
+     */
+    captionLabel?: string;
+
+    /**
+     * \b option - Includes entries only from the portion of the document marked by
+     * the bookmark named by text in this switch's field-argument.
+     */
+    entriesFromBookmark?: string;
+
+    /**
+     * \c option -  Includes figures, tables, charts, and other items that are numbered
+     * by a SEQ field (§17.16.5.56). The sequence identifier designated by text in this switch's
+     * field-argument, which corresponds to the caption label, shall match the identifier in the
+     * corresponding SEQ field.
+     */
+    captionLabelIncludingNumbers?: string;
+
+    /**
+     * \d option - When used with \s, the text in this switch's field-argument defines
+     * the separator between sequence and page numbers. The default separator is a hyphen (-).
+     */
+    sequenceAndPageNumbersSeparator?: string;
+
+    /**
+     * \f option - Includes only those TC fields whose identifier exactly matches the
+     * text in this switch's field-argument (which is typically a letter).
+     */
+    tcFieldIdentifier?: string;
+
+    /**
+     * \h option - Makes the table of contents entries hyperlinks.
+     */
+    hyperlink?: boolean;
+
+    /**
+     * \l option - Includes TC fields that assign entries to one of the levels specified
+     * by text in this switch's field-argument as a range having the form startLevel-endLevel,
+     * where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel.
+     * TC fields that assign entries to lower levels are skipped.
+     */
+    tcFieldLevelRange?: string;
+
+    /**
+     * \n option - Without field-argument, omits page numbers from the table of contents.
+     * Page numbers are omitted from all levels unless a range of entry levels is specified by
+     * text in this switch's field-argument. A range is specified as for \l.
+     */
+    pageNumbersEntryLevelsRange?: string;
+
+    /**
+     * \o option -  Uses paragraphs formatted with all or the specified range of builtin
+     * heading styles. Headings in a style range are specified by text in this switch's
+     * field-argument using the notation specified as for \l, where each integer corresponds
+     * to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1).
+     * If no heading range is specified, all heading levels used in the document are listed.
+     */
+    headingStyleRange?: string;
+
+    /**
+     * \p option - Text in this switch's field-argument specifies a sequence of characters
+     * that separate an entry and its page number. The default is a tab with leader dots.
+     */
+    entryAndPageNumberSeparator?: string;
+
+    /**
+     * \s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number.
+     * The prefix depends on the type of entry. text in this switch's field-argument shall match the
+     * identifier in the SEQ field.
+     */
+    seqFieldIdentifierForPrefix?: string;
+
+    /**
+     * \t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
+     * Text in this switch's field-argument specifies those styles as a set of comma-separated doublets,
+     * with each doublet being a comma-separated set of style name and table of content level.
+     * \t can be combined with \o.
+     */
+    stylesWithLevels?: StyleLevel[];
+
+    /**
+     * \u Uses the applied paragraph outline level.
+     */
+    useAppliedParagraphOutlineLevel?: boolean;
+
+    /**
+     * \w Preserves tab entries within table entries.
+     */
+    preserveTabInEntries?: boolean;
+
+    /**
+     * \x Preserves newline characters within table entries.
+     */
+    preserveNewLineInEntries?: boolean;
+
+    /**
+     * \z Hides tab leader and page numbers in web page view (§17.18.102).
+     */
+    hideTabAndPageNumbersInWebView?: boolean;
+}

src/file/table-of-contents/table-of-contents.spec.ts

@@ -0,0 +1,219 @@
+import { expect } from "chai";
+
+import { Formatter } from "../../export/formatter";
+import { ITableOfContentsOptions, StyleLevel, TableOfContents } from "./";
+
+describe("Table of Contents", () => {
+    describe("#constructor", () => {
+        it("should construct a TOC without options", () => {
+            const toc = new TableOfContents();
+            const tree = new Formatter().format(toc);
+            expect(tree).to.be.deep.equal(DEFAULT_TOC);
+        });
+
+        it("should construct a TOC with all the options and alias", () => {
+            const props: ITableOfContentsOptions = {};
+
+            props.captionLabel = "A";
+            props.entriesFromBookmark = "B";
+            props.captionLabelIncludingNumbers = "C";
+            props.sequenceAndPageNumbersSeparator = "D";
+            props.tcFieldIdentifier = "F";
+            props.hyperlink = true;
+            props.tcFieldLevelRange = "L";
+            props.pageNumbersEntryLevelsRange = "N";
+            props.headingStyleRange = "O";
+            props.entryAndPageNumberSeparator = "P";
+            props.seqFieldIdentifierForPrefix = "S";
+
+            const styles = new Array<StyleLevel>();
+            styles.push(new StyleLevel("SL", 1));
+            styles.push(new StyleLevel("SL", 2));
+            props.stylesWithLevels = styles;
+            props.useAppliedParagraphOutlineLevel = true;
+            props.preserveTabInEntries = true;
+            props.preserveNewLineInEntries = true;
+            props.hideTabAndPageNumbersInWebView = true;
+
+            const toc = new TableOfContents("Summary", props);
+            const tree = new Formatter().format(toc);
+            expect(tree).to.be.deep.equal(COMPLETE_TOC);
+        });
+    });
+});
+
+const DEFAULT_TOC = {
+    "w:sdt": [
+        {
+            "w:sdtPr": [
+                {
+                    "w:alias": [
+                        {
+                            _attr: {
+                                "w:val": "Table of Contents",
+                            },
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            "w:sdtContent": [
+                {
+                    "w:p": [
+                        {
+                            "w:pPr": [],
+                        },
+                        {
+                            "w:r": [
+                                {
+                                    "w:rPr": [],
+                                },
+                                {
+                                    "w:fldChar": [
+                                        {
+                                            _attr: {
+                                                "w:fldCharType": "begin",
+                                                "w:dirty": true,
+                                            },
+                                        },
+                                    ],
+                                },
+                                {
+                                    "w:instrText": [
+                                        {
+                                            _attr: {
+                                                "xml:space": "preserve",
+                                            },
+                                        },
+                                        "TOC",
+                                    ],
+                                },
+                                {
+                                    "w:fldChar": [
+                                        {
+                                            _attr: {
+                                                "w:fldCharType": "separate",
+                                            },
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                    ],
+                },
+                {
+                    "w:p": [
+                        {
+                            "w:pPr": [],
+                        },
+                        {
+                            "w:r": [
+                                {
+                                    "w:rPr": [],
+                                },
+                                {
+                                    "w:fldChar": [
+                                        {
+                                            _attr: {
+                                                "w:fldCharType": "end",
+                                            },
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                    ],
+                },
+            ],
+        },
+    ],
+};
+
+const COMPLETE_TOC = {
+    "w:sdt": [
+        {
+            "w:sdtPr": [
+                {
+                    "w:alias": [
+                        {
+                            _attr: {
+                                "w:val": "Summary",
+                            },
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            "w:sdtContent": [
+                {
+                    "w:p": [
+                        {
+                            "w:pPr": [],
+                        },
+                        {
+                            "w:r": [
+                                {
+                                    "w:rPr": [],
+                                },
+                                {
+                                    "w:fldChar": [
+                                        {
+                                            _attr: {
+                                                "w:fldCharType": "begin",
+                                                "w:dirty": true,
+                                            },
+                                        },
+                                    ],
+                                },
+                                {
+                                    "w:instrText": [
+                                        {
+                                            _attr: {
+                                                "xml:space": "preserve",
+                                            },
+                                        },
+                                        'TOC \\a "A" \\b "B" \\c "C" \\d "D" \\f "F" \\h \\l "L \\n "N \\o "O \\p "P \\s "S \\t "SL,1,SL,2" \\u \\w \\x \\z',
+                                    ],
+                                },
+                                {
+                                    "w:fldChar": [
+                                        {
+                                            _attr: {
+                                                "w:fldCharType": "separate",
+                                            },
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                    ],
+                },
+                {
+                    "w:p": [
+                        {
+                            "w:pPr": [],
+                        },
+                        {
+                            "w:r": [
+                                {
+                                    "w:rPr": [],
+                                },
+                                {
+                                    "w:fldChar": [
+                                        {
+                                            _attr: {
+                                                "w:fldCharType": "end",
+                                            },
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                    ],
+                },
+            ],
+        },
+    ],
+};

src/file/table-of-contents/table-of-contents.ts

@@ -0,0 +1,33 @@
+import { Paragraph } from "file/paragraph";
+import { Run } from "file/paragraph/run";
+import { Begin, End, Separate } from "file/paragraph/run/field";
+import { XmlComponent } from "file/xml-components";
+import { SdtContent } from "./sdt-content";
+import { SdtProperties } from "./sdt-properties";
+import { TableOfContentsInstruction } from "./table-of-contents-instruction";
+import { ITableOfContentsOptions } from "./table-of-contents-properties";
+
+export class TableOfContents extends XmlComponent {
+    constructor(alias: string = "Table of Contents", properties?: ITableOfContentsOptions) {
+        super("w:sdt");
+        this.root.push(new SdtProperties(alias));
+
+        const content = new SdtContent();
+
+        const beginParagraph = new Paragraph();
+        const beginRun = new Run();
+        beginRun.addChildElement(new Begin(true));
+        beginRun.addChildElement(new TableOfContentsInstruction(properties));
+        beginRun.addChildElement(new Separate());
+        beginParagraph.addRun(beginRun);
+        content.addChildElement(beginParagraph);
+
+        const endParagraph = new Paragraph();
+        const endRun = new Run();
+        endRun.addChildElement(new End());
+        endParagraph.addRun(endRun);
+        content.addChildElement(endParagraph);
+
+        this.root.push(content);
+    }
+}

src/file/xml-components/xml-component.ts

@@ -30,7 +30,6 @@ export abstract class XmlComponent extends BaseXmlComponent {
         };
     }
 
-    // TODO: Unused method
     public addChildElement(child: XmlComponent | string): XmlComponent {
         this.root.push(child);