Matlab Generate Report

% Run in MATLAB via MCP tool — scaffold ALL reporters before editing ANY
mlreportgen.report.Chapter.customizeReporter("+myrpt/@Chapter/Chapter.m");
mlreportgen.report.TitlePage.customizeReporter("+myrpt/@TitlePage/TitlePage.m");
mlreportgen.report.TableOfContents.customizeReporter("+myrpt/@TableOfContents/TableOfContents.m");
mlreportgen.report.Section.customizeReporter("+myrpt/@Section/Section.m");

% WRONG (generated by customizeReporter):
path = TitlePage.getClassFolder();

% CORRECT (manually fix to):
path = myrpt.TitlePage.getClassFolder();

import mlreportgen.dom.*
templateDir = fullfile(classFolder,"resources","templates");

tpl = Template(fullfile(tempdir,"inspect.pdftx"),"pdf", ...
    fullfile(templateDir,"pdf","default.pdftx"));
open(tpl);
parts = tpl.TemplateDocumentParts;
for i = 1:numel(parts)
    fprintf("Part %d: %s\n",i,parts(i).Name);
    for j = 1:numel(parts(i).Children)
        child = parts(i).Children(j);
        fprintf("  Child %d: %s\n",j,class(child));
    end
end
close(tpl);

    properties
        HeaderLogo {mustBeLogoValue} = []   % Accepts [], Image, or file path string
    end

    methods
        function img = getHeaderLogo(obj)
        %getHeaderLogo Return Image for the HeaderLogo hole.
            if isempty(obj.HeaderLogo)
                img = [];
            elseif isa(obj.HeaderLogo,"mlreportgen.dom.Image")
                img = obj.HeaderLogo;
            else
                img = mlreportgen.dom.Image(string(obj.HeaderLogo));
                img.Width = "0.4in";
                img.Height = "0.4in";
            end
        end
    end
end

function mustBeLogoValue(v)
    if isempty(v), return; end
    if isa(v,"mlreportgen.dom.Image"), return; end
    if isstring(v) || ischar(v), return; end
    error("Value must be [], an Image object, or a file path string.");
end

classdef Chapter < mlreportgen.report.Chapter
% File: +myrpt/@Chapter/Chapter.m

    properties
        HeaderThumbnail mlreportgen.dom.Image
    end

    methods
        function obj = Chapter(varargin)
            obj = [email protected](varargin{:});
        end
    end

    % REQUIRED: template infrastructure (generated by customizeReporter)
    methods (Hidden)
        function templatePath = getDefaultTemplatePath(~,rpt)
            path = myrpt.Chapter.getClassFolder();
            templatePath = mlreportgen.report.ReportForm.getFormTemplatePath(path,rpt.Type);
        end
    end

    methods (Static)
        function path = getClassFolder()
            [path] = fileparts(mfilename("fullpath"));
        end
        function createTemplate(templatePath,type)
            path = myrpt.Chapter.getClassFolder();
            mlreportgen.report.ReportForm.createFormTemplate(templatePath,type,path);
        end
        function customizeReporter(toClasspath)
            mlreportgen.report.ReportForm.customizeClass(toClasspath,"myrpt.Chapter");
        end
    end
end

classdef TitlePage < mlreportgen.report.TitlePage
% File: +myrpt/@TitlePage/TitlePage.m

    properties
        LogoPath string = "company_logo.png"
    end

    methods
        function obj = TitlePage(varargin)
            obj = [email protected](varargin{:});
        end

        function content = getCompanyLogo(obj,~)
            % Called by framework to fill the CompanyLogo hole.
            import mlreportgen.dom.*
            content = Image(obj.LogoPath);
            content.Width = "2in";
            content.Height = "1in";
        end
    end

    % REQUIRED: template infrastructure (same pattern)
    methods (Hidden)
        function templatePath = getDefaultTemplatePath(~,rpt)
            path = myrpt.TitlePage.getClassFolder();
            templatePath = mlreportgen.report.ReportForm.getFormTemplatePath(path,rpt.Type);
        end
    end

    methods (Static)
        function path = getClassFolder()
            [path] = fileparts(mfilename("fullpath"));
        end
        function createTemplate(templatePath,type)
            path = myrpt.TitlePage.getClassFolder();
            mlreportgen.report.ReportForm.createFormTemplate(templatePath,type,path);
        end
        function customizeReporter(toClasspath)
            mlreportgen.report.ReportForm.customizeClass(toClasspath,"myrpt.TitlePage");
        end
    end
