diff --git a/Document-Processing/Skills/document-sdk.md b/Document-Processing/Skills/document-sdk.md new file mode 100644 index 000000000..3bec7f558 --- /dev/null +++ b/Document-Processing/Skills/document-sdk.md @@ -0,0 +1,98 @@ +--- +title: Syncfusion Document SDK Agent Skills for AI Assistants | Syncfusion +description: Learn how to install and use Syncfusion Document SDK Agent Skills to help AI assistants generate accurate document processing code with Document SDK libraries +platform: document-processing +control: Document SDK +documentation: ug +keywords: Skills, AI Assistants, Document SDK, Agent Skills +--- + +# Syncfusion Document SDK Agent Skills for AI Assistants + +This guide introduces **Syncfusion Document SDK Skills**, a knowledge package that enables AI assistants (GitHub Copilot, Code Studio, Cursor, Claude, etc.) to understand and generate accurate document processing code using Syncfusion® Document SDK libraries. It also supports executing document operations directly via CSX scripts. + +Syncfusion® Document SDK Skills eliminate common issues with generic AI suggestions by grounding the assistant in accurate Syncfusion® Document SDK library APIs, document processing patterns, and platform-specific configuration for the following libraries: + +| Document Processing Libraries | Skills | +|---|---| +| [Word (DocIO)](https://help.syncfusion.com/document-processing/word/overview) | syncfusion-dotnet-word
syncfusion-java-word | +| [PDF](https://help.syncfusion.com/document-processing/pdf/overview) | syncfusion-dotnet-pdf
syncfusion-dotnet-pdf-to-image
syncfusion-flutter-pdf
syncfusion-javascript-pdf | +| [Excel (XlsIO)](https://help.syncfusion.com/document-processing/excel/overview) | syncfusion-dotnet-excel
syncfusion-flutter-excel | +| [PowerPoint (Presentation)](https://help.syncfusion.com/document-processing/powerpoint/overview) | syncfusion-dotnet-powerpoint | +| [Markdown](https://help.syncfusion.com/document-processing/word/word-library/net/convert-markdown-to-word-document-in-csharp) | syncfusion-dotnet-markdown | +| [Smart Data Extraction](https://help.syncfusion.com/document-processing/data-extraction/overview) | syncfusion-dotnet-smart-data-extraction | + +## Prerequisites + +Before installing Syncfusion® Document SDK Skills, ensure the following tools are available on your machine: + +- **[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills. +- **[.NET SDK](https://dotnet.microsoft.com/en-us/download)** (8.0 or later) — Required for CSX script execution (Mode 2). +- **[dotnet-script](https://github.com/dotnet-script/dotnet-script)** — Required for CSX script execution (Mode 2). Install it globally by running: `dotnet tool install -g dotnet-script`. + +## Installation + +Choose one of the following commands to install Syncfusion® Document SDK Skills based on your preference. You can also explore Syncfusion® skills from the [marketplace](https://skills.sh/syncfusion/). + +To install all document SDK skills at once, use the following command: + +```bash +npx skills add syncfusion/document-sdk-skills --all -y +``` + +To install a specific skill, use the following command (for example, to install PDF .NET skills): + +```bash +npx skills add syncfusion/document-sdk-skills --skill syncfusion-dotnet-pdf +``` + +This registers the Syncfusion® skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills). + +To learn more about the Skills CLI, refer [here](https://skills.sh/docs). + +## What's Included + +1. **Document SDK API Knowledge** — Curated, skill-based guidance for creating, editing, and converting PDF, Word, Excel, PowerPoint, and Markdown documents using Syncfusion® Document SDK libraries. Covers key APIs, supported formats, and conversions. +2. **Dual-Mode Execution (.NET)** — Supports two operating modes: + - **Mode 1** — Generate production-ready code for your project. + - **Mode 2** — Execute a document task immediately via a CSX script without modifying your project. +3. **Patterns & Best Practices** — Practical recommendations for API usage, platform-specific NuGet package selection, and document processing workflows (for example, mail merge, PDF digital signatures, Excel pivot tables, and PowerPoint chart creation). All guidance is authored directly within the skill file rather than being fetched from external documentation. + + +## How Syncfusion® Document SDK Agent Skills Work + +1. **Read the relevant skill files and choose modes based on the user's query** The assistant retrieves library APIs, and code patterns from the installed Syncfusion® Skills. It automatically chooses the appropriate operating mode based on the provided prompt. +2. **Enforces Syncfusion® best practices**, including: + - Suggesting the correct NuGet packages or JAR files based on the detected application type. + - Using only APIs and code patterns explicitly present in the skill reference files. + - Configuring the Syncfusion® license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable. +3. **Operates in two modes** based on the user's intent: + - **Mode 1 — Generate Code**: Produces production-ready code. No scripts are created or executed. Triggered by keywords such as `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`. + - **Mode 2 — Execute via CSX Script**: Creates a temporary `.csx` script, runs it with `dotnet script`, produces the output document file, then cleans up — without modifying the user's project. Triggered by keywords such as `"create"`, `"generate"`, `"make"`, `"open"`, `"edit"`, `"modify"`, or a file path (e.g., `output/report.docx`). + +## Using the AI Assistant + +Once skills are installed, the assistant can generate Syncfusion® document processing code or execute document generation tasks. Below are example prompts for each mode. + +**Generate Code (Mode 1):** + +- "How do I add a digital signature to a PDF?" +- "Give me a code snippet to create an Excel workbook with a pivot table using XlsIO." +- "Show me DocIO code to create a Word document with a title and a paragraph." +- "Generate a C# snippet to add a table to a PowerPoint slide." +- "Show me code to extract all fields and tables from a PDF as JSON using Smart Data Extraction." + +**Execute Task (Mode 2):** + +- "Create a PDF report with a title page and inventory table, save to output/report.pdf." +- "Create a sales summary workbook and save it to output/sales.xlsx." +- "Create a Word document about the top 5 programming languages in 2025." +- "Create a 5-slide meeting agenda presentation and save it to output/agenda.pptx." +- "Extract data from the PDF at Input/invoice.pdf using Smart Data Extraction and save to output/data.json." + +## See also + +- [Syncfusion Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) +- [Agent Skills Standards](https://agentskills.io/home) +- [Skills CLI](https://skills.sh/docs) + diff --git a/Document-Processing/Skills/docx-editor-sdk.md b/Document-Processing/Skills/docx-editor-sdk.md new file mode 100644 index 000000000..0e28f5762 --- /dev/null +++ b/Document-Processing/Skills/docx-editor-sdk.md @@ -0,0 +1,80 @@ +--- +title: Syncfusion DOCX Editor SDK Agent Skills for AI Assistants | Syncfusion +description: Learn how to install and use Syncfusion DOCX Editor Agent Skills to help AI assistants generate accurate DOCX Editor code with DOCX Editor SDK libraries +platform: document-processing +control: DOCX Editor SDK +documentation: ug +keywords: Skills, AI Assistants, DOCX Editor SDK, Agent Skills +--- + +# Syncfusion DOCX Editor SDK Agent Skills for AI Assistants + +This guide introduces **Syncfusion DOCX Editor SDK Skills**, a knowledge package that enables AI assistants (GitHub Copilot, Code Studio, Cursor, Claude, etc.) to understand and generate accurate docx editor code using Syncfusion® DOCX Editor SDK libraries. It also supports executing document editor operations directly via platform-specific scripts. + +Syncfusion® DOCX Editor SDK Skills eliminate common issues with generic AI suggestions by grounding the assistant in accurate Syncfusion® DOCX Editor SDK library APIs, supported features, and platform-specific configuration for the following platforms: + + +| DOCX Editor SDK Component | Skills | +|---|---| +| [React](https://help.syncfusion.com/document-processing/word/word-processor/react/overview) | syncfusion-react-docx-editor | +| [Blazor](https://help.syncfusion.com/document-processing/word/word-processor/blazor/overview) | syncfusion-blazor-docx-editor | +| [WPF](https://help.syncfusion.com/document-processing/word/word-processor/wpf/overview) | syncfusion-wpf-docx-editor | + +Each platform's skill file includes component initialization, property configuration, event handling and common usage patterns specific to that framework. + +## Prerequisites + +Before installing Syncfusion® DOCX Editor SDK Skills, ensure the following tools are available on your machine: + +- **[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills. + +## Installation + +Choose one of the following commands to install Syncfusion® DOCX Editor SDK Skills based on your preference. Users can also explore Syncfusion® skills from the [marketplace](https://skills.sh/syncfusion/). + +```bash +# Install all DOCX Editor SDK skills at once +npx skills add syncfusion/docx-editor-sdk-skills -y + +# Choose and install skills interactively from the terminal +npx skills add syncfusion/docx-editor-sdk-skills +``` + +This registers the Syncfusion® skill pack so your AI assistant can automatically load it in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills). + +To learn more about the Skills CLI, refer [here](https://skills.sh/docs). + +## What's Included + +1. **Docx Editor & API Knowledge** — Curated, skill-based guidance that captures how to create, edit, and manage Document Editing operations using Syncfusion® platform-specific libraries (React, Angular, Blazor, ASP.NET Core, TypeScript, Vue), including key APIs, supported features, and common usage patterns. +2. **Platform-Specific Code Generation** — Each skill supports generating production-ready platform-specific code for your project. The assistant automatically detects the project type and provides code snippets that can be inserted directly into your application files (e.g., `Program.cs`, `Home.razor`, `app.ts`). +3. **Patterns & Best Practices** — Practical recommendations for API usage, platform-specific package selection, and spreadsheet editor workflows (for example, cell formatting, data binding, formula calculation, chart creation, and worksheet protection). All guidance is authored directly within the Skill file rather than being fetched from documentation. + +## How Syncfusion® DOCX Editor SDK Agent Skills Work + +1. **Reads the relevant Skill files based on the user's query**, with the assistant retrieving library APIs, code patterns, and best-practice guidance from the installed Syncfusion® Skills, and automatically chooses the appropriate platform based on the detected project type. + +2. **Enforces Syncfusion® best practices** including: + - Suggesting the correct NuGet packages or npm packages based on the detected application type. + - Using only APIs and code patterns explicitly present in the skill reference files. + - Configuring the Syncfusion® license key from `SyncfusionLicense.txt` or the `SYNCFUSION_LICENSE_KEY` environment variable. +3. **Generates platform-specific code** based on the user's intent: + - Produces production-ready React, Angular, Blazor, ASP.NET Core, TypeScript, or Vue code and inserts it into the user's project files. + - Triggered by keywords such as `"create"`, `"add"`, `"insert"`, `"apply"`, `"code"`, `"snippet"`, `"how to"`, `"show me"`, `"sample"`, or `"example"`. + +### Using the AI Assistant + +Once skills are installed, the assistant can be used to generate and update Syncfusion® docx editor code for tasks such as: + +- "Create DOCX Editor and enable track changes" +- "Insert a table with rows and columns into a Word document." +- "Insert images within a DOCX file." +- "Track changes and add comments to specific paragraphs in a Word document." + + +## See also + +- [Syncfusion DOCX Editor SDK Documentation](https://help.syncfusion.com/document-processing/word/word-processor/overview) +- [Agent Skills Standards](https://agentskills.io/home) +- [SKills CLI](https://skills.sh/docs) + diff --git a/Document-Processing/Skills/pdf-viewer-sdk.md b/Document-Processing/Skills/pdf-viewer-sdk.md new file mode 100644 index 000000000..5f554695c --- /dev/null +++ b/Document-Processing/Skills/pdf-viewer-sdk.md @@ -0,0 +1,96 @@ +--- +title: Syncfusion PDF Viewer SDK Agent Skills for AI Assistants | Syncfusion +description: Learn how to install and use Syncfusion PDF Viewer SDK Agent Skills to help AI assistants generate accurate PDF Viewer code using PDF Viewer SDK libraries +platform: document-processing +control: PDF Viewer SDK +documentation: ug +keywords: Skills, AI Assistants, PdfViewer SDK, Agent Skills +--- + +# Syncfusion PDF Viewer SDK Agent Skills for AI Assistants + +This guide introduces **Syncfusion PDF Viewer SDK Skills**, a curated skill package that enables AI assistants (GitHub Copilot, Code Studio, Cursor, Claude, etc.) to generate accurate, production ready PDF Viewer integration code using the Syncfusion® PDF Viewer components across supported platforms. + +Unlike generic AI suggestions, these skills ground the assistant in official Syncfusion® PDF Viewer APIs, configuration patterns, and platform specific setup details—ensuring correct usage, faster Onboarding, and fewer integration issues. + +## Supported Platforms + +Syncfusion® PDF Viewer SDK Agent Skills provide guidance for the following platforms: + +| Framework | Skills | +|---|---| +| [Blazor](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/blazor/overview) | syncfusion-blazor-pdf-viewer | +| [React](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/react/getting-started-overview) | syncfusion-react-pdf-viewer | +| [Flutter](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/flutter/overview) | syncfusion-flutter-pdf-viewer | +| [.NET MAUI](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/maui/overview) | syncfusion-maui-pdf-viewer | +| [WinForms](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/winforms/overview) | syncfusion-winforms-pdf-viewer | +| [WPF](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/wpf/overview) | syncfusion-wpf-pdf-viewer | + +Each platform’s skill file includes component initialization, property configuration, event handling, and common usage patterns specific to that framework. + +## Prerequisites + +Before installing Syncfusion® PDF Viewer SDK Skills, ensure the following: + +- **[Node.js]("https://nodejs.org/")** (v18 or later) — Required to run `npx` commands for installing skills. + +## Installation + +Choose one of the following commands to install the Syncfusion PDF Viewer SDK Agent Skills. + +```bash +npx skills add syncfusion/pdf-viewer-sdk-skills --all -y +``` + +To install a specific skill, use the following command (for example, to install PDF .Net skills): + +```bash +npx skills add syncfusion/pdf-viewer-sdk-skills +``` + +## What's Included + +1. **PDF Viewer API Knowledge** - Curated, platform-specific guidance for working with Syncfusion® PDF Viewer components, including: + - Loading PDF documents from local files, URLs, and byte streams + - Configuring toolbar items and viewer options + - Zooming, scrolling, and navigation + - Text selection and search + - Annotations (shape, text markup, stamps, etc.) + - Form field interaction + - Event handling (document load, page change, annotation events) +2. **Platform-Specific Code Generation** — Generates production-ready code tailored to your platform without executing scripts or modifying your project structure. No files are generated on disk. +3. **Best Practices & Configuration Patterns** - The skills enforce Syncfusion® recommended practices, including: + - Correct package / NuGet / npm selection per platform + - Proper component initialization and life cycle usage + - Platform-appropriate configuration for performance and UX + - Syncfusion license setup using: + - `SyncfusionLicense.txt`, or + - `SYNCFUSION_LICENSE_KEY` environment variable +Only APIs and patterns explicitly defined in the skill reference files are used. + +## How Syncfusion® PDF Viewer SDK Agent Skills Work + +1. **Reads the relevant platform-specific skill files** - Based on the user’s query (for example, React vs WPF), the assistant loads the appropriate PDF Viewer skill reference. + +2. **Generates accurate, platform-specific code** - The assistant: + - Uses the correct component names and APIs + - Applies valid configuration options + +## Using the AI Assistant with PDF Viewer Skills + +Once installed, the assistant can help generate PDF Viewer integration code. Below are example prompts. + +## Example Prompts + +- “Show me how to load a PDF file in Syncfusion PDF Viewer for React.” +- “Give an example of enabling text search in Blazor PDF Viewer.” +- “How do I add annotation support in WPF Syncfusion PDF Viewer?” +- “Provide sample code to customize the toolbar in MAUI PDF Viewer.” +- “Show how to load a PDF from a URL in Flutter PDF Viewer.” +- “How to navigate to a specific page in Winforms PdfViewer?” + +## See Also + +- [Syncfusion PDF Viewer Documentation](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/overview) +- [Skills CLI Documentation](https://skills.sh/docs) +- [Agent Skills Standards](https://agentskills.io/home) \ No newline at end of file diff --git a/Document-Processing/Skills/spreadsheet-editor-sdk.md b/Document-Processing/Skills/spreadsheet-editor-sdk.md new file mode 100644 index 000000000..b3d4789b9 --- /dev/null +++ b/Document-Processing/Skills/spreadsheet-editor-sdk.md @@ -0,0 +1,86 @@ +--- +title: Spreadsheet Editor SDK Agent Skills for AI Assistants | Syncfusion +description: Learn how to install and use Syncfusion Spreadsheet Editor SDK Agent Skills to help AI assistants generate accurate code with Syncfusion Spreadsheet components +platform: document-processing +control: Spreadsheet Editor SDK +documentation: ug +keywords: Skills, AI Assistants, Spreadsheet Editor SDK, Agent Skills +--- + +# Syncfusion Spreadsheet Editor SDK Agent Skills for AI Assistants + +This guide introduces **Syncfusion Spreadsheet Editor SDK Skills**, a curated knowledge package that empowers AI assistants (such as GitHub Copilot, Code Studio, Cursor, Claude, and others) to generate accurate code for Syncfusion® Spreadsheet Editor SDK components across supported platforms. + +Syncfusion® Spreadsheet Editor SDK Skills address common issues with generic AI code suggestions by grounding the assistant in precise Spreadsheet Editor SDK Component APIs, spreadsheet editor patterns, and platform-specific configuration for the following platforms: + +| Framework | Skills | +|---|---| +| [React](https://help.syncfusion.com/document-processing/excel/spreadsheet/react/overview) | syncfusion-react-spreadsheet-editor | +| [Angular](https://help.syncfusion.com/document-processing/excel/spreadsheet/angular/overview) | syncfusion-angular-spreadsheet-editor | +| [Blazor](https://help.syncfusion.com/document-processing/excel/spreadsheet/blazor/overview) | syncfusion-blazor-spreadsheet-editor | +| [ASP.NET Core](https://help.syncfusion.com/document-processing/excel/spreadsheet/asp-net-core/overview) | syncfusion-aspnetcore-spreadsheet-editor | +| [ASP.NET MVC](https://help.syncfusion.com/document-processing/excel/spreadsheet/asp-net-mvc/overview) | syncfusion-aspnetmvc-spreadsheet-editor | +| [TypeScript](https://help.syncfusion.com/document-processing/excel/spreadsheet/javascript-es6/overview) | syncfusion-javascript-spreadsheet-editor | +| [Vue](https://help.syncfusion.com/document-processing/excel/spreadsheet/vue/overview) | syncfusion-vue-spreadsheet-editor | + +Each platform's skill file includes component initialization, property configuration, event handling, cell operations, formatting, data binding, and common spreadsheet usage patterns specific to that framework. + +## Prerequisites + +Before installing Syncfusion® Spreadsheet Editor SDK Skills, ensure the following tools are available on your machine: + +- **[Node.js](https://nodejs.org/en)** (v18 or later) — Required to run `npx` commands for installing skills. + +## Installation + +Use one of the following commands to install Syncfusion® Spreadsheet Editor SDK Skills. You can also browse Syncfusion® skills in the [marketplace](https://skills.sh/syncfusion/). + +To install all Spreadsheet Editor SDK skills at once, use the following command: + +```bash +npx skills add syncfusion/spreadsheet-editor-sdk-skills --all -y +``` + +To install a specific platform skill, use the following command (for example, to install Spreadsheet Blazor skills): + +```bash +npx skills add syncfusion/spreadsheet-editor-sdk-skills --skill syncfusion-blazor-spreadsheet-editor +``` + +This registers the Syncfusion® skill pack, enabling your AI assistant to load it automatically in supported IDEs such as [Code Studio](https://help.syncfusion.com/code-studio/reference/configure-properties/skills), [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/agent-skills), and [Cursor](https://cursor.com/docs/skills). + +For more details, see the [Skills CLI documentation](https://skills.sh/docs). + +## What's Included + +1. **Spreadsheet Editor SDK API Knowledge** — Skill-based, curated guidance for creating, editing, and managing spreadsheets using Syncfusion® Spreadsheet Editor SDK UI Components across supported platforms. Covers key APIs, component integration, cell operations, formatting, data binding, and import/export features. +2. **Platform-Specific Code Generation** — Produces production-ready code tailored to your platform (React, Angular, Blazor, ASP.NET Core, ASP.NET MVC, TypeScript, or Vue) without executing scripts or altering your project structure. +3. **Patterns & Best Practices** — Practical recommendations for API usage, platform-specific package selection, component configuration, and spreadsheet editor workflows (such as cell styling, conditional formatting, data validation, chart creation, formula calculation, and protection settings). All guidance is authored directly within the skill files, not fetched from external documentation. + +## How Syncfusion® Spreadsheet Editor SDK Agent Skills Work + +1. **Reads relevant skill files based on your query.** The assistant retrieves component APIs and code patterns from the installed Syncfusion® Skills, automatically selecting the appropriate platform based on your workspace or prompt. +2. **Enforces Syncfusion® best practices**, including: + - Recommending the correct npm or NuGet packages for your platform. + - Using only APIs and code patterns explicitly present in the skill reference files. +3. **Generates code only** — Spreadsheet Editor skills focus exclusively on generating production-ready code that can be integrated directly into your application files (for example, `Home.razor`, `app.component.ts`, or `Program.cs`). + +## Using the AI Assistant + +Once skills are installed, the assistant can generate spreadsheet editor code. Below are some example prompts. + +**Example Prompts:** + +- "Show me React code to create a Spreadsheet component with basic formatting options." +- "How to apply conditional formatting to highlight cells greater than $15,000 in Angular Spreadsheet Editor?" +- "Give me a code snippet to protect a worksheet and allow editing only specific cells using Blazor Spreadsheet Editor." +- "Show me how to insert a chart into the Spreadsheet Editor using ASP.NET Core." +- "How to export the spreadsheet as PDF using Vue Spreadsheet Editor?" +- "Show me code to apply number formatting to currency columns in React Spreadsheet Editor." +- "How do I enable cell editing and data validation in Angular Spreadsheet Editor?" + +## See also + +- [Syncfusion Spreadsheet Editor Documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/overview) +- [Agent Skills Standards](https://agentskills.io/home) +- [Skills CLI](https://skills.sh/docs)