From c44c215e4488b209397142136511f077ce970192 Mon Sep 17 00:00:00 2001 From: Natalia Kazakova Date: Tue, 24 Sep 2024 17:45:45 +0200 Subject: [PATCH 1/8] update to new doc fx --- .../workflows/build-eud-on-pull-request.yml | 2 +- .github/workflows/update-gh-pages-branch.yml | 2 +- .gitignore | 3 - .template/partials/head.tmpl.partial | 2 +- .template/public/main.css | 7 + .template/public/main.js | 11 ++ LICENSE.md | 87 ---------- README.md | 163 ++++++++++++------ 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, 220 insertions(+), 223 deletions(-) delete mode 100644 .gitignore create mode 100644 .template/public/main.css create mode 100644 .template/public/main.js delete mode 100644 LICENSE.md diff --git a/.github/workflows/build-eud-on-pull-request.yml b/.github/workflows/build-eud-on-pull-request.yml index d3717303b5..6597c73d9c 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 --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..95b69099a1 100644 --- a/.github/workflows/update-gh-pages-branch.yml +++ b/.github/workflows/update-gh-pages-branch.yml @@ -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 deleted file mode 100644 index a88ab71604..0000000000 --- a/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -_* -obj -.vscode \ No newline at end of file diff --git a/.template/partials/head.tmpl.partial b/.template/partials/head.tmpl.partial index 66dc060372..32fd1648ea 100644 --- a/.template/partials/head.tmpl.partial +++ b/.template/partials/head.tmpl.partial @@ -27,4 +27,4 @@ {{/_matomoContainerUrl}} - + \ No newline at end of file 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/LICENSE.md b/LICENSE.md deleted file mode 100644 index 4c4c701422..0000000000 --- a/LICENSE.md +++ /dev/null @@ -1,87 +0,0 @@ -DEVELOPER EXPRESS INC -DEVEXPRESS Components/Tools End-User Help Documentation -Copyright (C) 2000-2024 Developer Express Inc. - -END-USER LICENSE AGREEMENT - -IMPORTANT- READ CAREFULLY: This DEVELOPER EXPRESS INC ("DEVEXPRESS") End-User License Agreement ("EULA" or "AGREEMENT") is a legal agreement between you, a developer of software applications, ("Developer End User") and DEVEXPRESS for DEVEXPRESS Components/Tools End-User Help Documentation ("SOFTWARE DOCUMENTATION") contained in this file. - -DEVEXPRESS grants to you as an individual, a personal, nonexclusive license to install and use the SOFTWARE DOCUMENTATION for your specific business requirements. By installing, copying, or otherwise using the SOFTWARE DOCUMENTATION, you agree to be bound by the terms of this EULA. If you do not agree to any part of the terms of this EULA, DO NOT INSTALL, USE, OR EVALUATE, ANY PART, FILE OR PORTION OF THE SOFTWARE DOCUMENTATION. - -This AGREEMENT is the entire agreement between DEVEXPRESS and LICENSEE concerning its subject matter (including the license, access, and use of the SOFTWARE DOCUMENTATION, and supersedes all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning its subject matter. The parties agree that any term or condition stated in a LICENSEE quote, bid, purchase order, or in any other LICENSEE terms or order documentation (collectively “LICENSEE DOCUMENTATION”) is void. In the event of any conflict or inconsistency between the terms of this AGREEMENT and any LICENSEE DOCUMENTATION, the terms of this AGREEMENT shall prevail. - -All SOFTWARE DOCUMENTATION is licensed, not sold. - -1. GRANT OF LICENSE. - -Only licensed DEVEXPRESS customers may install and use the SOFTWARE DOCUMENTATION. If you have not purchased a license for a DEVEXPRESS PRODUCT, you are prohibited from installing, copying, or otherwise using this SOFTWARE DOCUMENTATION. - -Developer End User may install and use the SOFTWARE DOCUMENTATION on a single computer. Developer End User may also install and use the SOFTWARE DOCUMENTATION on a portable computer. - -2. LIMITATIONS ON MODIFICATIONS TO SOFTWARE DOCUMENTATION. - -This SOFTWARE DOCUMENTATION can be modified by licensed Developer End Users to meet specific business needs or requirements of Developer End User. - -3. SEPARATION OF COMPONENTS. - -The SOFTWARE DOCUMENTATION is licensed as a single product. The SOFTWARE DOCUMENTATION and its constituent parts may be separated by Developer End User to meet specific business needs or requirements of Developer End User. - -4. RENTAL. - -You may not rent, lease, or lend the SOFTWARE DOCUMENTATION. - -5. TRANSFER. - -You may NOT permanently or temporarily transfer ANY of your rights under this EULA to any individual or entity without prior written approval from DEVEXPRESS. Only you as the licensed Developer End User have the right to use the SOFTWARE DOCUMENTATION (or any portions thereof). - -6. REDISTRIBUTION. - -Licensed Developer End Users are authorized to redistribute SOFTWARE DOCUMENTATION with applications and or business solution they have developed that use DEVEXPRESS PRODUCTS. - -AT NO TIME MAY DEVELOPER END USER CREATE ANY TOOL, REDISTRIBUTABLE, OR SOFTWARE PRODUCT(S) THAT DIRECTLY OR INDIRECTLY COMPETES WITH DEVEXPRESS SOFTWARE PRODUCT(S) WHICH UTILIZES ALL OR ANY PORTION OF THE SOFTWARE DOCUMENTATION contained within this installation. - -7. COPYRIGHT. - -All title and copyrights in and to the SOFTWARE DOCUMENTATION contained in this installation are owned by DEVEXPRESS or its subsidiaries. The SOFTWARE DOCUMENTATION is protected by copyright laws and international treaty provisions and therefore, you must treat the SOFTWARE DOCUMENTATION like any other copyrighted material except that you may install and use the SOFTWARE DOCUMENTATION as described in this EULA. - -8. U.S. GOVERNMENT RESTRICTED RIGHTS. - -The Licensed Software is Commercial Computer Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFAR 255.227-7013 et. seq. or 252.211-7015, or subparagraphs (a) through (d) of the Commercial Computer Software Restricted Rights at FAR 52.227-19, as applicable, or similar clauses in the NASA FAR Supplement. Contractor-manufacturer is Developer Express Inc. / 330 N. Brand Blvd Suite 370, Glendale, CA 91203. - -9. EXPORT RESTRICTIONS. - -DEVEXPRESS expressly complies with all export restrictions imposed by the government of the United States of America. You, as LICENSEE, must agree not to export or re-export the SOFTWARE DEVELOPMENT PRODUCT(S) within any created application to any country, person, entity or end user subject to U.S.A. export restrictions. Restricted countries currently include, but are not necessarily limited to Cuba, Iran, North Korea, Sudan, Syria, and Venezuela. You warrant and represent that neither the U.S.A. Bureau of Export Administration nor any other federal agency has suspended, revoked or denied your export privileges. - -10. DISCLAIMER OF WARRANTY. - -DEVEXPRESS expressly disclaims any warranty for the SOFTWARE DOCUMENTATION. THE SOFTWARE DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. DEVEXPRESS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE, OR THE RESULTS OF THE USE, OF THE SOFTWARE DOCUMENTATION IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, OR OTHERWISE. THE ENTIRE RISK ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE DOCUMENTATION REMAINS WITH YOU. No oral or written information or advice given by DEVEXPRESS or its employees shall create a warranty or in any way increase the scope of this warranty. - -11. LIMITATIONS ON LIABILITY. - -To the maximum extent permitted by applicable law, in no event shall DEVEXPRESS be liable for any special, incidental, indirect, or consequential damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use the SOFTWARE DOCUMENTATION or the provision of or failure to provide Support Services, even if DEVEXPRESS has been advised of the possibility of such damages. - -Developer End User understands that the SOFTWARE DOCUMENTATION may lead to inaccurate results because of a failure or fault within the SOFTWARE PRODUCT(S) or failure by Developer End User to properly use and or deploy the SOFTWARE PRODUCT(S). Developer End User assumes full and sole responsibility for any use of the SOFTWARE DOCUMENTATION, and bears the entire risk for failures or faults within the SOFTWARE PRODUCT(S). You agree that regardless of the cause of failure or fault or the form of any claim, YOUR SOLE REMEDY AND DEVEXPRESS'S SOLE OBLIGATION SHALL BE GOVERNED BY THIS AGREEMENT AND IN NO EVENT SHALL DEVEXPRESS'S LIABILITY EXCEED THE PRICE PAID TO DEVEXPRESS FOR THE SOFTWARE DOCUMENTATION. This Limited Warranty is void if failure of the SOFTWARE PRODUCT(S) has resulted from accident, abuse, alteration, unauthorized use or misapplication of the SOFTWARE PRODUCT(S). - -12. INDEMNIFICATION. - -You hereby agree to indemnify DEVEXPRESS and its officers, directors, employees, agents, and representatives from each and every demand, claim, loss, liability, or damage of any kind, including actual attorneys fees, whether in tort or contract, that it or any of them may incur by reason of, or arising out of, any claim which is made by any third party with respect to any breach or violation of this Agreement by you or any claims based on the Applications and the SOFTWARE DOCUMENTATION included herein. - -13. TERMINATION. - -Without prejudice to any other rights or remedies, DEVEXPRESS will terminate this EULA upon your failure to comply with all the terms and conditions of this EULA. In such events, you must destroy all copies of the SOFTWARE DOCUMENTATION and all of its component parts. - -14. MISCELLANEOUS. - -This EULA shall be construed, interpreted and governed by the laws of the State of Nevada, U.S.A. This EULA gives you specific legal rights; you may have others that vary from state to state and from country to country. - -This AGREEMENT may only be modified in writing signed by you and an authorized officer of Developer Express Inc. This AGREEMENT is the entire agreement between DEVEXPRESS and LICENSEE concerning its subject matter (including the license, access, and use of the SOFTWARE DEVELOPMENT PRODUCT(S), and supersedes all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning its subject matter. The parties agree that any term or condition stated in a LICENSEE quote, bid, purchase order, or in any other LICENSEE terms or order documentation (collectively “LICENSEE DOCUMENTATION”) is void. In the event of any conflict or inconsistency between the terms of this AGREEMENT and any LICENSEE DOCUMENTATION, the terms of this AGREEMENT shall prevail. - -If any provision of this AGREEMENT is found void or unenforceable, the remainder will remain valid and enforceable according to its terms. If any remedy provided is determined to have failed for its essential purpose, all limitations of liability and exclusions of damages set forth in the Limited Warranty shall remain in effect. - -DEVEXPRESS reserves all rights not specifically granted in this EULA. - -Developer End User acknowledges that he or she has read this Agreement, understands it, and agrees to be bound by its terms and conditions. - -All trademarks and registered trademarks are property of their respective owners. - -Should you have any questions concerning this EULA, contact us directly in the United States at +1 (818) 844-3383, or write: Developer Express Inc. Legal department / 330 N. Brand Blvd Suite 370, Glendale, CA 91203. \ No newline at end of file diff --git a/README.md b/README.md index 5f0a5cde18..9f13c62991 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,137 @@ # 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 also uses [DocFX](https://dotnet.github.io/docfx/) to convert this file from a set of topics 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; +- change screenshots to match your app's UI; +- specify logo and site titles: [Template Metadata](https://dotnet.github.io/docfx/docs/template.html?q=breadcrumbs&tabs=modern#template-metadata); +- 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. + +## 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 sample pre-built 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 +> - Install [.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: +Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. - ``` - set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin - ``` +Do not use the `master` branch because it is the version currently under development: -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 for publishing to any static site hosting servers. Deploy the created documentation to a web server or browse the documentation directly from local file system. To begin, you can 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 near *toc.yml* 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. + +#### 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 + } + } + } +} +``` + +#### 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 +141,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..1cdf0d1c1e 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 four target platforms: #### 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 From ad9435924e031da3c62a2d41ad841efa04758710 Mon Sep 17 00:00:00 2001 From: Natalia Kazakova <17986517+natakazakova@users.noreply.github.com> Date: Tue, 24 Sep 2024 20:00:25 +0400 Subject: [PATCH 2/8] Update README.md --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9f13c62991..cb1788c674 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,15 @@ If you search for **Developer Documentation with API Reference**, refer to [docs ## 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 also uses [DocFX](https://dotnet.github.io/docfx/) to convert this file from a set of topics to an HTML website or a PDF file. +The repository uses [DocFX](https://dotnet.github.io/docfx/) to convert these files from a set of markdown topics 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; -- change screenshots to match your app's UI; -- specify logo and site titles: [Template Metadata](https://dotnet.github.io/docfx/docs/template.html?q=breadcrumbs&tabs=modern#template-metadata); -- 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. +- 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: From e335994dee1cf31f4638452984eb7dc1cb1a952d Mon Sep 17 00:00:00 2001 From: Sergey Avramenko Date: Wed, 25 Sep 2024 09:47:36 +0300 Subject: [PATCH 3/8] fix matomo updated partial for 'default', added layout for modern, fix parameters to pass metadata --- .../workflows/build-eud-on-pull-request.yml | 2 +- .github/workflows/update-gh-pages-branch.yml | 2 +- .template/layout/_master.tmpl | 169 ++++++++++++++++++ .template/partials/head.tmpl.partial | 64 ++++--- 4 files changed, 210 insertions(+), 27 deletions(-) create mode 100644 .template/layout/_master.tmpl diff --git a/.github/workflows/build-eud-on-pull-request.yml b/.github/workflows/build-eud-on-pull-request.yml index 6597c73d9c..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 \ No newline at end of file + 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 95b69099a1..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 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}} + +
+
+
+ {{{_appFooter}}}{{^_appFooter}}Made with docfx{{/_appFooter}} +
+
+
+ + {{/redirect_url}} + diff --git a/.template/partials/head.tmpl.partial b/.template/partials/head.tmpl.partial index 32fd1648ea..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}} - \ No newline at end of file + {{/_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}} + From 75a422e7461f8af736d3065910373d922d687bca Mon Sep 17 00:00:00 2001 From: Natalia Kazakova <17986517+natakazakova@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:17:36 +0400 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: pollyndos <56310766+pollyndos@users.noreply.github.com> --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cb1788c674..58ec057767 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ If you search for **Developer Documentation with API Reference**, refer to [docs ## 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 these files from a set of markdown topics to an HTML website or a PDF file. +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: @@ -26,7 +26,7 @@ You can make the following changes to the documentation, or skip this step if yo Do one of the following to view the End-User Documentation content: 1. Browse this repository's content directly: [index.md](index.md) -1. View the sample pre-built website: [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/) +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) @@ -34,7 +34,7 @@ Do one of the following to view the End-User Documentation content: > Prerequisites > - Familiarity with the command line -> - Install [.NET SDK](https://dotnet.microsoft.com/en-us/download) 6.0 or higher +> - [.NET SDK](https://dotnet.microsoft.com/en-us/download) 6.0 or higher > - [Git](https://git-scm.com/) 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: @@ -61,20 +61,20 @@ To preview changes, open a console window and call the `docfx build` command wit ```bash docfx build D:/dotnet-eud/docfx.json --serve ``` -Docfx produces static HTML files under the _site folder ready for publishing to any static site hosting servers. Deploy the created documentation to a web server or browse the documentation directly from local file system. To begin, you can refer to the DocFX documentation: [Publish to GitHub Pages](https://dotnet.github.io/docfx/index.html#publish-to-github-pages). +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 near *toc.yml* in the *_site* folder. +The resulted PDF file will be located next to the *toc.yml* file in the *_site* folder. -#### Build locally +#### Build Locally Open the console and call `docfx pdf D:\test-eud\docfx.json`. You need a succeeded build before you proceed. -#### docfx.json +#### Use docfx.json Include the `pdf` command to _docfx.json_. @@ -102,7 +102,7 @@ You can generate PDF only for a specific _toc.yml_: } ``` -#### toc.yml +#### Use toc.yml Include the `pdf` command to _toc.yml_ to generate PDF according to this table of content: From ad39a2198b6c54d8ef1636b99024e93467724c2f Mon Sep 17 00:00:00 2001 From: Natalia Kazakova Date: Wed, 25 Sep 2024 12:19:07 +0200 Subject: [PATCH 5/8] add gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..934def21e6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +_site +*.pdf \ No newline at end of file From 57b179dae41c5497444b4dc2db4e715d906b1562 Mon Sep 17 00:00:00 2001 From: Natalia Kazakova Date: Wed, 25 Sep 2024 12:35:58 +0200 Subject: [PATCH 6/8] add license --- LICENSE.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000000..4c4c701422 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,87 @@ +DEVELOPER EXPRESS INC +DEVEXPRESS Components/Tools End-User Help Documentation +Copyright (C) 2000-2024 Developer Express Inc. + +END-USER LICENSE AGREEMENT + +IMPORTANT- READ CAREFULLY: This DEVELOPER EXPRESS INC ("DEVEXPRESS") End-User License Agreement ("EULA" or "AGREEMENT") is a legal agreement between you, a developer of software applications, ("Developer End User") and DEVEXPRESS for DEVEXPRESS Components/Tools End-User Help Documentation ("SOFTWARE DOCUMENTATION") contained in this file. + +DEVEXPRESS grants to you as an individual, a personal, nonexclusive license to install and use the SOFTWARE DOCUMENTATION for your specific business requirements. By installing, copying, or otherwise using the SOFTWARE DOCUMENTATION, you agree to be bound by the terms of this EULA. If you do not agree to any part of the terms of this EULA, DO NOT INSTALL, USE, OR EVALUATE, ANY PART, FILE OR PORTION OF THE SOFTWARE DOCUMENTATION. + +This AGREEMENT is the entire agreement between DEVEXPRESS and LICENSEE concerning its subject matter (including the license, access, and use of the SOFTWARE DOCUMENTATION, and supersedes all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning its subject matter. The parties agree that any term or condition stated in a LICENSEE quote, bid, purchase order, or in any other LICENSEE terms or order documentation (collectively “LICENSEE DOCUMENTATION”) is void. In the event of any conflict or inconsistency between the terms of this AGREEMENT and any LICENSEE DOCUMENTATION, the terms of this AGREEMENT shall prevail. + +All SOFTWARE DOCUMENTATION is licensed, not sold. + +1. GRANT OF LICENSE. + +Only licensed DEVEXPRESS customers may install and use the SOFTWARE DOCUMENTATION. If you have not purchased a license for a DEVEXPRESS PRODUCT, you are prohibited from installing, copying, or otherwise using this SOFTWARE DOCUMENTATION. + +Developer End User may install and use the SOFTWARE DOCUMENTATION on a single computer. Developer End User may also install and use the SOFTWARE DOCUMENTATION on a portable computer. + +2. LIMITATIONS ON MODIFICATIONS TO SOFTWARE DOCUMENTATION. + +This SOFTWARE DOCUMENTATION can be modified by licensed Developer End Users to meet specific business needs or requirements of Developer End User. + +3. SEPARATION OF COMPONENTS. + +The SOFTWARE DOCUMENTATION is licensed as a single product. The SOFTWARE DOCUMENTATION and its constituent parts may be separated by Developer End User to meet specific business needs or requirements of Developer End User. + +4. RENTAL. + +You may not rent, lease, or lend the SOFTWARE DOCUMENTATION. + +5. TRANSFER. + +You may NOT permanently or temporarily transfer ANY of your rights under this EULA to any individual or entity without prior written approval from DEVEXPRESS. Only you as the licensed Developer End User have the right to use the SOFTWARE DOCUMENTATION (or any portions thereof). + +6. REDISTRIBUTION. + +Licensed Developer End Users are authorized to redistribute SOFTWARE DOCUMENTATION with applications and or business solution they have developed that use DEVEXPRESS PRODUCTS. + +AT NO TIME MAY DEVELOPER END USER CREATE ANY TOOL, REDISTRIBUTABLE, OR SOFTWARE PRODUCT(S) THAT DIRECTLY OR INDIRECTLY COMPETES WITH DEVEXPRESS SOFTWARE PRODUCT(S) WHICH UTILIZES ALL OR ANY PORTION OF THE SOFTWARE DOCUMENTATION contained within this installation. + +7. COPYRIGHT. + +All title and copyrights in and to the SOFTWARE DOCUMENTATION contained in this installation are owned by DEVEXPRESS or its subsidiaries. The SOFTWARE DOCUMENTATION is protected by copyright laws and international treaty provisions and therefore, you must treat the SOFTWARE DOCUMENTATION like any other copyrighted material except that you may install and use the SOFTWARE DOCUMENTATION as described in this EULA. + +8. U.S. GOVERNMENT RESTRICTED RIGHTS. + +The Licensed Software is Commercial Computer Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFAR 255.227-7013 et. seq. or 252.211-7015, or subparagraphs (a) through (d) of the Commercial Computer Software Restricted Rights at FAR 52.227-19, as applicable, or similar clauses in the NASA FAR Supplement. Contractor-manufacturer is Developer Express Inc. / 330 N. Brand Blvd Suite 370, Glendale, CA 91203. + +9. EXPORT RESTRICTIONS. + +DEVEXPRESS expressly complies with all export restrictions imposed by the government of the United States of America. You, as LICENSEE, must agree not to export or re-export the SOFTWARE DEVELOPMENT PRODUCT(S) within any created application to any country, person, entity or end user subject to U.S.A. export restrictions. Restricted countries currently include, but are not necessarily limited to Cuba, Iran, North Korea, Sudan, Syria, and Venezuela. You warrant and represent that neither the U.S.A. Bureau of Export Administration nor any other federal agency has suspended, revoked or denied your export privileges. + +10. DISCLAIMER OF WARRANTY. + +DEVEXPRESS expressly disclaims any warranty for the SOFTWARE DOCUMENTATION. THE SOFTWARE DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. DEVEXPRESS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE, OR THE RESULTS OF THE USE, OF THE SOFTWARE DOCUMENTATION IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, OR OTHERWISE. THE ENTIRE RISK ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE DOCUMENTATION REMAINS WITH YOU. No oral or written information or advice given by DEVEXPRESS or its employees shall create a warranty or in any way increase the scope of this warranty. + +11. LIMITATIONS ON LIABILITY. + +To the maximum extent permitted by applicable law, in no event shall DEVEXPRESS be liable for any special, incidental, indirect, or consequential damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use the SOFTWARE DOCUMENTATION or the provision of or failure to provide Support Services, even if DEVEXPRESS has been advised of the possibility of such damages. + +Developer End User understands that the SOFTWARE DOCUMENTATION may lead to inaccurate results because of a failure or fault within the SOFTWARE PRODUCT(S) or failure by Developer End User to properly use and or deploy the SOFTWARE PRODUCT(S). Developer End User assumes full and sole responsibility for any use of the SOFTWARE DOCUMENTATION, and bears the entire risk for failures or faults within the SOFTWARE PRODUCT(S). You agree that regardless of the cause of failure or fault or the form of any claim, YOUR SOLE REMEDY AND DEVEXPRESS'S SOLE OBLIGATION SHALL BE GOVERNED BY THIS AGREEMENT AND IN NO EVENT SHALL DEVEXPRESS'S LIABILITY EXCEED THE PRICE PAID TO DEVEXPRESS FOR THE SOFTWARE DOCUMENTATION. This Limited Warranty is void if failure of the SOFTWARE PRODUCT(S) has resulted from accident, abuse, alteration, unauthorized use or misapplication of the SOFTWARE PRODUCT(S). + +12. INDEMNIFICATION. + +You hereby agree to indemnify DEVEXPRESS and its officers, directors, employees, agents, and representatives from each and every demand, claim, loss, liability, or damage of any kind, including actual attorneys fees, whether in tort or contract, that it or any of them may incur by reason of, or arising out of, any claim which is made by any third party with respect to any breach or violation of this Agreement by you or any claims based on the Applications and the SOFTWARE DOCUMENTATION included herein. + +13. TERMINATION. + +Without prejudice to any other rights or remedies, DEVEXPRESS will terminate this EULA upon your failure to comply with all the terms and conditions of this EULA. In such events, you must destroy all copies of the SOFTWARE DOCUMENTATION and all of its component parts. + +14. MISCELLANEOUS. + +This EULA shall be construed, interpreted and governed by the laws of the State of Nevada, U.S.A. This EULA gives you specific legal rights; you may have others that vary from state to state and from country to country. + +This AGREEMENT may only be modified in writing signed by you and an authorized officer of Developer Express Inc. This AGREEMENT is the entire agreement between DEVEXPRESS and LICENSEE concerning its subject matter (including the license, access, and use of the SOFTWARE DEVELOPMENT PRODUCT(S), and supersedes all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning its subject matter. The parties agree that any term or condition stated in a LICENSEE quote, bid, purchase order, or in any other LICENSEE terms or order documentation (collectively “LICENSEE DOCUMENTATION”) is void. In the event of any conflict or inconsistency between the terms of this AGREEMENT and any LICENSEE DOCUMENTATION, the terms of this AGREEMENT shall prevail. + +If any provision of this AGREEMENT is found void or unenforceable, the remainder will remain valid and enforceable according to its terms. If any remedy provided is determined to have failed for its essential purpose, all limitations of liability and exclusions of damages set forth in the Limited Warranty shall remain in effect. + +DEVEXPRESS reserves all rights not specifically granted in this EULA. + +Developer End User acknowledges that he or she has read this Agreement, understands it, and agrees to be bound by its terms and conditions. + +All trademarks and registered trademarks are property of their respective owners. + +Should you have any questions concerning this EULA, contact us directly in the United States at +1 (818) 844-3383, or write: Developer Express Inc. Legal department / 330 N. Brand Blvd Suite 370, Glendale, CA 91203. \ No newline at end of file From bf088010392e8eec11843dafae83a388dafd6ed6 Mon Sep 17 00:00:00 2001 From: Natalia Kazakova Date: Wed, 25 Sep 2024 12:36:12 +0200 Subject: [PATCH 7/8] fix word order --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index 1cdf0d1c1e..a1590bd8f4 100644 --- a/index.md +++ b/index.md @@ -14,7 +14,7 @@ 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. -The end user documentation is divided into four target platforms: +The end user documentation is divided into the following platforms and products: #### Web (ASP.NET): From d1fe7df0a6d78dbc8c95e5705bf6283fe2b89937 Mon Sep 17 00:00:00 2001 From: Natalia Kazakova Date: Wed, 25 Sep 2024 12:36:49 +0200 Subject: [PATCH 8/8] move note --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58ec057767..0ff098ca29 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,10 @@ dotnet tool update -g docfx > You can also download the latest version of DocFX directly: [releases](https://github.com/dotnet/docfx/releases). -Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. +> [!Warning] +> Do not use the `master` branch because it is the version currently under development. -Do not use the `master` branch because it is the version currently under development: +Copy the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. ``` git clone https://github.com/DevExpress/dotnet-eud