Skip to content

Rewrite Readme. Review and improve code examples. #3

Closed
NickVolynkin wants to merge 6 commits intoDevExpress-Examples:25.2.3+from
NickVolynkin:volynkin-restructure-readme
Closed

Rewrite Readme. Review and improve code examples. #3
NickVolynkin wants to merge 6 commits intoDevExpress-Examples:25.2.3+from
NickVolynkin:volynkin-restructure-readme

Conversation

@NickVolynkin
Copy link
Contributor

@NickVolynkin NickVolynkin commented Jan 26, 2026

readme: Explain example purpose and restructure

  • Explain the localization mechanism in more detail.
  • Provide screenshots of localized Report Designer and Report viewer.

Readme preview: https://github.com/NickVolynkin/vcl-reports-localize/blob/volynkin-restructure-readme/README.md

delphi/cpp-builder: Focus the example on DevExpress Reports localization

  • Add an empty example report to ensure both dialogs can load.
  • Switch languages using TcxRadioButtons.
    TcxRadioButtons better represent application state than simple buttons.
  • Use the German localization language when application starts.
    Check the "German" radiobutton to reflect the default localization.
  • Group "Display Report" buttons into a labeled group, change captions.
    Move focus to "Display Report Designer" button when application starts.
  • Forbid to resize the application form.
  • Give the application a relevant title.
  • Use a DevExpress application icon.
  • Remove the Data Grid table.
    In this example, data structure is not in the focus of demonstration.
    Data Grid table draws attention from the localization examples.
  • Rename several interface components and code members according to
    DevExpress style.
  • Comment significant actions in the code example.

@NickVolynkin NickVolynkin self-assigned this Jan 26, 2026
@NickVolynkin NickVolynkin marked this pull request as draft January 26, 2026 09:33
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 3 times, most recently from 6f0837d to 5c9b344 Compare January 26, 2026 13:59
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 2 times, most recently from 23b7b40 to c63aeec Compare January 26, 2026 16:26
@NickVolynkin NickVolynkin marked this pull request as ready for review January 26, 2026 16:29
@NickVolynkin NickVolynkin changed the title [WIP] Review and improve the example Review and improve the example Jan 26, 2026
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 8 times, most recently from 7d8af38 to f720665 Compare January 26, 2026 18:13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Localize Report Dialogs in" - In this case I would use the same preposition as for the word "translate". So you translate or localize "to" a language/locale. But I think we can also have a simpler version. Here's my version:

"Report Dialog Language (Locale):"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I wanted to highlight the action of localizing, which is why I used a verb. However, unlike regular buttons, radio buttons show a continuing state. Reports stay localized in German as long as the corresponding radio button is checked. So, it makes sense to use nouns, as in your suggestion.

Comment about the preposition is valid, thanks.

@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 2 times, most recently from 84174e2 to 2c2bb4e Compare January 27, 2026 08:41
@NickVolynkin NickVolynkin changed the title Review and improve the example Review and improve the Delphi example Jan 27, 2026
@NickVolynkin NickVolynkin changed the title Review and improve the Delphi example Review and improve the Delphi example. Restructure readme. Jan 27, 2026
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 5 times, most recently from 9afff29 to 1fcc862 Compare January 27, 2026 18:28
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 3 times, most recently from 141736a to 86c6f67 Compare January 28, 2026 18:53
- Add an empty example report to ensure both dialogs can load.
- Switch languages using TcxRadioButtons.
  TcxRadioButtons better represent application state than simple buttons.
- Use the German localization language when application starts.
  Check the "German" radiobutton to reflect the default localization.
- Group "Display Report" buttons into a labeled group, change captions.
  Move focus to "Display Report Designer" button when application starts.
- Forbid to resize the application form.
- Give the application a relevant title.
- Use a DevExpress application icon.
- Remove the Data Grid table.
  In this example, data structure is not in the focus of demonstration.
  Data Grid table draws attention from the localization examples.
- Rename several interface components and code members according to
  DevExpress style.
- Comment significant actions in the code example.

Signed-off-by: Nick Volynkin <nikolay.volynkin@devexpress.com>
Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 6 times, most recently from 10050e6 to 9876597 Compare January 29, 2026 16:36
- Add an empty example report to ensure both dialogs can load.
- Switch languages using TcxRadioButtons.
  TcxRadioButtons better represent application state than simple buttons.
- Use the German localization language when application starts.
  Check the "German" radiobutton to reflect the default localization.
- Group "Display Report" buttons into a labeled group, change captions.
  Move focus to "Display Report Designer" button when application starts.
- Forbid to resize the application form.
- Give the application a relevant title.
- Use a DevExpress application icon.
- Remove the Data Grid table.
  In this example, data structure is not in the focus of demonstration.
  Data Grid table draws attention from the localization examples.
- Rename several interface components and code members according to
  DevExpress style.
- Comment significant actions in the code example.

Signed-off-by: Nick Volynkin <nikolay.volynkin@devexpress.com>
Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 2 times, most recently from f25972c to 17ea157 Compare January 30, 2026 08:38
@NickVolynkin NickVolynkin changed the title Review and improve the Delphi example. Restructure readme. Rewrite Readme. Review and improve code examples. Jan 30, 2026
NickVolynkin and others added 2 commits February 6, 2026 19:07
- Explain the localization mechanism in more detail.
- Add screenshots of localized Report Designer and Report viewer.
- Add links to documentation
- Give an overview of files with relevant code

Signed-off-by: Nick Volynkin <nikolay.volynkin@devexpress.com>

Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
Co-authored-by: Dmitry Eliseev <dmitry.eliseev@devexpress.com>
Co-authored-by: Albert Totten <49917542+albertov05@users.noreply.github.com>
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch 3 times, most recently from 7e56d50 to 5b29891 Compare February 6, 2026 17:17
@NickVolynkin NickVolynkin force-pushed the volynkin-restructure-readme branch from 5b29891 to 8c4f4bf Compare February 16, 2026 08:59
@NickVolynkin
Copy link
Contributor Author

Reopened from a local (non-fork) branch in #4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants