Style Guide Manager (Style Guide Details)

What is a style guide?

• A style guide defines the styles of the source and target texts that are to be used for the specific group or project. A style guide is used in Quick PE during the retranslation and verification processes in File Editor by linguists (translators and reviewers). You can set up a style guide with the following information.
  
  • Style guide name
  • Language (source and target language): Select from the following options
    
    • Japanese: ja, ja-JP
    • English: en, en-US
    • Chinese: zh, zh-CN, zh-TW
  • Item names and rule names: Style guides, items and rules are hierarchical, allowing you to register multiple items in one style guide and multiple rules in one item.
    
    • Style guide: A group of items
    • Item: A group of rules
    • Rule: Information to validate the actual style
• You can edit and delete the added items and rules, respectively. If you delete an item that has already been created, the rules belong to the item will be deleted collectively.

<Style Guide Details screen> 

<Item Settings screen: Example> 

<Rule Settings screen: Example> 

Each project manager can register multiple style guides. Each style guide, item, and rule can be edited and deleted. When deleting the existing item, the rules belonging to it will also be deleted at the same time. 

How to add a new style guide

1. In Style Guide List screen, click [+ Add New Style Guide] button. 

2. In Style Guide Details screen, enter any style guide name and select the languages (source and target) from the drop-down list. 

3. Click [Add] at the bottom of the [Item Name] area to display Item Settings screen (pop-up), and enter the [Item Name] then save it. As an item can have multiple rules, we recommend to set an item name which indicates these lower-level rules. 

4. Click [Add] at the bottom of the [Rule Name] area with the items added in step 3 selected, and Rule Settings screen (pop-up) will appear. Enter the following information and save it. 
   
   • - Item Name: The name of the selected item will be displayed automatically (read only). If you want to change it, please do so on Item Settings screen.
   • - Rule Name: Arbitrary text (name) to identify the rule
   • - Details - Search for: Specifies a style to search for and validate in the validation target range. Specify a style using a regular expression. In File Editor, strings matching this style will be searched for and validated during the validation and re-translation processes.
   • - Validate: Specify the target range to search for the style. You can specify either [Modify Source Text] and/or [Modify Target Text] columns in the edit area of File Editor.
   • - Verification Message: Enter a message to be displayed (for linguists) when the verification function is executed in File Editor then this rule is violated. "Please check if the translation is compliant with the style guide" will be displayed as the default message when you register a new rule, but you can overwrite it with any one.
   • - Comment: These are notes for the project managers and will not be displayed in File Editor. This is not a required field, so please use it if necessary.
5. Once you have created the required items and rules, click [Save] button at the bottom of the screen to save the style guide. 
6. The created style guides will be displayed in Style Guide List screen and can be edited anytime by clicking the [Edit] button. 

Sample regular expressions

The rules of each item must be specified by a regular expression. The following is a list of samples of typical regular expressions, but if necessary, you can find them on a page provided by Microsoft (https://docs.microsoft.com/ja-jp/dotnet/standard/base-types/regular-expression-language-quick-reference) or elsewhere. 

How to specify a style guide to use in a project

• • After registering a style guide, you can select style guides to be available for the group in Group Details screen. Only style guides registered in the organization can be selected in the screen. You can select multiple style guides for each group.
  • Next, select a style guide to be available for the project in Project Details screen. Only style guides available for the group, and those both source and target languages are identical to the project's first priority MT engine, can be selected in the screen. You can select only one style guide for each project.
  • You can delete a style guide even if it is currently being used (selected) by a group or project. If you delete data from [Delete] button at the bottom of Style Guide Details screen, you will not be able to reference it in the verification process on File Editor screen even if it is already selected on Group Details screen or Project Details screen.

Languages (with or without locale)

• • You can select the language direction (source language and target language) of the style guide from Japanese, English, and Chinese.
  • You can set the language code with locale (ja-JP, en-US, zh-CN, zh-TW) as necessary. * These language codes with locale are mainly intended for importing style guide files with locale settings, but there is no function to import style guide files at this time.