end

import mlreportgen.dom.*

templateDir = fullfile(classFolder,"resources","templates");
srcPath = fullfile(templateDir,"pdf","default.pdftx");
tmpPath = fullfile(templateDir,"pdf","default_new.pdftx");

% 1. Open (MUST use different output path from source)
tpl = Template(tmpPath,"pdf",srcPath);
open(tpl);

% 2. Access template document parts
parts = tpl.TemplateDocumentParts;
section1 = parts(1);  % "Section1" part

% 3. For PDF: modify PDFPageLayout headers/footers
layout = section1.Children(1);  % PDFPageLayout
defaultHeader = layout.PageHeaders(2);  % PageType='default'

% 4. Save changes back
tpl.TemplateDocumentParts(1) = section1;
close(tpl);

% 5. Replace original
movefile(tmpPath,srcPath);

function customizePdfChapterTemplate(classFolder)
    import mlreportgen.dom.*

    templateDir = fullfile(classFolder,"resources","templates","pdf");
    srcPath = fullfile(templateDir,"default.pdftx");
    tmpPath = fullfile(templateDir,"default_new.pdftx");

    tpl = Template(tmpPath,"pdf",srcPath);
    open(tpl);

    parts = tpl.TemplateDocumentParts;
    for i = 1:numel(parts)
        if strcmp(parts(i).Name,"Section1")
            section1 = parts(i);
            sectionIdx = i;
            break
        end
    end

    layout = section1.Children(1);

    for k = 1:numel(layout.PageHeaders)
        pageType = layout.PageHeaders(k).PageType;
        newHeader = PDFPageHeader(pageType);

            imgPara = Paragraph("");
            append(imgPara,TemplateHole("HeaderThumbnail"));

            % Center cell: StyleRef on default/even only (not first page)
            % First page already displays the chapter title as a heading —
            % repeating it in the header is redundant (standard book design).
            titlePara = Paragraph("");
            titlePara.HAlign = "center";
            titlePara.Style = [titlePara.Style, {FontSize("10pt")}];
            if ~strcmp(pageType,"first")
                append(titlePara,StyleRef("SectionTitle1"));
            end

            spacerPara = Paragraph(" ");

            e1 = TableEntry(imgPara);
            e1.Style = {Width("1in")};
            e2 = TableEntry(titlePara);
            e2.Style = {Width("5in")};
            e3 = TableEntry(spacerPara);
            e3.Style = {Width("1in")};

            row = TableRow();
            append(row,e1);
            append(row,e2);
            append(row,e3);

            headerTable = Table();
            append(headerTable,row);
            headerTable.Width = "100%";
            headerTable.Style = {Border("none"),ResizeToFitContents(false)};
            headerTable.TableEntriesVAlign = "bottom";
            append(newHeader,headerTable);

            hrPara = Paragraph("");
            hrPara.Style = {HAlign("center"),OuterMargin("0","0","3pt","0"),...
                Border("solid","#000000","0.5pt")};
            append(newHeader,hrPara);

        layout.PageHeaders(k) = newHeader;
    end

    tpl.TemplateDocumentParts(sectionIdx) = section1;
    close(tpl);
    movefile(tmpPath,srcPath);
end

function addBodyHoleToPdfTemplate(classFolder,holeName)
    import mlreportgen.dom.*

    templateDir = fullfile(classFolder,"resources","templates","pdf");
    srcPath = fullfile(templateDir,"default.pdftx");
    tmpPath = fullfile(templateDir,"default_new.pdftx");

    tpl = Template(tmpPath,"pdf",srcPath);
    open(tpl);

    parts = tpl.TemplateDocumentParts;
    for i = 1:numel(parts)
        if strcmp(parts(i).Name,"Section1")
            oldSection = parts(i);
            sectionIdx = i;
            break
        end
    end

    newSection = TemplateDocumentPart("Section1");
    for k = 1:numel(oldSection.Children)
        child = oldSection.Children(k);
        append(newSection,clone(child));
        if isa(child,"mlreportgen.dom.TemplateHole") && ...
                strcmp(child.HoleId,"Title")
            newHole = TemplateHole(holeName);
            newHole.Description = upper(holeName);
            append(newSection,newHole);
        end
    end

    tpl.TemplateDocumentParts(sectionIdx) = newSection;
    close(tpl);
    movefile(tmpPath,srcPath);
