readme: draft

Author: NickVolynkin

README.md

@@ -4,30 +4,103 @@
 [![](https://img.shields.io/badge/📖_How_to_use_DevExpress_Examples-e9f6fc?style=flat-square)](https://docs.devexpress.com/GeneralInformation/403183)
 [![](https://img.shields.io/badge/💬_Leave_Feedback-feecdd?style=flat-square)](#does-this-example-address-your-development-requirementsobjectives)
 <!-- default badges end -->
-# DevExpress VCL Reports - Store Report Layouts in a Database
 
-This example stores a [report layout](https://docs.devexpress.com/VCL/dxReport.TdxReport.Layout) (XML-based template) in the BLOB field of a memory-based dataset ([TdxMemData](https://docs.devexpress.com/VCL/dxmdaset.TdxMemData) inherited from the [TDataSet](https://docwiki.embarcadero.com/Libraries/Athens/en/Data.DB.TDataSet) class shipped with the standard VCL library).
+# DevExpress Reports for Delphi/C++Builder – Store Report Layouts in a Database
 
-## Testing the example
+This example application stores [DevExpress report layouts][TdxReport.Layout] in a database.
+The application allows users to create and save report layouts, modify existing layouts, and open layouts in Report Designer/Viewer.
+
+
+## Prerequisites
+
+[DevExpress Reports Prerequisites][req]
+
+[req]: https://docs.devexpress.com/VCL/405773/ExpressCrossPlatformLibrary/vcl-backend/reports-dashboards-app-deployment#vcl-reportsdashboards-prerequisites
+
+
+## Implementation Details
+
+This example stores report layouts in the BLOB field of a memory-based dataset
+([TdxMemData] from the DevExpress library, inherited from [TDataSet], shipped with the standard VCL library).
+Follow the steps below to store report layouts in a database of your choice, using the corresponding `TDataSet` descendant.
+
+### Step 1: Implement a Data Module
+
+### Step 2: Supply Layout Data to TdxReport
+
+### Step 3: Display Report Designer and Viewer
+
+### Step 4: Handle Layout Changes
+
+## Test the Example
+
+-   Run the sample app and click **New Report** to create an empty database record.
+-   Click **Show Designer** to display the [Report Designer][dx-report-designer] dialog.
+-   Create a report layout using tools available within the UI.
+-   Click the hamburger button, select the **Save** option, and close the dialog.
+-   Close the app. The [TdxMemData] component will store layout data in the [data.dat] file between sessions.
+-   Run the sample app again. Click **View Designer** to load the saved report layout,
+    or **View Report** to preview a layout-based report in the [Report Viewer][dx-report-viewer] dialog.
+
+
+## Files to Review
+
+-   [uData.pas] (Delphi) and [uData.cpp] (C++Builder) read and store layout data in a database represented by an in-memory storage component.
+-   [data.dat] stores layout data between application sessions.
+-   [uMainForm.pas] (Delphi) and [uMainForm.cpp] (C++Builder) supply layout data from the data module to [TdxReport.Layout] and display Report Designer and Viewer.
+-   [nwind.db] contains the Northwind sample database used as a data source for report content.
+
+[uData.pas]: ./Delphi/uData.pas
+[uData.cpp]: ./CPB/uData.cpp
+[data.dat]: ./Delphi/data.dat
+[uMainForm.pas]: ./Delphi/uMainForm.pas
+[uMainForm.cpp]: ./CPB/uMainForm.cpp
+[nwind.db]: ./Delphi/nwind.db
 
-* Run the sample app and click **New Report** to create an empty database record.
-* Click **Show Designer** to display the [Report Designer](https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer) dialog.
-* Create a report layout using tools available within the UI.
-* Click the hamburger button, select the **Save** option, and close the dialog.
-* Close the app. The [TdxMemData](https://docs.devexpress.com/VCL/dxmdaset.TdxMemData) component will store layout data between sessions.
-* Run the sample app again. Click **View Designer** to load the saved report layout, or **View Report** to preview a layout-based report in the [Report Viewer](https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer) dialog.
 
 ## Documentation
 
-* [TdxReport.Layout Property](https://docs.devexpress.com/VCL/dxReport.TdxReport.Layout)
-* [TdxBackendDataSetJSONConnection Component](https://docs.devexpress.com/VCL/dxBackend.ConnectionString.JSON.DataSet.TdxBackendDataSetJSONConnection)
+-   [Introduction to VCL Reports][reports-intro]
+-   [Tutorial: Create a table report using the Report Wizard][report-wizard]
+-   [Use SQLite as a data source for reports (as demonstrated in the current example)][sqlite-data-source]
+-   [Store report layouts in REPX files at design-time][reports-design-time-store]
+-   API reference:
+    -   [TdxReport.Layout] (an XML-based layout template that can be stored in the BLOB field of a database)
+    -   [TdxMemData] (used to store report layout data in application runtime and between sessions)
+    -   [TDataSet] (ancestor of the `TdxMemData`, contains generic database connection methods)
+    -   [TdxBackendDatabaseSQLConnection] (used to supply data to reports)
+
+<!-- documentation links -->
+[reports-intro]: https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports
+[report-wizard]: https://docs.devexpress.com/VCL/405760/ExpressReports/getting-started/create-table-report-using-report-wizard
+[sqlite-data-source]: https://docs.devexpress.com/VCL/405750/ExpressCrossPlatformLibrary/vcl-backend/database-engines/vcl-backend-sqlite-support
+[reports-design-time-store]: https://docs.devexpress.com/VCL/dxReport.TdxReport.Layout#string-list-editor
+[dx-report-viewer]: https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer
+[dx-report-designer]: https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer
+
+
+<!-- reference links -->
+[TdxReport.Layout]: https://docs.devexpress.com/VCL/dxReport.TdxReport.Layout
+[TdxBackendDatabaseSQLConnection]: https://docs.devexpress.com/VCL/dxBackend.ConnectionString.SQL.TdxBackendDatabaseSQLConnection
+[TdxBackendDataSetJSONConnection]: https://docs.devexpress.com/VCL/dxBackend.ConnectionString.JSON.DataSet.TdxBackendDataSetJSONConnection
+[TdxMemData]: https://docs.devexpress.com/VCL/dxmdaset.TdxMemData
+[TDataSet]: https://docwiki.embarcadero.com/Libraries/Athens/en/Data.DB.TDataSet
+
+<!-- external documentation links -->
+<!-- in-repository links -->
+
+
+## More Examples
+
+-   [Store report layouts in REPX files][file-example]
+
+[file-example]: https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file
+
+
 <!-- feedback -->
 ## Does This Example Address Your Development Requirements/Objectives?
 
 [<img src="https://www.devexpress.com/support/examples/i/yes-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=vcl-reports-store-layout-template-database&~~~was_helpful=yes) [<img src="https://www.devexpress.com/support/examples/i/no-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=vcl-reports-store-layout-template-database&~~~was_helpful=no)
 
 (you will be redirected to DevExpress.com to submit your response)
 <!-- feedback end -->
-
-
-