Trace:
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
reporting_engine:reporting_engine_template_edition_rules [2019/02/22 14:45] admin created |
reporting_engine:reporting_engine_template_edition_rules [2019/03/04 21:56] (current) yasko [Bookmarks] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | =====Template Edition Rules===== | + | =====Template Editing Rules/Requirements===== |
| Data to the template can be imported in two ways: | Data to the template can be imported in two ways: | ||
| Line 5: | Line 5: | ||
| * Bookmarks | * Bookmarks | ||
| - | Data of any format can be imported: number, picture, date, string, boolean, etc.\\ | + | Data in the following formats can be imported: number, picture, date, string, boolean, etc.\\ |
| - | The value can be formatted according to the program settings or by using formatting strings in the template.\\ | + | The values can be formatted according to the program settings or by using formatting strings in the template. Data can be inserted in any locations: headers, tables, strings, etc. |
| - | Data can be inserted in any locations: headers, tables, strings, etc. | + | \\ |
| ====$var_name$==== | ====$var_name$==== | ||
| - | $var_name$ - variable in $$ that will be replaced with formatted value. All $var_name$ with same name will be replaced in all part of documents.\\ | + | $var_name$ - variable in $$ that will be replaced with the formatted value. All $var_name$ with the same names will be replaced in all parts of the documents. Library uses current font settings of the $var_name$ during the filling. For example, if there are several variables with the same names but with different fonts, each variable uses its particular font settings. |
| - | Library use current font settings of the $var_name$ during filling. For example, if there are several variable with same name but with different fonts, each variable use particular font settings. | + | \\ |
| ====$var_name%%m.%d.%y%$==== | ====$var_name%%m.%d.%y%$==== | ||
| <nowiki> | <nowiki> | ||
| - | $var_name%%m.%d.%y%$ - variable with formatting string. | + | $var_name%%m.%d.%y%$ - variable with a formatting string. |
| </nowiki>\\ | </nowiki>\\ | ||
| - | There are some cases when user need to filled current data in different part of report with different format. For example: 01.01.20018 or 01/01/18. | + | There are some cases when users need to fill the current data in different parts of the report with different formats. For example: 01.01.20018 or 01/01/18. |
| - | + | \\ | |
| ====Bookmarks==== | ====Bookmarks==== | ||
| <WRAP left round info 50%> | <WRAP left round info 50%> | ||
| - | Set bookmark visible in MS Word settings | + | Set the bookmark to be visible in the MS Word settings. |
| </WRAP>\\ | </WRAP>\\ | ||
| \\ | \\ | ||
| \\ | \\ | ||
| \\ | \\ | ||
| - | Bookmarks have two style: | + | Bookmarks have two styles: |
| - | * Simple | + | * Simple |
| - | * Ranged – select range of text | + | * Ranged – select range of the text |
| - | Simple bookmark is filled by value beginning from right.\\ | + | A simple bookmark is filled by values beginning from the right.\\ |
| - | Range bookmark is filled by values beginning from right bracket. | + | A range bookmark is filled by values beginning from the right bracket. |
| - | Text in bracket will be deleted from the report if there is no import. It’s very useful when customer use big template with a lot of fields and tables which can be deleted if it’s not filled. | + | The text in the brackets will be deleted from the report if there is no import. It’s very useful when customers use big templates with a lot of fields and tables which can be deleted if not filled. |
| + | \\ | ||
| ====Description==== | ====Description==== | ||
| Line 41: | Line 41: | ||
| ^Name ^Description ^Example^ | ^Name ^Description ^Example^ | ||
| - | |variable |text designation of variable enclosed by %%'$'%%\\ \\ %%$var_name$%% - any phrases in %%$$%% will be replaced with string data or picture\pictures. All %%$var_name$%% with same name will be replaced in all part of the template.\\ \\ Font formatting settings will be saved |%%$var_name$%%| | + | |variable |Text designation of the variable enclosed by %%'$'%%\\ \\ %%$var_name$%% - any phrases in %%$$%% will be replaced with string data or picture\pictures. All %%$var_name$%% with the same names will be replaced in all parts of the template.\\ \\ Font formatting settings will be saved |%%$var_name$%%| |
| - | |formatted variable |Variable with string format.\\ String formatted variable overwrites the software settings.\\ \\ $var_name% %m.%d.%y%$ - variable with string format.\\ Very useful when you need to fill current date in various part of the doc and with different format: 01.01.20018 or 01/01/18.|$var_name% %m.%d.%y%$\\ $var_name% %X%$| | + | |formatted variable |A variable with string format.\\ A string formatted variable overwrites the software settings.\\ \\ $var_name% %m.%d.%y%$ - variable with string format.\\ Very useful when you need to fill current date in various parts of the doc using different formats: 01.01.20018 or 01/01/18.|$var_name% %m.%d.%y%$\\ $var_name% %X%$| |
| - | |bookmark |You can use Word bookmarks to import data into the protocol.\\ There are two modes of data import available:\\ -String\\ -Cell in table\\ \\ Place bookmark with string mode in any part of template to export values from the software.\\ “Cell in table” is used to fill several closed cells in any table.\\ \\ Set bookmark visible in MS Word settings |{{ :reporting_engine:template-edition-rules1.png?nolink&200 |}}| | + | |bookmark |You can use Word bookmarks to import data into the protocol.\\ Two modes of the data import are available:\\ -String\\ -Cell in table\\ \\ Place bookmark with the string mode in any part of the template to export values from the software.\\ “Cell in table” is used to fill several closed cells in any table.\\ \\ Set the bookmark to be visible in the MS Word settings |{{ :reporting_engine:template-edition-rules1.png?nolink&200 |}}| |
| - | |ranged bookmark |Range bookmark is a part of the text selected by a bookmark. It will be deleted if there is no data imported from the program.\\ There are two modes of data import available:\\ -String\\ -Line in table\\ \\ It is very useful when you want to use a single template for different tests. If the table is empty, they will be deleted. |Text will be deleted in case no import:\\ \\ Table name\\ {{ :reporting_engine:template-edition-rules2.png?nolink&200 |}}| | + | |ranged bookmark |A ranged bookmark is a part of the text selected by a bookmark. It will be deleted if there is no data imported from the program.\\ Two modes of the data import are available:\\ -String\\ -Line in table\\ \\ It is very useful when you want to use a single template for different tests. If a table is empty, it will be deleted. |Text will be deleted in case no there is no import:\\ \\ Table name\\ {{ :reporting_engine:template-edition-rules2.png?nolink&200 |}}| |
| \\ | \\ | ||
| <WRAP left round info 50%> | <WRAP left round info 50%> | ||
| - | All variables\bookmark available and format strings you can find in the “Report Data” settings in the software. | + | You can find all available variables\bookmarks and format strings in the “Report Data” settings within the software. |
| </WRAP> | </WRAP> | ||
| \\ | \\ | ||
| Line 58: | Line 58: | ||
| ====Examples==== | ====Examples==== | ||
| ^Variables\bookmarks ^Description^ | ^Variables\bookmarks ^Description^ | ||
| - | |$TR_Number$ |String with value format specified in the software| | + | |$TR_Number$ |String with a value format specified in the software| |
| - | |$TR_Number%UW%$|String with value format specified in the template| | + | |$TR_Number%UW%$|String with a value format specified in the template| |
| |$TR_Date$|Date with the format specified in the software| | |$TR_Date$|Date with the format specified in the software| | ||
| |<nowiki>$TR_Date% %x%$</nowiki>|Custom format in the template| | |<nowiki>$TR_Date% %x%$</nowiki>|Custom format in the template| | ||
| |<nowiki>$TR_Date% %d %B %Y%$</nowiki>|Custom format in the template| | |<nowiki>$TR_Date% %d %B %Y%$</nowiki>|Custom format in the template| | ||
| - | |$final_judgment$|Boolean with the format specified in the software| | + | |$final_judgment$|Boolean value with the format specified in the software| |
| |$final_judgment%"Pass"; "Fail"%$|Custom boolean format in the template| | |$final_judgment%"Pass"; "Fail"%$|Custom boolean format in the template| | ||
| \\ | \\ | ||
| \\ | \\ | ||
| - | See an example of a protocol template: {{ :reporting_engine:demo_template_example.docx |}} | + | You can view an example of a protocol template: {{ :reporting_engine:demo_template_example.docx |}} |