Dess wrd templates #1870
Dess wrd templates #1870
Conversation
dessyordanova
requested review from
elkinmilen,
kachamachkov,
mzanev and
yordan-mitev
|
To all reviewers: Do we need a workflow diagram explaining the process for editing an existing template, considering the fact we have a dedicated tutorial how to do it? |
| ## How Templates Work in Web Report Designer | ||
|
|
||
| When creating a new report, instead of beginning with a **Blank Report**, you can start with a .trtx **Template** file. | ||
| When creating a new report, instead of beginning from scratch with a **Blank Report**, you can start with a .trtx **Template** file. |
There was a problem hiding this comment.
Consider changing the sentence to something like that: "Instead of starting from scratch with a blank report, you can save time by using a template (.trtx) file. It gives you a ready-made layout and structure to build on, making report creation faster and more consistent."
There was a problem hiding this comment.
About the title, I think that "Getting Started with Templates in Web Report Designer" is more suitable, since its a step-by-step guide, not exactly an explanation of how they work.
|
|
||
| ## Why Use Report Templates? | ||
|
|
||
| * **Save Time**: Templates provide a ready-made layout and structure, so you can focus on your data and content rather than design. |
There was a problem hiding this comment.
Consider: Templates offer a ready-made layout and structure, so you can focus on your data instead of design.
|
|
||
| * **Save Time**: Templates provide a ready-made layout and structure, so you can focus on your data and content rather than design. | ||
|
|
||
| * **Ensure Consistency**: Using templates helps maintain a uniform look and feel across multiple reports - especially useful for teams or organizations. |
There was a problem hiding this comment.
I feel like "using templates" is redundant here, the title is "Why Use" already. I suggest: "Maintain a uniform look and feel across reports—especially helpful for teams and organizations."
|
|
||
| * **Simplify Design for Non-Designers**: Even if you're not familiar with styling or layout best practices, templates give you a polished starting point. | ||
|
|
||
| * **Customize and Reuse**: You can modify a template to suit your needs and reuse it across different projects or departments. |
There was a problem hiding this comment.
I suggest: "Easily adapt templates to fit different projects or departments, and reuse them to stay efficient."
|
|
||
| * **Customize and Reuse**: You can modify a template to suit your needs and reuse it across different projects or departments. | ||
|
|
||
| * **Standardize Branding**: Templates can include your company’s logo, colors, fonts, and layout preferences - ensuring every report aligns with your brand. |
There was a problem hiding this comment.
Maybe change title to: "Support Branding" ? Additionally, I think that Templates here is also redundant, due to the title, maybe: "Include your company’s logo, colors, and fonts to ensure every report aligns with your brand identity."
|
|
||
|  | ||
|
|
||
| 1. Enter `File Name` and `Format`: Once the template is selected, enter an appropriate name for the report you are creating from the template and choose the `Format`: |
There was a problem hiding this comment.
Consider: "After selecting a template, give your new report a meaningful name and choose the desired output format."
|
|
||
| ### Creating Your Own Templates | ||
|
|
||
| You can design a report in the Web Report Designer and save it as a template. This allows you or your team to reuse it for future reports. When you wish to save the currenty opened report, select the `Save As...` option from the Menu: |
There was a problem hiding this comment.
There is a typo here, currenty instead of currently
|
|
||
|  | ||
|
|
||
| The end-user is presneted the option to save the report either as a `Report` (.trdp or .trdx file format), or as a `Template` (.trtx file format): |
There was a problem hiding this comment.
there is a typo here presneted instead of presented.
| })); | ||
| ```` | ||
|
|
||
| Once the end-user is not granted permissions for the Report Templates, the following actions are available: |
There was a problem hiding this comment.
Consider: Limited Access to Report Templates: If the end-user does not have permission to access report templates, the following actions will still be available:
|
|
||
| Once the end-user is not granted permissions for the Report Templates, the following actions are available: | ||
|
|
||
| * Create a New Report from a Template - The **From Template** option is still *visible* but *restricted*. The restricted user is not allowed to create new or upload templates, delete or edit any existing templates. However, consuming the already existing templates is allowed. |
There was a problem hiding this comment.
Consider bullets for cleaner look, maybe:
The From Template option remains visible even when the user lacks permissions to manage templates. In this restricted mode:
- Users cannot create or upload new templates.
- Users cannot delete or edit existing templates.
- Users can still create new reports using the available templates.
| |----|----| | ||
| ||| | ||
|
|
||
| * **Assets manager** - When a *restricted* user opens the Assets Manager, the `Report Templates` folder is invisible: |
There was a problem hiding this comment.
Consider: Assets Manager Access
When a restricted user opens the Assets Manager, the Report Templates folder is not rendered at all—it’s completely invisible and inaccessible.
As insivible might make some people think we just hide it, and they can navigate to it by doing ../Report Templates/.. etc.
| |----|----| | ||
| ||| | ||
|
|
||
| * **Save Report As** - The *restricted* end-user can only save as a **Report**. The option for saving as a **Template** is hidden. |
There was a problem hiding this comment.
Consider: For restricted users, the Save as Template option is completely hidden. They can only use the Save as Report functionality.
| |Minimum Version:|Q4 2025| | ||
| |----|----| | ||
|
|
||
| The main purpose of using report templates in the Telerik Web Report Designer is to help users quickly create consistent, professional-looking reports without starting from scratch every time. |
There was a problem hiding this comment.
The first question I would ask: What are templates? And I'd like to see the answer in the intro of the article.
| } | ||
| </style> | ||
|
|
||
| # Report Templates in Web Report Designer |
There was a problem hiding this comment.
The title is too generic -> Try including words that provide hints to what the user/developer would be able to achieve after reading this article. For example, Creating and Using Report Templates, Creating, Customizing, and Managing Report Templates,
| * **Save Time**: Templates provide a ready-made layout and structure, so you can focus on your data and content rather than design. | ||
|
|
There was a problem hiding this comment.
When it comes to time saving, the most common term would be "Increased Productivity".
|
|
||
| * **Standardize Branding**: Templates can include your company’s logo, colors, fonts, and layout preferences - ensuring every report aligns with your brand. | ||
|
|
||
| ## How Templates Work in Web Report Designer |
There was a problem hiding this comment.
I like to think about each article like a short story. I don't see a coherent story here. The article should start by setting the stage (your intro), providing the basic context (Why Use Report Templates?), and then develop the plot by giving a sequence of events. What I miss in this article is the tight logical sequence of events (actions the user/dev can perform):
- Why do you describe what is a template in the "How Templates Work in Web Report Designer" section? This should be included in the definition for a template and the definition should be in the intro.
- Why are the steps for starting from a template preceding the steps to create a template? The logical order of things should be 1. Create and then 2. Use.
- Why do we have a section about the report formats, and what is the action/goal the client should have in order to need this information?
| border: 1px solid lightgrey; | ||
| } | ||
| </style> | ||
|
|
There was a problem hiding this comment.
How many personas is this article targeting? I'm left with the impression that it targets both app developers and report designers. If it targets more than one persona, make sure to split the content for the different personas into independent articles as mixing personas in a single article is confusing and considered poor practice.
Splitting the article would allow you more flexibility and let you build two focused articles that are much easier to follow.
| ### Creating Your Own Templates | ||
|
|
||
| You can design a report in the Web Report Designer and save it as a template. This allows you or your team to reuse it for future reports. When you wish to save the currenty opened report, select the `Save As...` option from the Menu: | ||
|
|
There was a problem hiding this comment.
The instructions here feel mixed up:
- Are you guiding the user how to save a report or how to create a template? You should probably focus on a single task for better readability.
- If there is a specific sequence, e.g. fist saving the report as a report and then, second, saving it as a template, then describe the sequence by using a numbered list.
| |----|----| | ||
| | || | ||
|
|
||
| ### Report File Formats |
There was a problem hiding this comment.
This section feels like the article is loosing the thread. Do you need to get into details about report formats when the main topic are templates? You may very well reference this information by linking an article, but do we need it here?
|
|
||
| ## Configure Report Templates Folder | ||
|
|
||
| If your application doesn't have a specific **Report Templates** folder setup, a default one will be created at root level of your project. You can also navigate to a specific custom folder that contains all the report templates you wish to use. |
There was a problem hiding this comment.
- How would you have one already configured?
- Are you talking to the dev or the report designer in this section? Or are you assuming that both roles are carried out by the same person reading the same article and the same section within that article?
|
|
||
| >note Report templates (.trtx files) can be stored only in the configured `Report Templates` folder. Other file formats are not allowed in the folder. | ||
| ## Managing Permissions |
There was a problem hiding this comment.
This section is targeting the app developer, so I suggest taking it to another article.
| @@ -0,0 +1,47 @@ | |||
| --- | |||
| title: How to Edit a Report Template | |||
There was a problem hiding this comment.
In my opinion, this should be a KB. The procedure described here can be summarized in up to two or three sentences tops, and up to one picture. If you accept my suggestion to split the report-templates article into two, you can describe the template editing in the designer-facing article by adding the two or three sentences and then referencing this KB there.
Report Templates in Web Report Designer: https://github.com/telerik/reporting/issues/5464