end

for fmt = ["pdf","docx","html"]
    rpt = Report("Test_" + fmt,fmt);
    ch = myrpt.Chapter("Test");
    img = Image("thumbnail.png");
    img.Width = "0.5in";
    ch.HeaderThumbnail = img;
    append(rpt,ch);
    close(rpt);
    rptview(rpt);
end

mlreportgen.report.Chapter.customizeReporter("+myrpt/@Chapter/Chapter.m");

ch = Chapter("Title","Introduction");
titleRptr = getTitleReporter(ch);
titleRptr.NumberPrefix = "";      % Removes "Chapter" prefix
titleRptr.NumberSuffix = ". ";    % "1. Introduction"
ch.Title = titleRptr;

classdef Chapter < mlreportgen.report.Chapter
    methods
        function rptr = getTitleReporter(ch)
            rptr = [email protected](ch);
            rptr.NumberPrefix = "Section";  % "Section 1. Introduction"
        end
    end
end

classdef TestResultCard < mlreportgen.report.Reporter
% File: +myrpt/@TestResultCard/TestResultCard.m

    properties
        TestName (1,1) string = ""
        Result (1,1) string {mustBeMember(Result,["Pass","Fail","Skip"])} = "Pass"
        Duration (1,1) double = 0
    end

    methods
        function obj = TestResultCard(name,result,duration)
            obj = [email protected]();
            if nargin > 0,obj.TestName = name; end
            if nargin > 1,obj.Result = result; end
            if nargin > 2,obj.Duration = duration; end
        end

        function content = getImpl(obj,rpt) %#ok<INUSD>
            import mlreportgen.dom.*
            grp = Group();
            namePara = Paragraph(obj.TestName);
            namePara.Style = {Bold(true),FontSize("12pt")};
            append(grp,namePara);

            switch obj.Result
                case "Pass", clr = "green";
                case "Fail", clr = "red";
                case "Skip", clr = "orange";
            end
            statusPara = Paragraph(upper(obj.Result));
            statusPara.Style = {Bold(true),Color(clr)};
            append(grp,statusPara);

            durPara = Paragraph(sprintf("Duration: %.1f s",obj.Duration));
            durPara.Style = {FontSize("9pt"),Color("gray")};
            append(grp,durPara);
            append(grp,HorizontalRule());
            content = grp;
        end
    end
end

TitlePageTitle (sub-doc part):
  Paragraph (StyleName = "TitlePageTitle")   ← 24pt bold centered
    └─ TemplateHole("Content")              ← filled with title text

classdef TitlePage < mlreportgen.report.TitlePage
% File: +myrpt/@TitlePage/TitlePage.m

    properties
        WindFarmName string = ""
        CustomerName string = ""
    end

    methods
        function obj = TitlePage(varargin)
            obj = [email protected](varargin{:});
        end
    end

    % REQUIRED: template infrastructure
    methods (Hidden)
        function templatePath = getDefaultTemplatePath(~,rpt)
            path = myrpt.TitlePage.getClassFolder();
            templatePath = mlreportgen.report.ReportForm.getFormTemplatePath(path,rpt.Type);
        end
    end

    methods (Static)
        function path = getClassFolder()
            [path] = fileparts(mfilename("fullpath"));
        end
        function createTemplate(templatePath,type)
            path = myrpt.TitlePage.getClassFolder();
            mlreportgen.report.ReportForm.createFormTemplate(templatePath,type,path);
        end
        function customizeReporter(toClasspath)
            mlreportgen.report.ReportForm.customizeClass(toClasspath,"myrpt.TitlePage");
        end
    end
end

Template structure:
  Paragraph (StyleName = "TitlePageWindFarmName")  ← centering, margins
    └─ TemplateHole("WindFarmName")                ← filled by property value
         DefaultHoleStyleName = "WindFarmNameChar"  ← bold, color, font-size

