Translating Knowledge Base Articles - HL Vanilla Community
<main> <article class="userContent"> <p>📝 <strong>NOTE</strong>: This feature requires that the <strong>Product Integration</strong> option be enabled.</p><h2 data-id="prep-link-subcommunities-to-knowledge-bases">Prep - link subcommunities to knowledge bases</h2><p>Knowledge bases (<strong>KBs</strong>) can be linked to subcommunities through a <strong>shared product</strong>. In order to do so, you have to:</p><ul><li>enable the <strong>Product Integration</strong> setting,</li><li>link a subcommunity to a product, and</li><li>select the product on the preferred KB's add/edit modal.</li></ul><p>The KB will then be available in all languages and all subcommunities of that product.</p><p>This article details the process.</p><h3 data-id="machine-translation">Machine Translation</h3><p>Knowledge base users can also use Machine Translation services to translate KB articles.</p><p>In order to use this feature, you have to:</p><ul><li>enable the <strong>Subcommunities</strong> addon (for multilingual and multi-product communities),</li><li>enable the <strong>Knowledge</strong> addon, and</li><li>be subscribed to either of our <strong>Translation Service Providers</strong>: <em>Google Translate</em> or <em>DeepL Translator</em>.</li></ul><h2 data-id="what-does-this-process-do"><strong>What does this process do?</strong></h2><p>This process allows you to add and edit translations for each knowledge base article. This is simplified by the addition of a <em>language-selector dropdown</em> on every translated KB article:</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/Q2IVYC8F59K1/language-selector-dropdown.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/Q2IVYC8F59K1/language-selector-dropdown.png" alt="Language selector dropdown.png" height="382" width="515" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>Your KB will have the same number of articles in the same organization/structure in each language, but it will serve up different (language-based) content depending on which subcommunity is being viewed. This allows each translation of an article to have the same ID as the original article, which is important for maintaining the organization of multiple subcommunities.</p><p>✔️ <strong>TIP</strong>: Another way of explaining this is that it creates <strong>one </strong>KB that lives in <strong>one </strong>spot, has <strong>one </strong>set of articles, has <strong>one </strong>layout and structure, but "speaks" multiple languages depending on who's talking to it.</p><p>You can use this process with machine translation and with customer-provided translations.</p><h2 data-id="what-can-i-not-do"><strong>What </strong>can I not do<strong>?</strong></h2><p>You <strong>cannot</strong> connect a KB that is written in one language to a different KB that is written in a different language.</p><h2 data-id="how-to-set-up-a-kb-for-translation"><strong>How to set up a KB for translation</strong></h2><p>This series of steps requires you to access the <strong>Settings</strong> tab of the Dashboard and work across several pages.</p><p>✔️ <strong>TIP</strong>: Be sure to <strong>save your work</strong> (where available) as you navigate.</p><h4 data-id="language-settings">Language Settings</h4><p>1. Navigate to <strong>Technical > Language Settings</strong>.</p><p>2. Slide the toggle to the right to enable any language that you want available for your KB translations.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/XZVAWP2W7T9O/language-settings.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/XZVAWP2W7T9O/language-settings.png" alt="Language Settings.png" height="589" width="1151" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h4 data-id="subcommunities">Subcommunities</h4><p>1. Navigate to <strong>Discussions > Subcommunities</strong>.</p><p>2. Slide the toggle to the right to <strong>Enable Product Integration</strong>.</p><p>3. Click <strong>manage products</strong> and add a product (e.g., <strong>Translation</strong>) to represent the translation.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/5FPQIGC2LFTJ/manage-prods-translation.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/5FPQIGC2LFTJ/manage-prods-translation.png" alt="Manage Prods_translation.png" height="325" width="896" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>4. Add (or edit) a subcommunity for each language.</p><p>📝 <strong>NOTE</strong>: Be sure to set the <strong>Product</strong> field to the product that you've just created (in our example, <strong>Translation</strong>).</p><p>📝 <strong>NOTE</strong>: Every subcommunity that you want a translation for should use the <strong>same product</strong>.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/JNQNDFNN0ATS/add-site-product-translation.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/JNQNDFNN0ATS/add-site-product-translation.png" alt="Add Site_Product-Translation.png" height="421" width="807" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h4 data-id="knowledge-base">Knowledge Base</h4><p>1. Navigate to <strong>Knowledge > Knowledge Bases</strong>.</p><p>2. Click the <strong>pencil</strong> icon to edit a KB that you want to translate.</p><p>3. Click the <strong>Product</strong> dropdown and select a product (e.g., <strong>Translation</strong>).</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/UTQIQ4N5PZVI/edit-kb-product-translation.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/UTQIQ4N5PZVI/edit-kb-product-translation.png" alt="Edit KB_Product-Translation.png" height="300" width="842" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>4. Click the <strong>translate</strong> button in the upper right of the Edit Knowledge Base window to translate the KB articles for each locale.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/3VIFK3J2F560/edit-kb-translate-button.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/3VIFK3J2F560/edit-kb-translate-button.png" alt="Edit KB_Translate button.png" height="586" width="1005" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>📝 <strong>NOTE</strong>: Repeat these steps for <strong>each of the KBs that you want to translate</strong>. Remember that you create the content (KB / articles) only once -- and then you <em>add the translations to that original content</em>.</p><p>Lastly, provide translations for each KB article.</p><p>📝 <strong>NOTE</strong>: KB articles can be manually translated or translated using Vanilla's Machine Translation option, as described in the sections that follow.</p><h2 data-id="manual-translation"><strong>Manual translation</strong></h2><p>To manually translate an article:</p><p>1. Navigate to the article page in the primary language.</p><p>2. Click the dropdown under <strong>Other Languages</strong> and select the language you want to translate.</p><p>📝 <strong>NOTE</strong>: An exclamation mark (<strong>!</strong>) displays next to any languages for which there is <strong>not</strong> a translated version of this article.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/E3U4Z716SS2F/manualtranslation-other-langs-dropdown.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/E3U4Z716SS2F/manualtranslation-other-langs-dropdown.png" alt="ManualTranslation-Other Langs dropdown.png" height="386" width="864" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>You will now be viewing the article in the new Language subcommunity.</p><p>A message (in the new language) displays telling you how to update this version of the article.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/R2N6H954H10F/manualtranslation-edited-mssge.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/R2N6H954H10F/manualtranslation-edited-mssge.png" alt="ManualTranslation-edited mssge.png" height="102" width="768" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>3. Click the <strong>ellipsis</strong> icon in the upper right and select <strong>Edit</strong> (translated version):</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/6G2MB13K3PM8/manualtranslation-ellipsis-dropdown.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/6G2MB13K3PM8/manualtranslation-ellipsis-dropdown.png" alt="ManualTranslation-ellipsis dropdown.png" height="425" width="1056" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>4. Add in the translated version of the article and click <strong>Publish</strong>.</p><p>The translated version of this article is now linked to the original language version.</p><h2 data-id="machine-translation-1">Machine Translation</h2><p>To use Vanilla's Machine Translation feature, you must configure at least one of Vanilla's <em>Translation Service Providers</em>.</p><p>📝 <strong>NOTE</strong>: You can configure both and have both available in your community, but each article can be translated by only one.</p><p>1. Access the Dashboard.</p><p>2. Navigate to <strong>Settings > Technical > Language Settings</strong> and click the <strong>Machine Translation</strong> tab.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/JN2LZXRI72B5/language-settings-machinetranslation-tab.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/JN2LZXRI72B5/language-settings-machinetranslation-tab.png" alt="Language Settings-MachineTranslation tab.png" height="332" width="1006" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>3. Slide the toggle to the right (ON) to enable machine translation.</p><p>4. Click the <strong>pencil</strong> icon for either Google Translate or DeepL Translator and refer to the relevant "configure" section below.</p><p>✔️ <strong>TIP</strong>: You can configure both service providers and have both available in your community.</p><p>📝 <strong>NOTE</strong>: When you complete these steps, remain on the Language Settings page and refer to <strong>Set Translation Service Providers for languages</strong>, below.</p><h2 data-id="configure-google-translate"><strong>Configure Google Translate</strong></h2><p>1. Specify your Google Translate API Key and click <strong>Save</strong>.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/AYHWOSTU7ER9/google-translate.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/AYHWOSTU7ER9/google-translate.png" alt="Google Translate.png" height="233" width="472" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h2 data-id="configure-deepl-translator"><strong>Configure DeepL Translator</strong></h2><p>To use DeepL Translator:</p><ul><li>You must have a DeepL API Pro account.</li><li>You must submit a request to Vanilla Support (<a href="unsafe:support@vanillaforums.com" rel="nofollow noreferrer ugc">support@vanillaforums.com</a>) or your CSM to have this option enabled.</li></ul><p>1. Specify your DeepL Translator API Key.</p><p>2. Optionally, specify any of the following, and click <strong>Save</strong>.</p><ul><li>Words to ignore while translating</li><li>HTML/XML tags to ignore while translating</li><li>HTML/XML tags to cause splits</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/7XMLGO284IHJ/deepl-translator.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/7XMLGO284IHJ/deepl-translator.png" alt="DeepL Translator.png" height="638" width="575" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h2 data-id="set-translation-service-providers-for-languages">Set Translation Service Providers for languages</h2><p>After you've configured one or both Translation Service Providers, you can set which service provider to use per language.</p><p>📝 <strong>NOTE</strong>: If you've configured only one Translation Service Provider, it is automatically set as the default for your enabled languages.</p><p>1. Click the <strong>Localization</strong> tab on the Language Settings page.</p><p>2. Click the <strong>pencil</strong> icon for any enabled language and select the service provider you would like to use.</p><p>✔️ <strong>TIP</strong>: Set this to <strong>None</strong> (i.e., <em>no machine translation</em>) individually for any enabled language that you prefer to <em>manually translate</em>.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/OJM3N34QIY3N/translationsp-dropdown.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/OJM3N34QIY3N/translationsp-dropdown.png" alt="TranslationSP dropdown.png" height="302" width="672" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h2 data-id="translate-an-article"><strong>Translate an article</strong></h2><p>Now that Machine Translation is set up, you can start translating articles.</p><p>1. Navigate to your knowledge base and open an article in that you want to translate.</p><p>2. Click the <strong>ellipsis</strong> icon and select <strong>Machine Translation</strong>.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/B1SSDACZNWVZ/machinetranslation-option.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/B1SSDACZNWVZ/machinetranslation-option.png" alt="MachineTranslation-option.png" height="459" width="864" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>The Machine Translation modal lists which languages (French, Japanese, English) are configured for this KB and this article's translation status for each language.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/YL46WIQ6IHOG/machinetranslation-status.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/YL46WIQ6IHOG/machinetranslation-status.png" alt="MachineTranslation-status.png" height="280" width="576" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <ul><li><strong>Not Translated</strong> - the article is not available in that language because it has not been translated.</li><li><strong>Up To Date</strong> - the article has been translated and is aligned with the source locale.</li><li><strong>Out Of Date</strong> - the article has been translated but the source locale has an update that may not be reflected in the translation.</li></ul><p>3. Click <strong>Translate</strong> to translate an article that has <em>not been translated</em> or is <em>out of date</em>.</p><p>4. Translate the article into another language or click <strong>Close</strong>.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/L68KQKTU4042/xo4mwjrxzv.gif" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/L68KQKTU4042/xo4mwjrxzv.gif" alt="xo4mWjrXZV.gif" height="721" width="1422" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>When the translation is complete, the article is automatically published.</p><p>✔️ <strong>TIP</strong>: Click the <strong>Other Languages</strong> dropdown to preview a translation.</p><p>⭐️ <strong>EXAMPLE</strong>: Below is an example of a KB, <em>Mysteries of the Universe</em>, with several translations. This KB "speaks" four languages: German, English, French, and Spanish.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/AX1M2BSO34EO/multi-lang-kb.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/AX1M2BSO34EO/multi-lang-kb.png" alt="Multi-lang KB.png" height="190" width="907" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><br></p> </article> </main>