Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include translation documentation #1436

Merged
merged 8 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ const sidebarUserGuide = [
]
},
['/Invoices', 'Invoices'],
['/Translation', 'Translation'],
['/PaymentRequests', 'Payment Requests'],
{
title: 'Pull Payments',
Expand Down
78 changes: 78 additions & 0 deletions docs/Translation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
description: BTCPay Translation features.
---

# Using BTCPay Translation Feature to Localize Your BTCPay Server instance


BTCPay Server now includes a powerful translation feature that allows merchant administrators manage their instance in their preferred language.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

This guide will help you create and manage translations, making the BTCPay platform more user-friendly for you.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

With this feature, you can replace the default English text across the entire application with your chosen language.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

Whether you want to customize texts on your checkout page, settings configuration, dashboard, or even error and success messages, BTCPay's translation feature makes it easy to tailor your experience to your linguistic needs.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

Note: You must be a server admin to access this feature. If you're not an administrator, please introduce this functionality to your admin.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved


## Step-by-Step Guide to Translating Text in BTCPay Server
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

1. Log in to your BTCPay Server instance.
2. Navigate to Translation on **Server Settings** >> **Translations**.

![Translation 1](./img/Translations/01_Translation.png)

3. Click **Create** button to generate a new language dictionary.

4. Enter the name you want to use to save the translation dictionary and then click **Create** button to create the dictionary.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

![Translation 2](./img/Translations/02_Translation.png)

![Translation 3](./img/Translations/03_Translation_creation.png)

![Translation 4](./img/Translations/04_Translation_dictionary.png)


As seen in the image above, we have a dictionary of words that are translatable on BTCPay Server instance.

Your dictionary is structured as (key: value), where:

**Key:** The original English text or phrase found in your BTCPay instance.

**Value:** The translated text you wish to display instead.

For each English term, enter its equivalent in your chosen language in the corresponding text. Make sure to review the translations for accuracy and clarity.

As an example lets start by translating "Add Role" into Yoruba. Since I created a dictionary for Yoruba language I would translate to Yoruba language.

![Translation 5](./img/Translations/05_Translation_Add_Role_To_Yoruba.png)

Replace the text and click the **Save** button. A confirmation message will appear indicating that your translations have been successfully saved. Now click on the **Select** button for the newly created dictionary to update the default dictionary on the system.

![Translation 6](./img/Translations/06_Translation_Saved_Dictionary.png)

Now to test out our translation. You can navigate to **Roles** under **Server Settings**, and if we look at the button on the top right of the Roles view, we can see that the text has been successfully translated from "Add Roles" to "Fi ipa kun".

![Translation 7](./img/Translations/07_Translation_Validation.png)

We can search other part of the BTCPay application that has "Add Role" text, and we can also confirm that it has successfully been translated to our chosen language text.

Now that you have successfully translated one, go ahead and translate other texts in the dictionary. All instances of English text will be replaced with your translated text, and now you can enjoy your new localized experience.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved

## Tips for Effective Translations

- **Consistency is Key:** Ensure that similar terms are translated consistently throughout.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved
- **Context Matters:** Keep context in mind when translating phrases to maintain meaning.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved
- **Review Regularly:** Regularly update translations as new features are added.
TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved


The translation feature on BTCPay Server allows you to create a personalized experience by managing content in your desired language. By following the steps highlighted above, you can easily set up and maintain translations, enhancing usability for yourself and your members.

## Support

Feel free to join our support channel over at [Mattermost chat](http://chat.btcpayserver.org/) if you need help or have any further questions.

If experience a bug or you would like to report any missing translation string, please open an issue in our [Github repository](https://github.com/btcpayserver/btcpayserver/issues)


TChukwuleta marked this conversation as resolved.
Show resolved Hide resolved
Binary file added docs/img/Translations/01_Translation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/Translations/02_Translation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading