You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This **End-User Documentation** targets application end-users and explains how to use UI elements implemented by DevExpress. This information helps software developers create their own help files for projects that incorporate DevExpress technologies.
3
+
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. It also provides links to a sample pre-built website and PDF files.
4
4
5
+
6
+
> If you require End-User documentation for **v17.1 and earlier**, you can download previous versions in CHM and PDF formats from https://www.devexpress.com/Support/Documentation/download.xml?platform=user-dev-docs.
7
+
>
5
8
> For **Developer Documentation with API Reference** see [https://documentation.devexpress.com](https://www.devexpress.com/Support/Documentation/).
6
9
7
10
## The Scope
8
11
DevExpress products for WinForms, WPF and ASP.NET WebForms/MVC.
9
12
10
13
## Licensing
11
-
By accessing this repository, you agree to be bound by the terms of the [DevExpress End-User Documentation License Agreement](LICENSE.md).
14
+
By accessing this repository, you agree to the terms of the [DevExpress End-User Documentation License Agreement](LICENSE.md).
12
15
13
-
## Two Ways to Browse Content
14
-
To browse this repository's content, start with [index.md](index.md).
16
+
## How to View Content
17
+
Do one of the following to view the End-User Documentation content:
15
18
16
-
We have also compiled this End-User Documentation into a sample website available at [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/).
19
+
1. Browse this repository's content directly. Start with [index.md](index.md).
20
+
2. View the sample pre-built website at [devexpress.github.io/dotnet-eud](https://devexpress.github.io/dotnet-eud/).
Documents in this repository are written in markdown. One way to use them is to manually copy required information to your own help file.
28
+
Documents in this repository are written in markdown. You can manually copy the information to your own help file.
20
29
21
-
The repository also includes a [docfx.json](docfx.json) file, which enables you to convert a set of topics to an HTML website or a PDF file using [DocFX](https://dotnet.github.io/docfx/) and [wkhtmltopdf](https://github.com/wkhtmltopdf/wkhtmltopdf).
30
+
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.
22
31
23
32
## Build an HTML Website
24
-
To create a documentation website for your application:
33
+
Follow the steps below to create a documentation website for your application.
25
34
26
35
- Download and install the [latest version of DocFX](https://github.com/dotnet/docfx/releases).
27
-
-Clone the repository to your computer and checkout the branch corresponding to the version of DevExpress controls your application uses. Make sure not to use the **master** branch, which represents the version currently under development.
36
+
-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.
If you do not have [Git](https://git-scm.com/) installed, select the required branch using the GitHub web interface and then download and extract the ZIP archive.
40
+
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.
- If you want to reuse the end-user documentation as is, skip this step. Otherwise, make changes as required, which may include:
35
-
- removing files that are not needed in your documentation;
36
-
- adding new documents specific to your application;
37
-
- changing screenshots to match your app UI;
38
-
- creating a [custom DocFX template](https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html).
39
-
> Make sure to update *toc.yml* ([table-of-content](https://dotnet.github.io/docfx/tutorial/intro_toc.html)) files if you have added or removed topics.
40
-
- Open a console window, change the current directory to the repository root folder and call the DocFX executable with the *build* and *docfx.json* parameters. 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.
43
+
- You can make the following changes to the documentation, or skip this step if you want to reuse the end-user documentation as is:
44
+
- remove unnecessary files;
45
+
- add new documents to your application;
46
+
- change screenshots to match your app's UI;
47
+
- create a [custom DocFX template](https://dotnet.github.io/docfx/tutorial/howto_create_custom_template.html).
48
+
> 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.
49
+
- Open a console window, change the current directory to the repository root folder and call the DocFX executable with the *build* and *docfx.json* parameters. 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.
41
50
```
42
51
docfx.exe build docfx.json --serve
43
52
```
44
53
- Finally, 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.
45
54
46
55
## Build Printer-Friendly PDF Files
47
-
If your end-users require a printed version, you can create a PDF file:
56
+
If your endusers require a printed version, you can create a PDF file:
48
57
- Ensure that you can successfully build a website with DocFX (see the [previous section](#build-your-own-documentation-website)).
49
58
- Download and install [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html).
50
59
- Open a console window and add the **wkhtmltopdf** executable path to the %PATH% environment variable:
51
60
```
52
61
set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin
53
62
```
54
-
- Change the current directory to the repository root folder and call the DocFX executable with the *pdf* and *docfx.json* parameters. This will generate a *_pdf* subfоlder with a PDF file for each included table-of-contents file.
63
+
- Change the current directory to the repository root folder and call the DocFX executable with the *pdf* and *docfx.json* parameters. This generates a *_pdf* subfоlder with a PDF file for each included table-of-contents file.
55
64
```
56
65
docfx.exe pdf docfx.json
57
66
```
58
67
59
68
## Troubleshooting
60
-
Below are the common issues you may face when building this repository's documentation.
69
+
Below are the common issues you can face when building this repository's documentation.
61
70
62
71
* #### The build process fails with the *System.IO.PathTooLongException* exception
63
72
Reduce your working directory's full path (move the repository closer to a drive root).
@@ -74,11 +83,8 @@ Below are the common issues you may face when building this repository's documen
74
83
```
75
84
docfx.exe build docfx.json --template statictoc
76
85
```
77
-
The table of contents is embedded into each topic with this template which increases the build time and HTML file sizes. Alternatively, you can override the browser's restrictions (which may be insecure). For example, Google Chrome and Microsoft Edge accept the `--allow-file-access-from-files` command line switch which allows loading local files.
86
+
The table of contents is embedded into each topic with this template which increases the build time and HTML file sizes. Alternatively, you can override the browser's restrictions (which may be unsecure). For example, Google Chrome and Microsoft Edge accept the `--allow-file-access-from-files` command line switch which allows loading local files.
78
87
79
-
> We recommend using the `--serve` DocFX switch to preview documentation, and then share it with end users via a web server, instead of browsing the file system
80
-
81
-
If your issue is not listed, do not hesitate to [submit a new issue to this repository](https://github.com/DevExpress/dotnet-eud/issues/new) or contact us using 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.
88
+
> We recommend using the `--serve` DocFX switch to preview documentation, and then share it with end users via a web server instead of browsing the file system.
82
89
83
-
## Obtain End-User Documentation for Versions Prior to 17.1
84
-
This repository provides help files for DevExpress versions 17.1 and above. End-user documentation for previous versions is published in CHM and PDF formats at https://www.devexpress.com/Support/Documentation/download.xml?platform=user-dev-docs.
90
+
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.
0 commit comments