From a20447851b2339a34871f5e82d7c8a69e2e28f9c Mon Sep 17 00:00:00 2001 From: Natalia Kazakova <17986517+natakazakova@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:41:29 +0200 Subject: [PATCH] Move to new docfx 24.1 (#217) * update to new doc fx * Update README.md * fix matomo updated partial for 'default', added layout for modern, fix parameters to pass metadata * Apply suggestions from code review Co-authored-by: pollyndos <56310766+pollyndos@users.noreply.github.com> * add gitignore * add license * fix word order * move note --------- Co-authored-by: Sergey Avramenko Co-authored-by: pollyndos <56310766+pollyndos@users.noreply.github.com> --- .../workflows/build-eud-on-pull-request.yml | 2 +- .github/workflows/update-gh-pages-branch.yml | 4 +- .gitignore | 5 +- .template/layout/_master.tmpl | 169 ++++++++++++++++++ .template/partials/head.tmpl.partial | 62 ++++--- .template/public/main.css | 7 + .template/public/main.js | 11 ++ README.md | 162 +++++++++++------ dashboard-for-desktop/articles/index.md | 6 + dashboard-for-desktop/toc.yml | 1 + dashboard-for-web/articles/index.md | 6 + dashboard-for-web/toc.yml | 1 + docfx.json | 106 ++++------- index.md | 17 +- .../articles/index.md | 6 + interface-elements-for-desktop/toc.yml | 1 + interface-elements-for-web/articles/index.md | 6 + interface-elements-for-web/toc.yml | 1 + reporting-for-desktop/articles/index.md | 6 + reporting-for-desktop/toc.yml | 1 + reporting-for-web/articles/index.md | 6 + reporting-for-web/toc.yml | 1 + toc.yml | 1 + 23 files changed, 428 insertions(+), 160 deletions(-) create mode 100644 .template/layout/_master.tmpl create mode 100644 .template/public/main.css create mode 100644 .template/public/main.js diff --git a/.github/workflows/build-eud-on-pull-request.yml b/.github/workflows/build-eud-on-pull-request.yml index d3717303b5..c1ca14624b 100644 --- a/.github/workflows/build-eud-on-pull-request.yml +++ b/.github/workflows/build-eud-on-pull-request.yml @@ -20,4 +20,4 @@ jobs: run: Expand-Archive ../docfx-win-x64-v2.77.0.zip -DestinationPath ../docfx - name: Build site with docfx - run: ../docfx/docfx.exe build docfx.json --warningsAsErrors + run: ../docfx/docfx.exe build docfx.json -m _matomoContainerUrl="https://matomo.devexpress.com/js/container_kE7MWPi0.js" --warningsAsErrors \ No newline at end of file diff --git a/.github/workflows/update-gh-pages-branch.yml b/.github/workflows/update-gh-pages-branch.yml index ffbc91c7b1..1fb9c55a73 100644 --- a/.github/workflows/update-gh-pages-branch.yml +++ b/.github/workflows/update-gh-pages-branch.yml @@ -20,7 +20,7 @@ jobs: run: Expand-Archive ../docfx-win-x64-v2.77.0.zip -DestinationPath ../docfx - name: Build site with docfx - run: "../docfx/docfx.exe build docfx.json --metadata \"{ '_matomoContainerUrl': 'https://matomo.devexpress.com/js/container_kE7MWPi0.js' }\" --warningsAsErrors" + run: "../docfx/docfx.exe build docfx.json -m _matomoContainerUrl=\"https://matomo.devexpress.com/js/container_kE7MWPi0.js\" --warningsAsErrors" - name: Archive site run: Compress-Archive -Path _site/* -DestinationPath ${{ runner.temp }}/site.zip @@ -54,4 +54,4 @@ jobs: git config user.email github-actions@github.com git add . git commit -m "Pages update" - git push + git push \ No newline at end of file diff --git a/.gitignore b/.gitignore index a88ab71604..934def21e6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ -_* -obj -.vscode \ No newline at end of file +_site +*.pdf \ No newline at end of file diff --git a/.template/layout/_master.tmpl b/.template/layout/_master.tmpl new file mode 100644 index 0000000000..bb20e4417a --- /dev/null +++ b/.template/layout/_master.tmpl @@ -0,0 +1,169 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{!include(/^public/.*/)}} +{{!include(favicon.ico)}} +{{!include(logo.svg)}} + + + + + {{#redirect_url}} + + {{/redirect_url}} + {{^redirect_url}} + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + {{#_description}}{{/_description}} + {{#description}}{{/description}} + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_disableNewTab}}{{/_disableNewTab}} + {{#_disableTocFilter}}{{/_disableTocFilter}} + {{#docurl}}{{/docurl}} + + + + + + + + + + + + + + + + + + {{#_googleAnalyticsTagId}} + + + {{/_googleAnalyticsTagId}} + {{#_matomoContainerUrl}} + + + + {{/_matomoContainerUrl}} + {{/redirect_url}} + + + {{^redirect_url}} + +
+ {{^_disableNavbar}} + + {{/_disableNavbar}} +
+ +
+ {{^_disableToc}} +
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ {{/_disableToc}} + +
+
+ {{^_disableToc}} + + {{/_disableToc}} + + {{^_disableBreadcrumb}} + + {{/_disableBreadcrumb}} +
+ +
+ {{!body}} +
+ + {{^_disableContribution}} +
+ {{#sourceurl}} + {{__global.improveThisDoc}} + {{/sourceurl}} + {{^sourceurl}}{{#docurl}} + {{__global.improveThisDoc}} + {{/docurl}}{{/sourceurl}} +
+ {{/_disableContribution}} + + {{^_disableNextArticle}} + + {{/_disableNextArticle}} + +
+ + {{^_disableAffix}} +
+ +
+ {{/_disableAffix}} +
+ + {{#_enableSearch}} +
+ {{/_enableSearch}} + + + + {{/redirect_url}} + diff --git a/.template/partials/head.tmpl.partial b/.template/partials/head.tmpl.partial index 66dc060372..40a2f7fc36 100644 --- a/.template/partials/head.tmpl.partial +++ b/.template/partials/head.tmpl.partial @@ -1,30 +1,44 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} - - {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} - - - - {{#_description}}{{/_description}} - - - - - - - {{#_noindex}}{{/_noindex}} - {{#_enableSearch}}{{/_enableSearch}} - {{#_enableNewTab}}{{/_enableNewTab}} - {{#_matomoContainerUrl}} - + {{#_googleAnalyticsTagId}} + - - {{/_matomoContainerUrl}} + {{/_googleAnalyticsTagId}} + {{#redirect_url}} + + {{/redirect_url}} + {{^redirect_url}} + + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + {{#_description}}{{/_description}} + {{#description}}{{/description}} + + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_enableNewTab}}{{/_enableNewTab}} + {{#_matomoContainerUrl}} + + + + {{/_matomoContainerUrl}} + {{/redirect_url}} diff --git a/.template/public/main.css b/.template/public/main.css new file mode 100644 index 0000000000..a81a1454fc --- /dev/null +++ b/.template/public/main.css @@ -0,0 +1,7 @@ +/* file: my-template/public/main.css */ +article a { + text-decoration: none; +} +article a:hover{ + text-decoration: underline; +} \ No newline at end of file diff --git a/.template/public/main.js b/.template/public/main.js new file mode 100644 index 0000000000..0d321e2201 --- /dev/null +++ b/.template/public/main.js @@ -0,0 +1,11 @@ +/* file: .template/public/main.js */ +export default { + defaultTheme: 'dark', + iconLinks: [ + { + icon: 'github', + href: 'https://github.com/DevExpress/dotnet-eud', + title: 'GitHub' + } + ] + } \ No newline at end of file diff --git a/README.md b/README.md index 5f0a5cde18..0ff098ca29 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,136 @@ # DevExpress End-User Documentation -This article explains how to clone DevExpress End-User documentation sources and how to create your own documentation websites and help files for projects based on DevExpress technologies. You can also find a link to a sample pre-built website. +> By accessing this repository, you agree to the terms of the [DevExpress End-User Documentation License Agreement](LICENSE.md). -> For **Developer Documentation with API Reference** see [https://docs.devexpress.com](https://docs.devexpress.com). +Learn how to clone DevExpress End-User documentation and use sources as a white-labeled documentation. Create your own documentation websites and PDF files for projects based on DevExpress technologies. You can also review a sample pre-built website. -## The Scope -DevExpress products for WinForms and ASP.NET WebForms/MVC. +End-User Documentation contains information about [WinForms](https://www.devexpress.com/products/net/controls/winforms/) and ASP.NET [WebForms](https://www.devexpress.com/products/net/controls/asp/)/[MVC](https://www.devexpress.com/products/net/controls/asp/mvc/) products, as well as [Reporting](https://www.devexpress.com/subscriptions/reporting/) and [Business Intelligence Dashboard](https://www.devexpress.com/products/net/dashboard/). -## Licensing -By accessing this repository, you agree to the terms of the [DevExpress End-User Documentation License Agreement](LICENSE.md). +If you search for **Developer Documentation with API Reference**, refer to [docs.devexpress.com](https://docs.devexpress.com). -## How to View Content + +## Document Format and Supported Output Types +Documents in this repository are written in markdown. You can manually copy the information to your own help file according to our [license](LICENSE.md). + +The repository uses [DocFX](https://dotnet.github.io/docfx/) to convert markdown files to an HTML website or a PDF file. + +You can make the following changes to the documentation, or skip this step if you want to reuse the end-user documentation as is: + +- Remove unnecessary files. +- Add new documents to your application. You should update the *toc.yml* ([table-of-content](https://dotnet.github.io/docfx/docs/table-of-contents.html)) files if you added or removed topics. +- Change screenshots to match your app's UI. +- Specify logo and site titles: [Template Metadata](https://dotnet.github.io/docfx/docs/template.html#template-metadata). +- Create a [custom DocFX template](https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html). + +## View Content Do one of the following to view the End-User Documentation content: -1. Browse this repository's content directly. Start with [index.md](index.md). -2. View the sample pre-built website at [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/). -3. [Build PDF files](#build-printer-friendly-pdf-files). +1. Browse this repository's content directly: [index.md](index.md) +1. View the pre-built sample website: [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/) +1. [Build an HTML Website](#build-an-html-website) +1. [Build PDF files](#build-pdf-files) -## Document Format and Supported Output Types -Documents in this repository are written in markdown. You can manually copy the information to your own help file. +### Build an HTML Website -The repository also includes a [docfx.json](docfx.json) file. You can use [DocFX](https://dotnet.github.io/docfx/) and [wkhtmltopdf](https://github.com/wkhtmltopdf/wkhtmltopdf) to convert this file from a set of topics to an HTML website or a PDF file. +> Prerequisites +> - Familiarity with the command line +> - [.NET SDK](https://dotnet.microsoft.com/en-us/download) 6.0 or higher +> - [Git](https://git-scm.com/) -## Build an HTML Website -Follow the steps below to create a documentation website for your application. +Make sure you have [.NET SDK](https://dotnet.microsoft.com/en-us/download) installed, then open a terminal and enter the following command to install the latest DocFX: -1. Download and install the [latest version of DocFX](https://github.com/dotnet/docfx/releases). -1. Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. Do not use the **master** branch because it represents the version currently under development. - ``` - git clone https://github.com/DevExpress/dotnet-eud.git - git switch 20.1 - ``` - If you do not have [Git](https://git-scm.com/) installed, use the GitHub web interface to select the branch and then download and extract the ZIP archive. - - ![Download ZIP](https://user-images.githubusercontent.com/20167812/29712204-4ffaee9e-89a1-11e7-8a0e-3ff0464adda4.png) -1. You can make the following changes to the documentation, or skip this step if you want to reuse the end-user documentation as is: - - - remove unnecessary files; - - add new documents to your application; - - change screenshots to match your app's UI; - - create a [custom DocFX template](https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html). - - > You should update the *toc.yml* ([table-of-content](https://dotnet.github.io/docfx/tutorial/intro_toc.html)) files if you added or removed topics. -1. Open a console window, change the current directory to the repository root folder and call the DocFX executable with the following parameters: *build* and the path to *docfx.json* in the downloaded _dotnet-eud_ repository. DocFX will place the generated documentation content into the *\_site* folder. Add the `--serve` switch to preview the generated website at http://localhost:8080 once the build process is complete. - ``` - docfx.exe build ../dotnet-eud/docfx.json --serve - ``` -1. Deploy the created documentation to a web server or browse the documentation directly from local file system. Since DocFX creates static HTML files only, no additional deployment or configuration steps are required. +```bash +dotnet tool update -g docfx +``` -## Build Printer-Friendly PDF Files -If your end users require a printed version, you can build a PDF file like this: +> You can also download the latest version of DocFX directly: [releases](https://github.com/dotnet/docfx/releases). -1. Ensure that you can successfully [build a website with DocFX](#build-your-own-documentation-website). -1. Download and install [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html). -1. In the folder with `docfx.exe`, open a console window and add the `wkhtmltopdf` executable path to the `%PATH%` environment variable: +> [!Warning] +> Do not use the `master` branch because it is the version currently under development. - ``` - set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin - ``` +Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. -1. Build pdf: +``` +git clone https://github.com/DevExpress/dotnet-eud +git switch 20.1 +``` - ``` - docfx.exe pdf ../dotnet-eud/docfx.json - ``` +Once you switched to a version-based branch, you can make changes to the documentation. + +To preview changes, open a console window and call the `docfx build` command with the path to *docfx.json* in the downloaded _dotnet-eud_ repository. DocFX will place the generated documentation content into the *\_site* folder. Add `--serve` to preview the generated website at http://localhost:8080 once the build process is complete. + +```bash +docfx build D:/dotnet-eud/docfx.json --serve +``` +DocFX produces static HTML files under the *_site* folder ready to publish to any static site hosting server. Deploy the created documentation to a web server or browse the documentation directly from the local file system. For more information, refer to the DocFX documentation: [Publish to GitHub Pages](https://dotnet.github.io/docfx/index.html#publish-to-github-pages). + +### Build PDF Files +If your end users require a printed version, you can build a PDF file. + +You can configure PDF file generation in several ways. + +The resulted PDF file will be located next to the *toc.yml* file in the *_site* folder. + +#### Build Locally + +Open the console and call `docfx pdf D:\test-eud\docfx.json`. You need a succeeded build before you proceed. + +#### Use docfx.json + +Include the `pdf` command to _docfx.json_. + +```json +{ + "build": { + "fileMetadata":{ + "pdf": true + } + } +} +``` + +You can generate PDF only for a specific _toc.yml_: + +```json +{ + "build": { + "fileMetadata":{ + "pdf": { + "dashboard-for-web/**/toc.yml": true + } + } + } +} +``` + +#### Use toc.yml + +Include the `pdf` command to _toc.yml_ to generate PDF according to this table of content: + +```yaml +pdf: true +items: +- name: Reporting for Web + href: reporting-for-web/ + topicHref: reporting-for-web/articles/index.md +``` + +Refer to the following article for detailed instructions: [Create PDF Files](https://dotnet.github.io/docfx/docs/pdf.html). -This generates a *_pdf* subfоlder with a PDF file for each included table-of-contents file. Note that this is a time-consuming process. ## Troubleshooting Below are the common issues you can face when building this repository's documentation. +* #### The build failed with errors/warnings + + Refer to build output to find the cause of the problem. + * #### The build process fails with the *System.IO.PathTooLongException* exception Reduce your working directory's full path (move the repository closer to a drive root). *See also:* https://github.com/dotnet/docfx/issues/156 -* #### The *wkhtmltopdf is a prerequisite when generating a PDF* error occurs when creating a PDF - Ensure that [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html) is installed and its executable path is correctly added to the *%PATH%* environment variable. - - *See also:* [Generate PDF Documentation](http://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_generate_pdf.html) - * #### The table of contents is not displayed when browsing the generated documentation from the file system Your browser security configuration may restrict executing the JavaScript code that accesses your local files (the table of contents is in a separate *toc.html* file when using the [default](https://github.com/dotnet/docfx/tree/dev/src/docfx.website.themes/default) DocFX template). In this case, you can use the [statictoc](https://github.com/dotnet/docfx/tree/dev/src/docfx.website.themes/statictoc) template instead. To switch to this template, add `--template statictoc` to the docfx.exe parameters: ``` @@ -90,7 +140,7 @@ Below are the common issues you can face when building this repository's documen > We recommend you to use the `--serve` DocFX switch to preview documentation, and then share it with end users via a web server instead of browsing the file system. -If your issue is not listed, you can [submit a new issue to this repository](https://github.com/DevExpress/dotnet-eud/issues/new) or contact us via the [DevExpress Support Center](https://www.devexpress.com/Support/Center/). You can search the [DocFX issues list](https://github.com/dotnet/docfx/issues), or try building the [docfx\-seed](https://github.com/docascode/docfx-seed) sample documentation project to check if your issue is specific to this repository. +If your issue is not listed, you can [submit a new issue to this repository](https://github.com/DevExpress/dotnet-eud/issues/new) or contact us via the [DevExpress Support Center](https://supportcenter.devexpress.com/ticket/create). You can search the [DocFX issues list](https://github.com/dotnet/docfx/issues), or try building the [docfx-seed](https://github.com/docascode/docfx-seed) sample documentation project to check if your issue is specific to this repository. ## Versions 17.1 and Earlier diff --git a/dashboard-for-desktop/articles/index.md b/dashboard-for-desktop/articles/index.md index 81dc295bae..411fe23783 100644 --- a/dashboard-for-desktop/articles/index.md +++ b/dashboard-for-desktop/articles/index.md @@ -4,6 +4,12 @@ author: Natalia Kazakova legacyId: 15757 --- # Dashboard for Desktop + +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). + The **DevExpress Dashboard** is an interactive data visualization tool optimized for real-time data consumption and analysis. It includes the following components: * [Dashboard Designer](dashboard-designer.md) - provides a comprehensive UI for designing dashboards from scratch. * [Dashboard Viewer](dashboard-viewer.md) - enables you to display dashboards in Windows Forms applications. \ No newline at end of file diff --git a/dashboard-for-desktop/toc.yml b/dashboard-for-desktop/toc.yml index f68a9adbd2..98f6080037 100644 --- a/dashboard-for-desktop/toc.yml +++ b/dashboard-for-desktop/toc.yml @@ -1,3 +1,4 @@ +items: - name: Dashboard Designer href: articles/dashboard-designer.md items: diff --git a/dashboard-for-web/articles/index.md b/dashboard-for-web/articles/index.md index 471ee948f8..e21ad52878 100644 --- a/dashboard-for-web/articles/index.md +++ b/dashboard-for-web/articles/index.md @@ -4,6 +4,12 @@ author: Natalia Kazakova legacyId: 16709 --- # Dashboard for Web + +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). + The Web Dashboard allows you to create and display dashboards on the web. * [Web Dashboard - Designer Mode](web-dashboard-designer-mode.md) * [Web Dashboard - Viewer Mode](web-dashboard-viewer-mode.md) \ No newline at end of file diff --git a/dashboard-for-web/toc.yml b/dashboard-for-web/toc.yml index d887d68cc3..bea263a267 100644 --- a/dashboard-for-web/toc.yml +++ b/dashboard-for-web/toc.yml @@ -1,3 +1,4 @@ +items: - name: Web Dashboard - Designer Mode href: articles/web-dashboard-designer-mode.md items: diff --git a/docfx.json b/docfx.json index 33e8567f84..d332345a5c 100644 --- a/docfx.json +++ b/docfx.json @@ -3,87 +3,53 @@ "content": [ { "files": [ - "dashboard-for-desktop/**/*.{md,yml}", - "dashboard-for-web/**/*.{md,yml}", - "interface-elements-for-desktop/**/*.{md,yml}", - "interface-elements-for-web/**/*.{md,yml}", - "reporting-for-desktop/**/*.{md,yml}", - "reporting-for-web/**/*.{md,yml}", - "toc.yml", - "index.md" - ], + "dashboard-for-desktop/**/*.{md,yml}", + "dashboard-for-web/**/*.{md,yml}", + "interface-elements-for-desktop/**/*.{md,yml}", + "interface-elements-for-web/**/*.{md,yml}", + "reporting-for-desktop/**/*.{md,yml}", + "reporting-for-web/**/*.{md,yml}", + "toc.yml", + "index.md" + ], "exclude": [ "_*/**", - "obj/**" ] } ], "resource": [ { "files": [ - "favicon.ico", - "logo.svg", - "dashboard-for-desktop/images/**", - "dashboard-for-web/images/**", - "interface-elements-for-desktop/images/**", - "interface-elements-for-web/images/**", - "reporting-for-desktop/images/**", - "reporting-for-web/images/**" - ], - "exclude": [ - "obj/**", - "_*/**" - ] + "favicon.ico", + "logo.svg", + "dashboard-for-desktop/images/**", + "dashboard-for-web/images/**", + "interface-elements-for-desktop/images/**", + "interface-elements-for-web/images/**", + "reporting-for-desktop/images/**", + "reporting-for-web/images/**" + ], + "exclude": [ + "_*/**" + ] } ], - "dest": "_site", + "output": "_site", "template": [ - "default", - "./.template" - ], - "globalMetadata": { - "_appTitle": "DevExpress End-User Documentation" , - "_appFaviconPath": "favicon.ico", - "_appFooter": "Copyright (c) 1998-2024 Developer Express Inc. All rights reserved.", - "_appLogoPath": "logo.svg" - } - }, - "pdf": { - "content": [ - { - "files": [ - "dashboard-for-desktop/**/*.{md,yml}", - "dashboard-for-web/**/*.{md,yml}", - "interface-elements-for-desktop/**/*.{md,yml}", - "interface-elements-for-web/**/*.{md,yml}", - "reporting-for-desktop/**/*.{md,yml}", - "reporting-for-web/**/*.{md,yml}" - ], - "exclude": [ - "_*/**", - "obj/**" - ] - } + "default", + "modern", + "./.template" ], - "resource": [ - { - "files": [ - "dashboard-for-desktop/images/**", - "dashboard-for-web/images/**", - "interface-elements-for-desktop/images/**", - "interface-elements-for-web/images/**", - "reporting-for-desktop/images/**", - "reporting-for-web/images/**" - ], - "exclude": [ - "obj/**", - "_*/**" - ] - } - ], - "dest": "_pdf", - "wkhtmltopdf": { - "additionalArguments": "--enable-local-file-access" + "sitemap": { + "baseUrl": "https://devexpress.github.io/" + }, + "globalMetadata": { + "_appName": "DevExpress EUD", + "_appTitle": "DevExpress End-User Documentation", + "_appFaviconPath": "favicon.ico", + "_appFooter": "Copyright (c) 1998-2024 Developer Express Inc. All rights reserved.", + "_appLogoPath": "logo.svg", + "_enableSearch": true } } -} +} \ No newline at end of file diff --git a/index.md b/index.md index 2e29a667c8..a1590bd8f4 100644 --- a/index.md +++ b/index.md @@ -1,13 +1,20 @@ --- +_disableBreadcrumb: true title: End-User Documentation -author: Konstantin Belyakov +author: Natalia Kazakova legacyId: 5917 --- -This documentation contains information on individual user interface elements (such as grids, navigation panes, data editors, charts, etc.), and provides instructions for end-users about how to solve the most-common tasks with these interface elements. -# End-User Documentation +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). -The end-user documentation is divided into four target platforms: +# DevExpress End-User Documentation + +This documentation contains information on individual user interface elements (such as grids, navigation panes, data editors, charts, etc.), and provides instructions for end users about how to solve the most-common tasks with these interface elements. + +The end user documentation is divided into the following platforms and products: #### Web (ASP.NET): @@ -20,3 +27,5 @@ The end-user documentation is divided into four target platforms: * [Reporting for Desktop](reporting-for-desktop/articles/index.md) * [Dashboard for Desktop](dashboard-for-desktop/articles/index.md) * [Interface Elements for Desktop](interface-elements-for-desktop/articles/index.md) + +If you search for DevExpress developer documentation with API reference, refer to [docs.devexpress.com](https://docs.devexpress.com). \ No newline at end of file diff --git a/interface-elements-for-desktop/articles/index.md b/interface-elements-for-desktop/articles/index.md index dc4cf794f1..cc3c4b2ae6 100644 --- a/interface-elements-for-desktop/articles/index.md +++ b/interface-elements-for-desktop/articles/index.md @@ -4,6 +4,12 @@ author: Alexey Kazakov legacyId: 5647 --- # Interface Elements for Desktop + +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). + This documentation provides information on individual User Interface Elements such as grids, navigation panes, data editors, etc. Each element can provide context menus, allow numerous mouse operations and support various keyboard shortcuts. Click on the element you are interested in for more information. diff --git a/interface-elements-for-desktop/toc.yml b/interface-elements-for-desktop/toc.yml index efe4209761..0db6b42bcc 100644 --- a/interface-elements-for-desktop/toc.yml +++ b/interface-elements-for-desktop/toc.yml @@ -1,3 +1,4 @@ +items: - name: Charting href: articles/charting.md items: diff --git a/interface-elements-for-web/articles/index.md b/interface-elements-for-web/articles/index.md index 6f47d952bb..14330998c3 100644 --- a/interface-elements-for-web/articles/index.md +++ b/interface-elements-for-web/articles/index.md @@ -4,6 +4,12 @@ author: Alexey Akimov legacyId: 5646 --- # Interface Elements for Web + +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). + This documentation provides information on individual User Interface Elements such as grids, navigation panes, data editors, etc. Each element can provide context menus, allow numerous mouse operations and support a number of keyboard shortcuts. To obtain information about these features, browse through the table of contents to locate the element you are interested in. diff --git a/interface-elements-for-web/toc.yml b/interface-elements-for-web/toc.yml index afc2d6d73a..0c229735b1 100644 --- a/interface-elements-for-web/toc.yml +++ b/interface-elements-for-web/toc.yml @@ -1,3 +1,4 @@ +items: - name: Common Activities href: articles/common-activities.md items: diff --git a/reporting-for-desktop/articles/index.md b/reporting-for-desktop/articles/index.md index 365df0e825..e58cad8c2a 100644 --- a/reporting-for-desktop/articles/index.md +++ b/reporting-for-desktop/articles/index.md @@ -4,6 +4,12 @@ author: Anna Gubareva --- # Reporting for Desktop +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). + + This section contains information about the basic principles of creating reports with Report Designers. The Report Designer user interface varies depending on your application platform. diff --git a/reporting-for-desktop/toc.yml b/reporting-for-desktop/toc.yml index 697f52241c..9d051afaac 100644 --- a/reporting-for-desktop/toc.yml +++ b/reporting-for-desktop/toc.yml @@ -1,3 +1,4 @@ +items: - name: Report Designer for WinForms href: articles/report-designer/report-designer-for-winforms.md items: diff --git a/reporting-for-web/articles/index.md b/reporting-for-web/articles/index.md index c03f1245d1..17d1114053 100644 --- a/reporting-for-web/articles/index.md +++ b/reporting-for-web/articles/index.md @@ -5,6 +5,12 @@ legacyId: 15757 --- # Reporting for Web +> [!Warning] +> This is a pre-built example of documentation. You can download the source code and use it as a white-label documentation according to our [DevExpress End-User Documentation License Agreement](https://github.com/DevExpress/dotnet-eud/blob/master/LICENSE.md). +> +> View source code: [github.com/DevExpress/dotnet-eud](https://github.com/DevExpress/dotnet-eud). + + This section contains information about the basic principles of creating, viewing, and exporting reports on the Web. The following sections contains information about Web Report Designer and Web Document Viewer: diff --git a/reporting-for-web/toc.yml b/reporting-for-web/toc.yml index 2a0bfdf55e..696f5b4d5d 100644 --- a/reporting-for-web/toc.yml +++ b/reporting-for-web/toc.yml @@ -1,3 +1,4 @@ +items: - name: Document Viewer href: articles/document-viewer.md items: diff --git a/toc.yml b/toc.yml index 3d15c9071b..8b4c60ee9c 100644 --- a/toc.yml +++ b/toc.yml @@ -1,3 +1,4 @@ +items: - name: Reporting for Web href: reporting-for-web/ topicHref: reporting-for-web/articles/index.md