Skip to content

Developer experience improvements: fix README, add missing fluent extensions, correct package description#257

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/propose-new-features-improvements
Draft

Developer experience improvements: fix README, add missing fluent extensions, correct package description#257
Copilot wants to merge 2 commits into
mainfrom
copilot/propose-new-features-improvements

Conversation

Copilot AI commented Apr 21, 2026

Copy link
Copy Markdown

The README had a copy-paste bug (bookmark section showed identical code to the template-open section), lacked any Report Engine documentation, and the NuGet package description incorrectly identified this as a "MvvmCross plugin". Two ContextModel data types (FileLinkModel, SubstitutableStringModel) also had no fluent extension methods despite the rest of the API following that pattern.

Changes

  • README.md – Full rewrite:

    • Fixed bookmark section with working SetTextOnBookmark / SetTextsOnBookmark / SetHtmlOnBookmark examples
    • Added Report Engine usage docs: simple document, data-driven table from collection, multi-report generation, stream-based template opening
    • Added fluent extension reference table
  • ContextModelExtensions.cs – Two missing helpers:

    • AddFileLink(key, filePath) — wraps FileLinkModel (image/file path binding)
    • AddSubstitutableString(key, pattern, dataSource) — wraps SubstitutableStringModel (composite formatted strings)
    var context = new ContextModel()
        .AddString("#CustomerName#", "Alice")
        .AddFileLink("#SignaturePath#", @"C:\assets\signature.png")
        .AddSubstitutableString("#Summary#", "{0} orders totalling {1}",
            new ContextModel()
                .AddString("0", "42")
                .AddDouble("1", 1234.5, "{0:C2}"));
  • OpenXMLSDK.Engine.csproj – Corrected <Description> to accurately describe the library.

…t package description

Agent-Logs-Url: https://github.com/mathieumack/OpenXMLSDK.Engine/sessions/5af0482c-3884-4250-971f-f8e002e6fdc1

Co-authored-by: mathieumack <12582537+mathieumack@users.noreply.github.com>
Copilot AI changed the title [WIP] Propose new features and improvements for developer benefits Developer experience improvements: fix README, add missing fluent extensions, correct package description Apr 21, 2026
Copilot AI requested a review from mathieumack April 21, 2026 22:17
@stale

stale Bot commented Jun 26, 2026

Copy link
Copy Markdown

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale Bot added the wontfix label Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Propose New Features or Improvements to Benefit Developers

2 participants