Guidelines for translating G2 documentation, including terminology consistency, hyperlink adjustments, and file naming conventions for multilingual documentation. Use when need to translate documents.
name G2 Translation Guidelines description Guidelines for translating G2 documentation, including terminology consistency, hyperlink adjustments, and file naming conventions for multilingual documentation. Use when need to translate documents. G2 Translation Guidelines These guidelines provide comprehensive instructions for translating G2 documentation files, particularly those under the site/docs directory.
, if they contain Chinese characters, they should be adjusted to match the corresponding title in the English version rather than being directly translated. External Links: Convert external links appropriately to ensure they align with the language and context of the document. 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. When translating from Chinese to English, create or update the .en.md file in the same directory. When translating from English to Chinese, create or update the .zh.md file in the same directory. 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. Full Document Translation: If the entire document is selected for translation, replace the entire content with the translated version. 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. 5. Contextual Translation Avoid literal translations. Ensure that the translation fits the English context and conveys the intended meaning accurately. 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. 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. 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. 9. File Existence Check Always check if ${target_path} exists in the project structure; never create new files when translating existing documents. By following these guidelines, translations will be more accurate and consistent, facilitating easier review and integration into the documentation.