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? |
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
| })); | ||
| ```` | ||
|
|
||
| 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:
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
| |----|----| | ||
| ||| | ||
|
|
||
| * **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.
There was a problem hiding this comment.
Added "inaccessible" for more clarity.
| |----|----| | ||
| ||| | ||
|
|
||
| * **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.
There was a problem hiding this comment.
It is already stated: "end-user can only save as a Report" I will make the "only" word bold.
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
designing-reports/report-designer-tools/web-report-designer/report-templates.md
Outdated
Show resolved
Hide resolved
|
|
||
| * **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?
There was a problem hiding this comment.
- Create and then 2. Use. is valid in case you create a report first from scratch and save this report as a template. Only in this case will you have a template to use.
| 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.
There was a problem hiding this comment.
Splitting the content in two separate articles - one for the end-users and it will be moved to the User guide section and another one for the developers, remaining in the same section as the initial location having the content for specifying templates folder and managing permissions.
There was a problem hiding this comment.
https://github.com/telerik/reporting-docs/blob/dess-wrd-templates/user-guide/report-templates.md
https://github.com/telerik/reporting-docs/blob/dess-wrd-templates/designing-reports/report-designer-tools/web-report-designer/configuring-report-templates.md
https://github.com/telerik/reporting-docs/blob/dess-wrd-templates/knowledge-base/how-to-edit-a-report-template.md
| ### 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?
There was a problem hiding this comment.
Yes, this section may sound a bit weird but we can't reference such an article because we do not have one. That is why I wanted to clarify what is the format for the templates among the rest of the report formats. But I will think about extracting this important information outside the topic.
|
|
||
| ## 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.
|
I have applied most of the recommendations and split the main article into two - one for end-users and one for developers as Dancho suggested: |
Report Templates in Web Report Designer: https://github.com/telerik/reporting/issues/5464