|
| 1 | +--- |
| 2 | +description: |
| 3 | +globs: |
| 4 | +alwaysApply: false |
| 5 | +--- |
| 6 | +--- |
| 7 | +description: 翻译 |
| 8 | +globs: |
| 9 | +alwaysApply: false |
| 10 | +--- |
| 11 | + |
| 12 | +# Translation Guidelines for site/docs |
| 13 | + |
| 14 | +When translating files under the `site/docs` directory, please adhere to the following guidelines: |
| 15 | + |
| 16 | +1. **Consistency in Terminology**: Ensure that terminology is consistent throughout the document. Use a glossary if available to maintain uniformity in terms. |
| 17 | + |
| 18 | + **Glossary**: |
| 19 | + |
| 20 | + - 文本/图片/点/标签/矩形标注 (textGuide、ImageGuide、PointGuide、TagGuide、RectGuide) |
| 21 | + - 自定义标注/图例 (withGuide、withLegend) |
| 22 | + - 时间轴 (Timeline) |
| 23 | + - 坐标轴 (Axis) |
| 24 | + - 组件 (Component) |
| 25 | + - 提示信息/交互 (Tooltip) |
| 26 | + - 饼图标签 (PieLabel) |
| 27 | + - 象形柱图 (PictorialBar) |
| 28 | + |
| 29 | +2. **Adjust Hyperlinks**: Review and adjust hyperlinks to ensure they point to the correct translated sections or documents. Verify that all links are functional and correctly formatted. |
| 30 | + |
| 31 | + - **Internal Links**: In the English version, all internal links should have a `/en` prefix, while the Chinese version should not have any prefix. Ensure this prefix is added to all internal links in English documents to avoid any oversight. |
| 32 | + - **Anchor Points**: For anchor points following a `#`, if they contain Chinese characters, they should be adjusted to match the corresponding title in the English version rather than being directly translated. |
| 33 | + - **External Links**: Convert external links appropriately to ensure they align with the language and context of the document. |
| 34 | + |
| 35 | +3. **Direct Writing to Translated Documents**: Translations should be stored in corresponding `.en.md` or `.zh.md` files within the same directory. Ensure that the translated content is placed in the correct location within the document. |
| 36 | + |
| 37 | + - When translating from Chinese to English, create or update the `.en.md` file in the same directory. |
| 38 | + - When translating from English to Chinese, create or update the `.zh.md` file in the same directory. |
| 39 | + |
| 40 | +4. **Support for Partial Content Translation**: Allow for the selection and translation of specific sections of content. Translated sections should be inserted into the appropriate location within the document, maintaining the logical flow and structure. |
| 41 | + |
| 42 | + - **Full Document Translation**: If the entire document is selected for translation, replace the entire content with the translated version. |
| 43 | + - **Partial Content Translation**: If only specific sections are selected, find the appropriate place to replace or insert the translated content, ensuring the document's logical flow and structure are maintained. |
| 44 | + |
| 45 | +5. **Contextual Translation**: Avoid literal translations. Ensure that the translation fits the English context and conveys the intended meaning accurately. |
| 46 | + |
| 47 | +6. **Direct Modification**: Translations should be directly modified in the corresponding `.en.md` or `.zh.md` files without returning the translated content separately. Ensure that the changes are saved in the correct file and location. |
| 48 | + |
| 49 | +7. **Preserve Metadata Order**: Do not modify the `order` attribute in the page metadata during translation. This ensures that the document order remains consistent across different language versions. |
| 50 | + |
| 51 | +8. **Add '/en' Prefix to Internal Links**: Ensure that all internal links in English documentation have the '/en' prefix to maintain consistency and correct navigation. |
| 52 | + |
| 53 | +9. **Always check if ${target_path} exists in the project structure,never create new files when translating existing documents. |
| 54 | + |
| 55 | +By following these guidelines, translations will be more accurate and consistent, facilitating easier review and integration into the documentation. |
0 commit comments