Karl/homepage
1
0
Fork 0
mirror of https://github.com/karl0ss/homepage.git synced 2025-04-29 12:03:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs tweaks

Browse Source
This commit is contained in:
shamoon 2024-06-17 22:17:28 -07:00
parent 11cc4a15cf
commit 0ee3e7153d
4 changed files with 26 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/widgets/authoring/index.md
View File

@ -14,22 +14,20 @@ If you are new to Homepage widgets, and are looking to create a new widget, plea
All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage).
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets. To learn more about translations, please refer to the guide here: [Translations Guide](translations.md).
If you are looking to learn more about translations, please refer to the guide here: [Translations Guide](translations.md).
### Widget Component ### Widget Component
The widget component is the core of the widget. It is responsible for [fetching data from the API](api.md) and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component. The widget component is the core of the widget. It is responsible for [fetching data from the API](api.md) and rendering the widget UI. Homepage provides a set of hooks and utilities to help you build your widget component.
If you are looking to learn more about widget components, please refer to the guide here: [Component Guide](component.md). To learn more about widget components, please refer to the guide here: [Component Guide](component.md).
### Widget Metadata ### Widget Metadata
Widget metadata defines the configuration of the widget. It defines the API endpoint to fetch data from, the proxy handler to use, and any data mappings. Widget metadata defines the configuration of the widget. It defines the API endpoint to fetch data from, the proxy handler to use, and any data mappings.
If you are looking to learn more about widget metadata, endpoint and data mapping, please refer to the guide here: [Metadata Guide](metadata.md). To learn more about widget metadata, endpoint and data mapping, please refer to the guide here: [Metadata Guide](metadata.md).
If you are looking to learn more about proxy handlers, please refer to the guide here: [Proxies Guide](proxies.md). To learn more about proxy handlers, please refer to the guide here: [Proxies Guide](proxies.md).
If you are looking to learn more making API calls from inside your widget, please refer to the guide here: [API Guide](api.md). To learn more about making API calls from inside your widget, please refer to the guide here: [API Guide](api.md).

2
docs/widgets/authoring/metadata.md
View File

@ -56,7 +56,7 @@ Here are some examples of how to configure a widget's metadata object.
}; };
``` ```
A widgets metadata is quite powerful and can be configured in many different ways. A widget's metadata is quite powerful and can be configured in many different ways.
## Configuration Properties ## Configuration Properties

28
docs/widgets/authoring/translations.md
View File

@ -5,8 +5,6 @@ description: Tips and tricks for translating and localizing Homepage widgets.
All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). All text and numerical content in widgets should be translated and localized. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage).
The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
## Translations ## Translations
Homepage uses the [next-i18next](https://github.com/i18next/next-i18next) library to handle translations. This library provides a set of hooks and utilities to help you localize your widgets, and Homepage has extended this library to support additional features. Homepage uses the [next-i18next](https://github.com/i18next/next-i18next) library to handle translations. This library provides a set of hooks and utilities to help you localize your widgets, and Homepage has extended this library to support additional features.
@ -32,15 +30,25 @@ Homepage uses the [next-i18next](https://github.com/i18next/next-i18next) librar
} }
``` ```
=== "en.json" ## Set up translation strings
```json Homepage uses translated and localized strings for **all text and numerical content** in widgets. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). To add the English translations for your widget, follow these steps:
"yourwidget": {
"key1": "Value 1", Open the `public/locales/en/common.js` file.
"key2": "Value 2",
"key3": "Value 3" Add a new object for your widget to the bottom of the list, like this:
}
``` ```json
"yourwidget": {
"key1": "Value 1",
"key2": "Value 2",
"key3": "Value 3"
}
```
!!! note
Even if you natively speak another language, you should only add English translations. You can then add translations in your native language via [Crowdin](https://crowdin.com/project/gethomepage), once your widget is merged.
## Common Translations ## Common Translations

20
docs/widgets/authoring/tutorial.md
View File

@ -55,25 +55,9 @@ export default widget;
All widgets that fetch data from dynamic endpoints should have either `mappings` or an `allowedEndpoints` property. All widgets that fetch data from dynamic endpoints should have either `mappings` or an `allowedEndpoints` property.
## Set up translation strings ## Including translation strings in your widget
Homepage uses translated and localized strings for **all text and numerical content** in widgets. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). To add the English translations for your widget, follow these steps: Refer to the [translations guide](translations.md) for more details. The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
Open the `public/locales/en/common.js` file.
Add a new object for your widget to the bottom of the list, like this:
```json
"yourwidget": {
"key1": "Value 1",
"key2": "Value 2",
"key3": "Value 3"
}
```
!!! note
Even if you nativly speak another language, you should only add English translations. You can then add translations in your native language via [Crowdin](https://crowdin.com/project/gethomepage), once your widget is merged.
## Create the widget component ## Create the widget component