Export Documentation - Configuration dialog box overview
Use the Export Documentation - Configuration dialog box to select the content to include in the localization file.
Parameters
Populate the Localization File with
Select the content include in the localization file:
- All Project Documentation (default)- all project documentation is included in the export file, regardless if the documentation has already been localized into the language(s) that you previously specified (in the first dialog of the export wizard).User-entered comments in logic or descriptions on components.
- Only Documentation That has Not Been Fully Localized- only the parts of the project documentation that have not been localized into one or more of the previously specified languages are included in the export file.For example, if the following tags had project documentation as described below and you decide to generate a localization file from English to German and Italian:
- TagA - contains English, German, and Italian descriptions
- TagB - contains English and Italian descriptions
- TagC - contains an Italian description
- TagD - contains English and German descriptionsOnly TagB and TagD are included in the localization file because they are missing one or more of the targeted translations. Notice that TagC is not included because it lacks a key language documentation (even though it is missing a German translation as well).
- Only Documentation That has Changed Since the Last Export- only the parts of the project documentation that have been modified since the last time project documentation was exported for translation (regardless of the export option chosen).This option helps you if you must make updates to documentation during the time period that project documentation is out for translation. This option also generates a list of documentation that did not exist when the last export occurred (because of new components or logic).If you choose this option, the very first time you create a localization file using the export wizard, all project documentation is included in the translation file.IMPORTANT:Upon import, any translation of any portion of documentation causes the documentation to no longer be a candidate for inclusion in an export file the next time an export file is generated using this option.
IMPORTANT:
Upon an export, all key-language translations (and only key-language translations) are not included in another export using this option, if one were to occur.
Include Project Context
Select to include context in the localization file to tie documentation back to a specific component in the source project.
Additional columns are added to the localization file designating the type and location of each portion of project documentation.
The default is selected. Otherwise, the last known state is the default.
Include Undocumented Component Names
Select the check box to include context in the localization file to tie documentation back to a specific component in the source project file. Additional columns are added to the localization file designating the type and location of each portion of project documentation.
Clear the check box to not include context in the localization file. The localization file contains only project documentation from one key language to one or more target languages. Note that no duplicate documentation exists in the localization file.
The default is cleared. Otherwise, the last known state is the default.
Refer to Including or Not Including Project Context for more information.
Include Component Names That Have Undocumented Descriptions
Select the check box to include in the localization file the names of project components that do not have descriptions.
The default is cleared. Otherwise, the last known state is the default.
This check box is unavailable if the Include Project Context box is not selected.
Provide Feedback