function customizeTitlePageTemplate(classFolder)
    import mlreportgen.dom.*

    templateDir = fullfile(classFolder,"resources","templates","pdf");
    srcPath = fullfile(templateDir,"default.pdftx");
    tmpPath = fullfile(templateDir,"default_new.pdftx");

    tpl = Template(tmpPath,"pdf",srcPath);
    open(tpl);

    % Modify the existing doc part in place (preserves DefaultHoleStyleName)
    mainPart = tpl.TemplateDocumentParts(1);

    % Add page border to existing PDFPageLayout
    mainPart.Children(1).PageBorder = PageBorder("solid","#1B5E20","3pt");
    mainPart.Children(1).PageBorder.MeasureFrom = "pageboundary";

    % Append styled paragraphs with inline holes
    wfPara = Paragraph();
    wfPara.StyleName = "TitlePageWindFarmName";
    wfHole = TemplateHole("WindFarmName");
    wfHole.DefaultHoleStyleName = "WindFarmNameChar";
    append(wfPara,wfHole);
    append(mainPart,wfPara);

    cnPara = Paragraph();
    cnPara.StyleName = "TitlePageCustomerName";
    cnHole = TemplateHole("CustomerName");
    cnHole.DefaultHoleStyleName = "CustomerNameChar";
    append(cnPara,cnHole);
    append(mainPart,cnPara);

    tpl.TemplateDocumentParts(1) = mainPart;

    % Add paragraph styles (positioning)
    ss = tpl.Stylesheet;
    wfPS = TemplateParagraphStyle("TitlePageWindFarmName");
    wfPS.Formats = [HAlign("center"),OuterMargin("0","0","12pt","6pt")];
    addStyle(ss,wfPS);

    cnPS = TemplateParagraphStyle("TitlePageCustomerName");
    cnPS.Formats = [HAlign("center"),OuterMargin("0","0","6pt","6pt")];
    addStyle(ss,cnPS);

    % Add character styles (text formatting)
    wfCS = TemplateTextStyle("WindFarmNameChar");
    wfCS.Formats = [FontSize("16pt"),Bold(true),Color("#1B5E20")];
    addStyle(ss,wfCS);

    cnCS = TemplateTextStyle("CustomerNameChar");
    cnCS.Formats = [FontSize("12pt"),Color("#333333")];
    addStyle(ss,cnCS);

    close(tpl);
    movefile(tmpPath,srcPath);
end

function customizeTitlePageDocxTemplate(classFolder)
    import mlreportgen.dom.*

    templateDir = fullfile(classFolder,"resources","templates","docx");
    srcPath = fullfile(templateDir,"default.dotx");
    tmpPath = fullfile(templateDir,"default_new.dotx");

    tpl = Template(tmpPath,"docx",srcPath);
    open(tpl);

    mainPart = tpl.TemplateDocumentParts(1);

    % Add page border
    mainPart.Children(1).PageBorder = PageBorder("solid","#1B5E20","3pt");
    mainPart.Children(1).PageBorder.MeasureFrom = "pageboundary";

    % Append styled paragraphs with inline holes
    wfPara = Paragraph();
    wfPara.StyleName = "TitlePageWindFarmName";
    append(wfPara,TemplateHole("WindFarmName"));
    append(mainPart,wfPara);

    cnPara = Paragraph();
    cnPara.StyleName = "TitlePageCustomerName";
    append(cnPara,TemplateHole("CustomerName"));
    append(mainPart,cnPara);

    tpl.TemplateDocumentParts(1) = mainPart;

    % Use TemplateLinkedStyle — includes both paragraph and run formatting
    ss = tpl.Stylesheet;
    wfStyle = TemplateLinkedStyle("TitlePageWindFarmName");
    wfStyle.Formats = [HAlign("center"),OuterMargin("0","0","12pt","6pt"),...
        FontSize("16pt"),Bold(true),Color("#1B5E20")];
    addStyle(ss,wfStyle);

    cnStyle = TemplateLinkedStyle("TitlePageCustomerName");
    cnStyle.Formats = [HAlign("center"),OuterMargin("0","0","6pt","6pt"),...
        FontSize("12pt"),Color("#333333")];
    addStyle(ss,cnStyle);

    close(tpl);
    movefile(tmpPath,srcPath);
end

% PDF:
pdfLayout.PageBorder = PageBorder("solid","#1B5E20","3pt");
pdfLayout.PageBorder.MeasureFrom = "pageboundary";

% DOCX:
docxSection.PageBorder = PageBorder("solid","#1B5E20","3pt");
docxSection.PageBorder.MeasureFrom = "pageboundary";

