Including or Not Including Project Context
Refer to the following information to determine if you want to include project context.
Not Including Project Context
If you choose to not include project context in the localization file, the translation area of the localization file contains project documentation from one key language to one or more target languages. The project documentation is itself the unique identifier.
User-entered comments in logic or descriptions on components.
Translation Area Detail - No Context
The header information for the localization file when project context is not included:
IMPORTANT:
Identified by ** delimiters before and after the warning, in order to ensure a successful import of content, do not change the KEY column.
Translation Row Column Headers
- The column headers for the various translation columns are filled in automatically based on the choices you made in the Export Wizard. The Key language is provided in the first column. The word KEY precedes the text in the key column headers.Languages that are to be translated to are contained in columns to the right of the Key column. The language columns display the RFC1766 name of the language and then the localized name of the language.
Translation Rows
- Each row below the column header contains a string in the key language and a cell for each of the languages to translate the key language to.Effect of not including project context:
This option is most beneficial when a fully documented project in some key language is unlikely to change during the translation process and you need a simple localization file to work with. When project context is not included, you have the following usability advantages:
- You have no restrictions on modifying component properties in the source project file. You can modify component properties (aside from descriptions) without impacting the integrity of the imported translation.
- You do not have restrictions on modifying the location of text boxes, or the contents of a rung, or the location of a rung that has logic comments in the source project file.
- Confusion over what to translate is reduced because you do not have to define unique identifiers for each component or logic comment.
- The focus is solely on accomplishing the task of translating project documentation.
- No duplicate documentation exists in the localization file.
- Translations can be applied to multiple projects that may have the same documentation text strings on the same or different components or logic comments.
Including Project Context
If you choose to include project context, the translation area of the localization file also contains project documentation from one key language to one or more target languages plus two additional columns (TYPE and CONTEXT). These columns help tie documentation back to the owning components in the source project file.
Translation Area Detail - With Context
The header information for the localization file when project context is included is as follows:
IMPORTANT:
Identified by ** delimiters before and after the warning, in order to ensure a successful import of content, do not change the contents of the Type, Context, and KEY columns.
Translation Row Column Headers
- The column headers for the various translation columns are filled in automatically based on the choices you made in the Export Wizard. The columns are formatted as follows:- The first column is Type, which is an identifier of the type of component that is contained on the line in the file.
- The second column is Context, which is a brief indication of the component that owns the documentation that is to be translated in the source project.
- The third column is the Key language. The word KEY precedes the text in the key column headers.
- Columns to the right of the Key column contain the languages that the key language is to be translated to. The language columns display the RFC1766 name of the language and then the localized name of the language.
Translation Rows
- The contents of the translation rows are most affected by your choice to include undocumented component names in the localization file. Each row is marked with a TYPE and CONTEXT.Refer to the following table to understand how the type and context columns are displayed in the localization file.
Table Heading | Table Heading | Context |
|---|---|---|
Controller Scope tag | TAG | <tag_name> <tag_name>.<member>... Examples: MyTag MyTag.PRE.0 |
Controller Scope tag with Engineering Unit and State IDs | TAG | <<tag_name>.@EngineeringUnit <tag_name>.@State0 <tag_name>.@State1 <tag_name>.<member>.@EngineeringUnit <tag_name>.<member>.@State0 <tag_name>.<member>.@State1 Examples: MyTag.@EngineeringUnit MyBoolTag.@State0 MyBoolTag.@State1 MyTag.PRE.@EngineeringUnit MyTag.PRE.0.@State0 MyTag.PRE.0.@State1 |
Program Scope Tag and Equipment Phase Scope Tag | TAG_PRG | <program_name>.<tag_name> <program_name>.<tag_name>.<member>... <phase_name>.<tag_name> <phase_name>.<tag_name>.<member>... Example: MyProgram.MyPTag |
Program Scope Tag and Equipment Phase Scope Tag with Engineering Unit and State IDs | TAG_PRG | <program_name>.<tag_name>. EngineeringUnit <program_name>.<tag_name>. @State0 <program_name>.<tag_name>. @State1 <program_name>.<tag_name>.<member>.@EngineeringUnit <program_name>.<tag_name>.<member>.@State0 <program_name>.<tag_name>.<member>.@State1 Example: MyProgram.MyPTag.@EngineeringUnit |
AOI Local Tag and AOI Parameter | TAG_AOI | <aoi_name>.<local_tag_name> <aoi_name>.<local_tag_name>.<member>... <aoi_name>.<parameter_name> <aoi_name>.<parameter_name>.<member>... |
AOI Local Tag and AOI Parameter with Engineering Unit and State IDs | TAG_AOI | <aoi_name>.<local_tag_name>.@EngineeringUnit <aoi_name>.<local_tag_name>.@State0 <aoi_name>.<local_tag_name>.@State1 <aoi_name>.<local_tag_name>.<member>.@EngineeringUnit <aoi_name>.<local_tag_name>.<member>.@State0 <aoi_name>.<local_tag_name>.<member>.@State1 <aoi_name>.<parameter_name> <aoi_name>.< parameter_name >.@EngineeringUnit <aoi_name>.< parameter_name >.@State0 <aoi_name>.< parameter_name >.@State1 <aoi_name>.< parameter_name >.<member>.@EngineeringUnit <aoi_name>.< parameter_name >.<member>.@State0 <aoi_name>.< parameter_name >.<member>.@State1 |
Controller | CONTROLLER | blank |
Task | TASK | <task_name> |
Program | PROGRAM | <program_name> |
Routine | ROUTINE | <routine name> |
UDT and UDT Member | DATATYPE | <udt_name> <udt_name>.<member>... <udt_name>.<member>... |
Add-On Instruction, AOI extended description, and AOI revision note | AOI | <aoi_name> <aoi_name>.RevNote <aoi_name>.ExtDescText |
Trend | TREND | <trend_name> |
Pen in a T | n/a | n/a |
Module | MOUDLE | <module_name> |
Rung Comments | RCOMMENT | <program_name>.<routine_name>. Rung[ <rung_number> ].[ <owning_element> ] EExamples: MyProgram.MyRoutine.Rung[0].[JSR(My_SFC_Routine,0)] MyProgram.MyRoutine.Rung[2].[;] MyProgram.MyRoutine.Rung[3].[OTE(Local:1:I.Data.16)] |
Rung Comment in an AOI Routine | RCOMMENT_AOI | <aoi_name>.<routine_name>. Rung[ <rung_number> ].[ <owning_element> ] |
SFC or FBD Text Box | TEXTBOX | <aoi_name>.<routine_name>. Rung[ <rung_number> ].[ <owning_element> ] Examples: MyProgram.MySFC.Location[40:-20].[80:40] MyProgram.MySFC.Location[-100:0].[Tran_000] MyProgram.MySFC.Location[40:340] |
FBD Text Box in an AOI Routine | TEXTBOX_AOI | <aoi_name>.<routine_name>. Location[ <coordinates> ].[ <owning_element> ] |
Alarm Messages | ALMMSG ALMMSG_PRG ALMMSG_AOI | <tag_name>.<alarm_type> <program_name>.< tag_name>.<alarm_type> <phase_name>.< tag_name>.<alarm_type> <alarm_type> can be: HH, H, L, LL, PROC, NROC |
You may also choose to include undocumented components in the localization file if you have also included context. You choose to include undocumented components in the localization file during the export operation. Undocumented rung comments or text boxes are not included in the translation area as a result of this option. However, other undocumented components may be included in the localization file (as configured in the export wizard). If undocumented components are included, the KEY column is blank for these components in the localization file (since they are undocumented).
Effect on including project context
For projects where documentation will be modified during the translation process, you should include project context in the localization file. By including context, you are provided specific information explaining why certain translations were not brought into the project, which is one of the key advantages of including project context.
As in the case when you do not include project context, the documentation itself serves as the unique identifier, if possible. The context and type columns are only added when the KEY column is blank to help tie documentation back to the owning components in the source project file.
IMPORTANT:
Do not modify the leading columns (TYPE, CONTEXT, and KEY) are modified.
To clarify, if the KEY column has an entry, then that entry is used as the unique identifier for the import. If the KEY column is blank, then the CONTEXT column serves as the unique identifier. It is important that the KEY column stay blank if it was initially blank. If you want to add documentation in the language specified in the KEY column, add a column to the localization file that contains content for the language specified in the KEY column.
You have the following usability advantages when you include project context:
- You receive specific error messages explaining why translations were not included in the localization file because the key translation changed in the project while the localization file was being translated.
- You have the option to document components that do not have documentation in the key language in languages other than the key language
You have the following usability disadvantages when you include project context:
- The localization file has more content, which may confuse a translator not familiar with the concepts presented in aLogix Designerapplication project file.
- Duplicate documentation strings may be present in the localization file.
It is important to note the following because documentation is the unique identifier when importing translations:
- Component names can change during the translation process and the import of translations will still succeed.
- Rung and Text Box locations can change during the translation process and the import of translations will still succeed.
To summarize, this option is most beneficial for a project that is likely to change during the translation process or one that contains undocumented components that must be documented.
Provide Feedback