Skip to content

desentio/globalseo

Repository files navigation

Enhance your website with GPT-4 powered translations. For more details, visit our integration guides: globalseo.ai/integration.

About the Integration

To set up Globalseo, follow these steps:

  1. Sign Up: Go to Globalseo and sign up.
  2. Create a Project: Select the languages you want to translate your website into.
  3. Copy the Code: Copy the generated HTML code.
  4. Embed the Code: Add the custom code to the start of the <body> tag and include the code for the language switcher.
  5. Save the Project: Finalize by saving your project.

1. Insert the Script

Place the following script inside your tag

<link href="https://unpkg.com/globalseo/dist/translate.css" rel="stylesheet">
<script
  src="https://unpkg.com/globalseo/dist/translate.js"
  data-globalseo-key="YOUR_API_KEY"
  data-use-browser-language="true"
  data-original-language="en"
  data-allowed-languages="de, es, ru, id, hi, zh, ja"
  data-exclude-classes=""
></script>

Script Configuration:

  1. Replace YOUR_API_KEY with the actual API key obtained from your project.
  2. Set data-original-language to your website's primary language code.
  3. Add the languages you want to translate your website to here: data-allowed-languages.

Optional Configuration:

  • data-use-browser-language: Automatically sets the language based on the user's browser language. Set to false to disable.
  • data-exclude-classes: List CSS class names to exclude from translation, separated by commas (e.g., chatbot, no-translate).
  • data-exclude-ids: List IDs to exclude from translation, separated by commas (e.g., user-comment, code-snippet will prevent translation of elements with ID user-comment and code-snippet).
  • data-exclude-paths: List URL paths to exclude from translation, separated by commas (e.g., /admin, /blog will prevent translation of URLs containing /admin and /blog). NOTE: Each path should start with a /.

Server Side Rendering Configuration:

  • data-translation-mode: Modify the translated pages logic. Set to subdomain to point to subdomains (for example: de.domain.com), or subdirectory to point to paths (for example: domain.com/de). DONT USE if you are not using SSR (SSR only available in higher plans).

View more options here.

2. Add the language selector

Enable users to select a language by adding:

<div class="globalseo-select globalseo-lang-selector-wrapper globalseo-exclude">
  <details role="group">
     <summary role="button" class="globalseo-lang-selector-loading">
        <svg class="globalseo-lang-selector-loading-icon" width="20" height="20" viewBox="0 0 34 34" fill="none" xmlns="http://www.w3.org/2000/svg">
           <path d="M16.7906 28.9982C14.131 28.9516 11.5622 28.0231 9.48748 26.3584C7.4128 24.6937 5.94973 22.3871 5.328 19.8007M16.7906 28.9982C13.4777 28.9404 10.8853 23.521 11.0009 16.8953C11.1166 10.2697 13.8966 4.94402 17.2094 5.00185M16.7906 28.9982C17.4055 29.0089 18.0021 28.8342 18.5667 28.5M16.7906 28.9982C17.4353 29.0094 17.904 28.9456 18.4338 28.8411M5.328 19.8007C8.73815 21.7699 12.6799 22.9255 16.8953 22.9991C17.5541 23.0116 18.2116 22.9969 18.8663 22.9553M5.328 19.8007C5.09283 18.8151 4.98323 17.8037 5.00182 16.7906C5.03917 14.6509 5.63417 12.6503 6.64706 10.9277M17.2094 5.00185C20.5222 5.05968 23.1147 10.4791 22.9991 17.1047C22.9878 17.7501 22.9513 18.3831 22.8914 19M17.2094 5.00185C19.3374 5.03811 21.4175 5.63986 23.2362 6.74538C25.0548 7.8509 26.5467 9.42037 27.5585 11.2928M17.2094 5.00185C15.0814 4.96382 12.9816 5.49262 11.1255 6.53399C9.26935 7.57536 7.72367 9.09181 6.64706 10.9277M27.5585 11.2928C24.612 13.7563 20.8749 15.0729 17.0349 15.0003C13.0382 14.9306 9.40832 13.4003 6.64706 10.9277M27.5585 11.2928C28.5415 13.1075 29.0375 15.146 28.9982 17.2095C28.9905 17.6459 28.9597 18.0764 28.9068 18.5" 
           stroke="#000000" stroke-width="1.25" stroke-linecap="round" stroke-linejoin="round"/>
           <g style="animation: globalseospin 2s linear infinite; transform-origin: 26px 26px;">
             <circle cx="26" cy="26" r="7.125" stroke="#000000" stroke-width="1.75" stroke-dasharray="31.42" stroke-dashoffset="10.47"></circle>
           </g>
       </svg>
     </summary>
  </details>
</div>

Excluding Text from Translation

Use the class "globalseo-exclude" to prevent translation of specific content, like chat pop-ups or user-generated text.

Note: Input fields and iframes are ignored by default.

Directing Users to a Specific Language Version

Direct users to a specific language version by using the /?lang=LANGUAGE_CODE URL parameter. For instance, example.com/?lang=ru will automatically translate the page into Russian.

Advanced Configuration

  • data-translate-attributes: Translates title & alt attributes of images and links. Improves SEO and accessibility. Set to true to enable.
  • data-lang-parameter: URL parameter for setting the language (default: "lang"). Use a custom value if preferred.
  • data-timeout: Delay (in milliseconds) before the translation service activates, ensuring the page content is fully loaded.
  • data-replace-links: Replaces links with translated URLs by appending the language code. Set to false to disable.
  • data-custom-language-code: Custom language code for the language selector (e.g., kk=kz for "KZ" instead of "KK").
  • data-exclude-contents: Excludes specific text from translation using regular expressions. Format: {{regex1}} {{regex2}}.
  • data-translate-form-placeholder: Translates form placeholders. Set to true to enable.
  • data-dynamic-translation: Allow GlobalSEO to automatically generate new translations. Set to false to disable. If you have already reached the quota limit, setting this to false will prevent the error message from appearing on your site.
  • data-translate-select-options: Translate options inside select tag. Set to true to enable. The globalseo-exclude class will still be respected.