┌─────────────────────────────────────────────────────┐
│ Section1 (top-level chapter)                        │
│   ├── <layout> — page size, margins, header/footer  │
│   │     ├── <pheader type="first" .../>             │
│   │     ├── <pfooter type="first" .../>             │
│   │     ├── <pheader type="default" .../>           │
│   │     ├── <pfooter type="default" .../>           │
│   │     ├── <pheader type="even" .../>              │
│   │     └── <pfooter type="even" .../>              │
│   ├── <hole id="Title">                             │
│   └── <hole id="Content">                           │
├─────────────────────────────────────────────────────┤
│ Section2–Section6 (subsections)                     │
│   ├── <hole id="Title">                             │
│   └── <hole id="Content">                           │
├─────────────────────────────────────────────────────┤
│ SectionNumberedTitle1–6 (numbered title format)     │
│   ├── <hole id="NumberPrefix">                      │
│   ├── <autonumber stream-name="sect1"/>             │
│   ├── <hole id="NumberSuffix">                      │
│   └── <hole id="Content">                           │
├─────────────────────────────────────────────────────┤
│ SectionTitle1–6 (unnumbered title format)           │
│   └── <hole id="Content">                           │
├─────────────────────────────────────────────────────┤
│ SectionFirstPageHeader / SectionDefaultPageHeader   │
│ SectionEvenPageHeader / Section*PageFooter          │
└─────────────────────────────────────────────────────┘

<layout style="page-margin: 0.5in 1in 0.5in 1in 0.5in 0.5in 0in; page-size: 8.5in 11in portrait">
    <pheader type="first" template-name="SectionFirstPageHeader"/>
    <pfooter type="first" template-name="SectionFirstPageFooter"/>
    <pheader type="default" template-name="SectionDefaultPageHeader"/>
    <pfooter type="default" template-name="SectionDefaultPageFooter"/>
    <pheader type="even" template-name="SectionEvenPageHeader"/>
    <pfooter type="even" template-name="SectionEvenPageFooter"/>
    <pnumber format="1"/>
</layout>

TemplateDocumentParts (18 parts):
├── Section1              ← Top-level chapter
│   Children:
│     [1] DOCXSection     ← margins, headers, footers, page numbers
│     [2-3] TemplateText  ← whitespace
│     [4] TemplateHole    ← "Title" hole
│     [5] TemplateText    ← whitespace
│     [6] TemplateHole    ← "Content" hole
│     [7-8] TemplateText  ← whitespace
├── Section2–Section6     ← Subsections
├── SectionNumberedTitle1–6
└── SectionTitle1–6

docxSection.PageHeaders:
  [1] DOCXPageHeader (PageType="default")  % Odd/all pages
  [2] DOCXPageHeader (PageType="first")    % First page only
docxSection.PageFooters:
  [1] DOCXPageFooter (PageType="default")
  [2] DOCXPageFooter (PageType="first")

Page text width = 8.5in - 2×1in = 6.5in

┌──────────┬────────────────────────────┬──────────┐
│  Logo    │     StyleRef (centered)    │  Ticker  │
│  1.25in  │         4.0in             │  1.25in  │
└──────────┴────────────────────────────┴──────────┘

┌──────────┬────────────────────────────┬──────────┐
│  Logo    │         (empty)            │  Ticker  │
│  1.25in  │         4.0in             │  1.25in  │
└──────────┴────────────────────────────┴──────────┘

tpl = Template(outPath,"pdf",srcPath);
open(tpl);
styles = getStyle(tpl.Stylesheet,"SectionTitle1");
for i = 1:numel(styles)
    styles(i).RawFormats = regexprep(styles(i).RawFormats, ...
        "color:\s*[^;]+","color: red");
end
close(tpl);

tpl = Template(outPath,"docx",srcPath);
open(tpl);
newStyle = TemplateLinkedStyle("SectionTitle1");
newStyle.Formats = [Bold(true),FontSize("14pt"),Color("red")];
replaceStyle(tpl.Stylesheet,newStyle);
close(tpl);

ts = TemplateTableStyle("BaseTableContent");
ts.Formats = [Border("solid","#333333","0.5pt"),FontSize("10pt")];
ts.HeaderFormats = [Bold(true),BackgroundColor("#1B3A5C"),Color("white")];
replaceStyle(tpl.Stylesheet,ts);