From 47efe95eebc18d217b361a763f0aeddd456cc12c Mon Sep 17 00:00:00 2001 From: Plamen Mitrev Date: Wed, 11 Jun 2025 17:16:56 +0300 Subject: [PATCH 1/2] Docs builder config update and resources --- docs-builder.yml | 445 ++++++++++++++++++++++++++++++++++++ images/avatar-ninja.svg | 1 + images/ninja-no-results.svg | 47 ++++ 3 files changed, 493 insertions(+) create mode 100644 docs-builder.yml create mode 100644 images/avatar-ninja.svg create mode 100644 images/ninja-no-results.svg diff --git a/docs-builder.yml b/docs-builder.yml new file mode 100644 index 000000000..ffb0291d7 --- /dev/null +++ b/docs-builder.yml @@ -0,0 +1,445 @@ +top-navigation-product: reporting +path-prefix: /products/reporting/documentation +product-id: 521 +product-name: Telerik Reporting +product-url: https://www.telerik.com/products/reporting +search-engine-id: 001595215763381649090:zzabynuukmu +cta-overview: "@ProductLink is a complete .NET embedded reporting tool for web and desktop applications. To try it out sign up for a free 30-day trial." +cta-intro: "@ProductLink is a complete .NET embedded reporting tool for web and desktop applications. To try it out sign up for a free 30-day trial." +default-title-prefix: Telerik Reporting +avatar-path: ./images/avatar-ninja.svg +no-results-image-path: ./images/ninja-no-results.svg +primary-color: + light: "#1D8800" + dark: "#68BF51" + +product-code: REPORTING +product-trial-url: https://www.telerik.com/try/reporting +contribute-url: https://github.com/telerik/reporting-docs/edit/master +enable-tabbed-code-blocks: true +#pdf-cover-png-path: ./images/pdf-cover.png +img-max-width: 100% +table-layout: fixed + + +meta: +# Reporting Documentation Main Nodes: + introduction: + position: 0 + title: "Introduction to Reporting" + getting-started: + position: 10 + title: "Getting Started" + ide-integration: + position: 15 + title: "IDE Integration" + security: + position: 20 + title: "Security" + licensing: + position: 25 + title: "Licensing" + report-items: + position: 30 + title: "Report Items" + designing-reports: + position: 40 + title: "Creating Reports" + embedding-reports: + position: 50 + title: "Embedding Reports" + importing-reports: + position: 60 + title: "Importing Reports" + styling: + position: 70 + title: "Styles & Appearance" + interactivity: + position: 80 + title: "Interactivity" + globalization: + position: 90 + title: "Globalization" + doc-output: + position: 100 + title: "Document Output" + upgrade: + position: 110 + title: "Upgrade" + knowledge-base: + position: 200 + title: "Knowledge Base" + api: + position: 300 + title: "API Reference" + +## Getting Started section: + getting-started/web-designer: + position: 5 + title: "Web Report Designer" + getting-started/installation: + position: 6 + title: "Download & Installation" + + +## Report Items section: + report-items/barcode: + position: 1 + title: "Barcode" +### Barcode subsection: + report-items/barcode/1d-barcodes: + position: 20 + title: "1D Barcodes" + report-items/barcode/2d-barcodes: + position: 30 + title: "2D Barcodes" + + report-items/gauge: + position: 4 + title: "Gauge" + report-items/graph: + position: 5 + title: "Graph" +### Graph subsection: + report-items/graph/chart-types: + position: 10 + title: "Chart Types" + report-items/graph/formatting-a-graph: + position: 20 + title: "Styling and Formatting" + + report-items/htmltextbox: + position: 6 + title: "HtmlTextBox" + report-items/map: + position: 7 + title: "Map" +### Map subsection: + report-items/map/map-types: + position: 10 + title: "Types and Customization" + report-items/map/structure: + position: 15 + title: "Structure and Elements" + report-items/map/formatting-a-map: + position: 20 + title: "Styling and Formatting" + + report-items/report-item: + position: 10 + title: "Report" + report-items/table-crosstab-list: + position: 13 + title: "Table" + +## Creating Reports section: + designing-reports/report-designer-tools: + position: 4 + title: "Report Designers" +### Report Designers subsection: + designing-reports/report-designer-tools/web-report-designer: + position: 10 + title: "Web Report Designer" + designing-reports/report-designer-tools/web-report-designer/tools: + position: 10 + title: "Tools" + designing-reports/report-designer-tools/desktop-designers: + position: 11 + title: "Desktop Designers" + designing-reports/report-designer-tools/desktop-designers/standalone-report-designer: + position: 10 + title: "Standalone Report Designer" + designing-reports/report-designer-tools/desktop-designers/standalone-report-designer/configuration: + position: 10 + title: "Configuration" + designing-reports/report-designer-tools/desktop-designers/visual-studio-report-designer: + position: 11 + title: "Visual Studio Report Designer" + designing-reports/report-designer-tools/desktop-designers/tools: + position: 12 + title: "Tools" + designing-reports/report-designer-tools/desktop-designers/tools/report-wizards: + position: 10 + title: "Report Wizards" + designing-reports/report-designer-tools/desktop-designers/tools/report-wizards/band-report-wizard: + position: 10 + title: "Band Report Wizard" + designing-reports/report-designer-tools/desktop-designers/tools/data-source-wizards: + position: 11 + title: "Data Source Wizards" + +### Connecting to Data subsection: + designing-reports/connecting-to-data: + position: 5 + title: "Connecting to Data" + designing-reports/connecting-to-data/data-source-components: + position: 10 + title: "Data Source Components" + designing-reports/connecting-to-data/data-source-components/sqldatasource-component: + position: 5 + title: "SqlDataSource Component" + designing-reports/connecting-to-data/data-source-components/sqldatasource-component/using-data-providers: + position: 10 + title: "Using Data Providers" + designing-reports/connecting-to-data/data-source-components/webservicedatasource-component: + position: 11 + title: "WebServiceDataSource Component" + designing-reports/connecting-to-data/data-source-components/csvdatasource-component: + position: 12 + title: "CsvDataSource Component" + designing-reports/connecting-to-data/data-source-components/graphqldatasource-component: + position: 13 + title: "GraphQLDataSource Component" + designing-reports/connecting-to-data/data-source-components/objectdatasource-component: + position: 14 + title: "ObjectDataSource Component" + designing-reports/connecting-to-data/data-source-components/entitydatasource-component: + position: 24 + title: "EntityDataSource Component" + designing-reports/connecting-to-data/data-source-components/openaccessdatasource-component: + position: 25 + title: "OpenAccessDataSource Component" + designing-reports/connecting-to-data/data-source-components/cubedatasource-component: + position: 26 + title: "CubeDataSource Component" + designing-reports/connecting-to-data/data-source-components/openclientdatasource-component: + position: 27 + title: "OpenClientDataSource Component" + designing-reports/connecting-to-data/data-items: + position: 11 + title: "Data Items" + designing-reports/connecting-to-data/data-items/filtering-data: + position: 10 + title: "Filtering Data" + designing-reports/connecting-to-data/data-items/ordering-data: + position: 11 + title: "Ordering Data" + designing-reports/connecting-to-data/data-items/grouping-data: + position: 12 + title: "Grouping Data" + designing-reports/connecting-to-data/expressions: + position: 12 + title: "Expressions" + designing-reports/connecting-to-data/expressions/using-expressions: + position: 10 + title: "Using Expressions" + designing-reports/connecting-to-data/expressions/expressions-reference: + position: 11 + title: "Expressions Reference" + designing-reports/connecting-to-data/expressions/expressions-reference/functions: + position: 15 + title: "Functions" + designing-reports/connecting-to-data/expressions/extending-expressions: + position: 12 + title: "Extending Expressions" + designing-reports/connecting-to-data/report-parameters: + position: 13 + title: "Report Parameters" +### Report Book subsection: + designing-reports/report-book: + position: 6 + title: "Report Book" + +## Embedding Reports section: + embedding-reports/host-the-report-engine-remotely: + position: 50 + title: "Generating Reports Remotely" + embedding-reports/display-reports-in-applications: + position: 60 + title: "Displaying Reports" + embedding-reports/cache-management: + position: 70 + title: "Cache Management" + embedding-reports/program-the-report-definition: + position: 80 + title: "Managing Reports Programmatically" + +### Generating Reports Remotely subsection: + embedding-reports/host-the-report-engine-remotely/asp.net-web-api-implementation: + position: 10 + title: "ASP.NET Web API Implementation" + embedding-reports/host-the-report-engine-remotely/asp.net-core-web-api-implementation: + position: 11 + title: "ASP.NET Core Web API Implementation" + embedding-reports/host-the-report-engine-remotely/servicestack-implementation: + position: 12 + title: "ServiceStack Implementation" + embedding-reports/host-the-report-engine-remotely/rest-service-report-source-resolver: + position: 13 + title: "REST Service Report Source Resolver" + embedding-reports/host-the-report-engine-remotely/rest-service-storage: + position: 14 + title: "REST Service Storage" + embedding-reports/host-the-report-engine-remotely/rest-api-reference: + position: 15 + title: "REST API Reference" + embedding-reports/host-the-report-engine-remotely/rest-api-reference/clients-api: + position: 10 + title: "Clients API" + embedding-reports/host-the-report-engine-remotely/rest-api-reference/report-parameters-api: + position: 11 + title: "Report Parameters API" + embedding-reports/host-the-report-engine-remotely/rest-api-reference/report-instances-api: + position: 12 + title: "Report Instances API" + embedding-reports/host-the-report-engine-remotely/rest-api-reference/documents-api: + position: 13 + title: "Documents API" + embedding-reports/host-the-report-engine-remotely/rest-api-reference/general-api: + position: 14 + title: "General API" + embedding-reports/host-the-report-engine-remotely/rest-api-reference/json-entities: + position: 15 + title: "JSON Entities" + +### Displaying Reports subsection: + embedding-reports/display-reports-in-applications/web-application: + position: 10 + title: "Web Application" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer: + position: 1 + title: "HTML5 Report Viewer" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/customizing: + position: 10 + title: "Customizing" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/customizing/styling-and-appearance: + position: 15 + title: "Styling and Appearance" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference: + position: 12 + title: "API Reference" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference/reportviewer: + position: 10 + title: "ReportViewer" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference/reportviewer/events: + position: 10 + title: "Events" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference/reportviewer/methods: + position: 11 + title: "Methods" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference/reportviewer/properties: + position: 12 + title: "Properties" + embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference/telerikreportviewer-namespace: + position: 12 + title: "telerikReportViewer Namespace" + + embedding-reports/display-reports-in-applications/web-application/native-blazor-report-viewer: + position: 2 + title: "Native Blazor Report Viewer" + embedding-reports/display-reports-in-applications/web-application/native-blazor-report-viewer/customizing: + position: 12 + title: "Customizing" + embedding-reports/display-reports-in-applications/web-application/native-blazor-report-viewer/api-reference: + position: 14 + title: "API Reference" + + embedding-reports/display-reports-in-applications/web-application/blazor-report-viewer: + position: 3 + title: "Blazor Report Viewer" + + embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer: + position: 4 + title: "Native Angular Report Viewer" + embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer/api-reference: + position: 15 + title: "API Reference" + embedding-reports/display-reports-in-applications/web-application/native-angular-report-viewer/customizing: + position: 14 + title: "Customizing" + + embedding-reports/display-reports-in-applications/web-application/angular-report-viewer: + position: 5 + title: "Angular Report Viewer" + embedding-reports/display-reports-in-applications/web-application/angular-report-viewer/customizing: + position: 12 + title: "Customizing" + embedding-reports/display-reports-in-applications/web-application/angular-report-viewer/api-reference: + position: 14 + title: "API Reference" + + embedding-reports/display-reports-in-applications/web-application/react-report-viewer: + position: 5 + title: "React Report Viewer" + embedding-reports/display-reports-in-applications/web-application/react-report-viewer/customizing: + position: 12 + title: "Customizing" + embedding-reports/display-reports-in-applications/web-application/react-report-viewer/api-reference: + position: 14 + title: "API Reference" + + embedding-reports/display-reports-in-applications/web-application/html5-asp.net-mvc-report-viewer: + position: 6 + title: "HTML5 ASP.NET MVC Report Viewer" + embedding-reports/display-reports-in-applications/web-application/html5-asp.net-mvc-report-viewer/customizing: + position: 15 + title: "Customizing" + + embedding-reports/display-reports-in-applications/web-application/html5-asp.net-web-forms-report-viewer: + position: 7 + title: "HTML5 ASP.NET Web Forms Report Viewer" + embedding-reports/display-reports-in-applications/web-application/html5-asp.net-web-forms-report-viewer/customizing: + position: 15 + title: "Customizing" + + embedding-reports/display-reports-in-applications/web-application/styling-with-themebuilder: + position: 8 + title: "Styling with ThemeBuilder" + + embedding-reports/display-reports-in-applications/windows-forms-application: + position: 11 + title: "Windows Forms Application" + embedding-reports/display-reports-in-applications/wpf-application: + position: 12 + title: "WPF Application" + embedding-reports/display-reports-in-applications/wpf-application/customizing: + position: 23 + title: "Customizing" + embedding-reports/display-reports-in-applications/winui-3-desktop-application: + position: 1150 + title: "WinUI 3 Desktop Application" + +### Managing Reports Programmatically subsection: + embedding-reports/program-the-report-definition/report-events: + position: 15 + title: "Report Events" + +## Styles & Appearance section: + styling/styling-reports: + position: 1 + title: "Styling" + styling/rendering-and-paging: + position: 8 + title: "Rendering and Paging" + +### Rendering and Paging subsection: + styling/rendering-and-paging/design-considerations-for-report-rendering: + position: 15 + title: "Design Considerations for Report Rendering" + +## Interactivity section: + interactivity/actions: + position: 11 + title: "Actions" + interactivity/table-of-contents: + position: 13 + title: "Table of Contents" + +### Actions subsection: + interactivity/actions/sorting-action: + position: 11 + title: "Sorting Action" + +# Document Output section: + doc-output/configure-the-report-engine: + position: 10 + title: "Configuring the Report Engine" + doc-output/configure-the-export-formats: + position: 11 + title: "Configuring the Output Formats" + +redirects: +- + from: "^/?$" + to: "/introduction" + type: Permanent \ No newline at end of file diff --git a/images/avatar-ninja.svg b/images/avatar-ninja.svg new file mode 100644 index 000000000..d98c1b207 --- /dev/null +++ b/images/avatar-ninja.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/ninja-no-results.svg b/images/ninja-no-results.svg new file mode 100644 index 000000000..5d84ade55 --- /dev/null +++ b/images/ninja-no-results.svg @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 8136fae79804168f2fcc9f9b211634a5dcbad0d2 Mon Sep 17 00:00:00 2001 From: Plamen Mitrev Date: Wed, 11 Jun 2025 17:17:24 +0300 Subject: [PATCH 2/2] unpublish files --- README.md | 2 +- to_delete.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f67cccf25..01f1ca8c7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ --- title: Telerik Reporting Documentation Repository -publish: false +published: false --- diff --git a/to_delete.md b/to_delete.md index 7f3f25956..a204ab9d5 100644 --- a/to_delete.md +++ b/to_delete.md @@ -1,5 +1,5 @@ --- layout: to_delete -publish: False +published: False sitemap: false ---