Official Kodi Wiki - User contributions [en]

Translations

2022-11-18T18:59:18Z

Gade: /* Contact and support */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised. 
The former strings.xml file has been superseeded by the appropriate GNU gettext strings.po files.
 
[https://kodi.tv/article/switching-translations-to-weblate/ In 2021 Kodi switched translation platform to Weblate.]

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
You can create a new account or use an existing Google, Facebook or Github account. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there. 
Or you can join the [https://forum.kodi.tv/showthread.php?tid=370465 official channel at Slack for all language and translation related discussions.]

= Sync time schedule =
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged. 
It depends how many translations are done for a specific language, but usually new versions are released once a month.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Add-on:Rapier

2022-10-11T09:58:00Z

Gade: /* Media */

{{Addon
|Name=Rapier
|provider-name=Scarfa, Gade
|ID=skin.rapier
|latest-version=12.3.5
|extension point=xbmc.gui.skin
|provides=
|Summary=Rapier skin by Scarfa, Gade.
|Description=The goal is to provide a simple to use but clean and elegant interface that focuses on efficiency when browsing your media. Important considerations are put on usability, performance, and providing the user with flexibility when it comes to customization. Rapier tries to support all the latest features Kodi has to offer as long as it fits in with the skin's design goals.
|Platform=all
|Language=
|License=Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
|Forum=https://forum.kodi.tv/forumdisplay.php?fid=120
|Website=https://kodi.wiki/view/Add-on:Rapier
|Source=https://github.com/gade01/Rapier
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/skin.rapier/resources/icon.png}}

== Development version / Gade's Add-on Repository ==
<section begin=DevelopmentVersion/>I have created an add-on repository for Rapier and my other add-ons. This means that if you install this repository, you will always automatically receive the newest and freshest development updates of Rapier. You will still automatically get the official updates.

To install this repository, you must do so by following these steps:
# [https://github.com/gade01/repository.gade/raw/master/leia/repository.gade/repository.gade-2.1.1.zip Download the zip file containing Gade's Add-on Repository from Github]
# Start Kodi
# Navigate to Settings
# Add-ons
# Install from zip file
# Locate the zip file you downloaded
# Install

Recommended Kodi settings:
* ''Settings > System > Add-ons > Updates'':
:- Install updates automatically
* ''Settings > System > Add-ons > Unknown sources'':
:- Enabled
* ''Settings > System > Add-ons > Update official add-ons from (Kodi 19 Matrix only)'':
:- Any repositories

After this, you will automatically receive the latest development versions directly within Kodi.
<section end=DevelopmentVersion/>

== Required add-ons ==
<section begin=RequiredAdd-ons/>To get the most out of Rapier the following add-ons are required - they should be installed automatically when installing the skin. If this is not the case, please install using the XBMC Add-on Manager or manually using the links below. Certain skin features will not be available if one or more of these add-ons are not installed on your system.

* [[Add-on:Favourites_script|Favourites]]
* [[forum:345471|Embuary Helper]] ''(Added from Rapier 12 / Kodi 19!)''
* [[forum:235676|Skin Helper Service]] ''(Moved to Supported Add-ons from Rapier 12 / Kodi 19!)''
* [https://github.com/marcelveldt/script.skin.helper.widgets Skin Helper Widgets] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[Add-on:TV_Show_-_Next_Aired|TV Show Next Aired]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [http://mirrors.kodi.tv/addons/jarvis/resource.images.studios.white/ White Studio Icons add-on]
<section end=RequiredAdd-ons/>

== Supported add-ons (Kodi Add-on Repository Installation) ==
<section begin=SupportedAdd-ons1/>The following add-ons are supported by Rapier. They can be installed using the Kodi Add-on Manager or manually using the links below.

* [[Add-on:Rapier_UI_Sounds|Rapier UI Sounds]]
* [[forum:235676|Skin Helper Service]] ''(Moved to Supported Add-ons from Rapier 12 / Kodi 19!)''
* [[Add-on:Artist_Slideshow|Artist Slideshow]]
* Artwork Downloader ''(Support removed from Rapier 12 / Kodi 19!)''
* [[Add-on:Global_Search|Global Search]]
* [[forum:345847|TheMovieDb Helper]] ''(Added from Kodi 19 / Rapier 12)''
* [https://github.com/marcelveldt/script.skin.helper.backgrounds Skin Helper Backgrounds] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[Add-on:Random_and_Last_items_script|Random and Last items]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:239558|Image Resource Selection script]]
* [[Add-on:CU_LRC_Lyrics|CU LRC Lyrics]]
* CDArt Manager ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:335425|Weatherbit IO]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:352028|Multi Weather]] ''(Added from Rapier 12 / Kodi 19)''
* [[Add-on:ExtendedInfo_Script|ExtendedInfo Script]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [https://github.com/marcelveldt/script.skin.helper.skinbackup Skin Helper Skinbackup]
* [[forum:336747|Up Next]]
* [[Add-on:Embuary_Info|Embuary Info]] ''(Added from Rapier 12 / Kodi 19)''
* [[forum:231881|CinemaVision]]
* [[forum:224512|User Rating Script]]
* [https://github.com/phil65/script.module.t9.search T9 Search Script]
* [[forum:224512|Library Node Editor]]
* [[forum:200081|Audio Profiles]]
* [https://github.com/phil65/plugin.program.autocompletion Autocompletion for virtual keyboard]
* [[Add-on:Special_Features|Special Features]]
* ''Image resource genre icons, weather icons and genre fanart, weather fanart add-ons...''
<section end=SupportedAdd-ons1/>

== Supported add-ons (Manual Installation) ==
<section begin=SupportedAdd-ons2/>The following add-ons are supported by Rapier. They can be installed manually using the links below.

* [[forum:329767|Netflix Add-on]]
* [[forum:258886|Artwork Beef]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:133905|MyPicsDB]]
* [[forum:167754|IMDB Update]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:158775|Library Editor]]
* [https://github.com/phil65/script.youtube.browser Script.youtube.browser] ''(Support removed from Rapier 12 / Kodi 19!)''
<section end=SupportedAdd-ons2/>

== Special skin features ==
<section begin=Skin features/>{{Skin features
| skin = [[Add-on:Rapier|Rapier]]
| custom home items = {{yes}}
| custom submenu items = {{yes}}
| Media flags = {{yes}}
| TV show logo = {{yes}}
| TV logo downloader = {{yes}}
| Artwork downloader = {{yes}}
| Clear Art = {{yes}}
| cdArt = {{yes}}
| Extra fanart = {{yes}}
| Season fanart = {{no}}
| Weather fanart = {{yes}}
| Live TV = {{yes}}
| Next Aired = {{yes}}
| TvTunes = {{yes}}
| Advanced Launcher = {{no}}
| Watchlist = {{yes}}
| MovieSets = {{yes}}
| Metadata Actors = {{yes}}
| Cinema Experience = {{yes}}
| Touch = {{yes}}
| PVR = {{yes}}
| Skin Widgets = {{yes}}
| Intro movie = {{yes}}
| Random And Last Items = {{yes}}
}}
* '''All of the above mentioned add-ons'''
* '''[[Custom home items]]'''
* '''Movie, tv show and music video clear logos and clear art'''
* '''Music clear logos and cd art'''
* '''[[Artwork|Extra fanart]]'''
* '''Touch support'''
* '''Splash screen (video, audio or image)'''
* '''[[PVR|PVR & Live TV/Radio]]'''
* '''Audio DSP support including all Audio DSP add-ons.'''
* '''Games support'''
<section end=Skin features/>

== Screenshots ==
<section begin="screenshots"/>
<gallery caption="Screenshots" widths=200px heights=113px>
File:Rapier_new_home_movies.png|Home screen Movies without widgets
File:skin.rapier_new_home_movies_widgets.jpg|Home screen Movies with widgets
File:Rapier02.jpg|Movies Thumbnail View
File:Rapier03.jpg|Movies Wrap Info View
File:Rapier04.jpg|Movies List Info 2 View
File:Rapier05.jpg|Movies Wall View
File:skin.rapier.16.png|Movies 3D Wrap View
File:Rapier_movie_genres.png|Movie Genres Extended List View
File:Rapier_new_tvshows.jpg|Home screen TV Shows with widgets
File:Rapier07.jpg|TV Shows Thumbs Info View (clear logo)
File:Rapier08.jpg|TV Shows Thumbs Info View (banners)
File:Rapier10.jpg|Movies Icon View (clear logo)
File:skin.rapier_fullscreen_video.jpg|Paused fullscreen video
File:Rapier_new_videos.jpg|Home screen Videos with add-on shortcuts
File:Rapier13.jpg|Music Albums List View
File:Rapier14.png|Music playing visualization 1
File:Skin.rapier fullscreen music.jpg|Music playing visualization 2
File:skin.rapier_custom_addons.png|Custom add-ons manager window
</gallery>
<section end="screenshots"/>

== Videos ==
=== Kodi 15.x - Rapier Demo ===
{{youtube|CZQWrJYgTa0}}
=== Kodi / Rapier Splash Video ===
{{youtube|G-l_tIKgbzE}}
=== Video lyrics for fullscreen music playback in Rapier ===
{{youtube|O0TqCmvIRJ8}}

== Tips and guides ==
=== Creating a custom category ===
:This is a step-by-step guide to adding a custom category. Up to 16 custom categories are available.
::1. Go to Skin Settings > Home > Category Menu
::2. Click "Add more categories"
::3. Click "Category 1-4" to activate custom category 1-4, "Category 5-8" to activate custom category 5-8, "Category 9-12" to activate custom category 9-12 or "Category 13-16" to activate custom category 13-16
::4. Choose between adding a custom category from one of your Favourites or from a built in skin preset.
::5. "Path":
:::*If you have chosen adding a custom category from a Favourite, a dialog will open up with all your favourites. You can add almost any item within Kodi to your Favourites using the context menu.
:::*If you have chosen adding a custom category from a built in skin preset, the presets dialog will open up. This allows you to choose any item in the sections or to enter a custom action yourself (bottom left item).
::6. "Name":
:::Enter a name for your custom category. If no name is entered, "Custom X" (where X is the custom category number) will be used.
::::If navigation buttons are disabled, it's recommended to use 11 characters or less for best results.
::::If navigation buttons are enabled, it's recommended to use 10 characters or less for best results.
::7. You can choose a category icon from any location on your system.
::8. You can add up to 6 add-on shortcuts.
::::''Added from Rapier 12 / Kodi 19''
::::Choose between any add-on.
::::Selecting an add-on shortcut will disable the category icon for the chosen category.
::9. You can choose a widget. Adding a widget brings up a dialog:
:::*Movies, tv shows, music videos or albums will display recently added and in progress/featured items from your library.
:::*Add-ons will display random add-ons.
:::*Games will display all game add-ons.
:::*Playlist (movies, episodes or music) will display recently added and featured items from your selected playlist (useful when the custom category is a playlist from your favourites).
:::*In Cinemas / Upcoming Movies, Top Rated Movies / Top Rated TV Shows, Trending Movies / TV Shows will use the add-on script.extendedinfo to fill the widgets.
:::*Favourite ''(added from Rapier 12 / Kodi 19)'' will bring up a dialog to choose a custom top widget and a custom bottom widget using your favourites. You can choose either one, as both are not required. You can set the name and choose aspect (poster, wide or square) individually for both widgets.
:::*Custom ''(script.skinshortcuts required)'' will bring up a dialog to choose a custom top widget and a custom bottom widget. You can choose either one, as both are not required. You can set the name and choose aspect (poster, wide or square) individually for both widgets.
::10. You can choose between 3 background options for your custom category.
:::*"Single image" will open up a dialog, where you can choose any image on your system as background for your custom category.
:::*"Multi image" will open up a dialog, where you can choose any folder with images on your system as multi backgrounds for your custom category.
:::*"Fanart" will open up a dialog, where you can choose one of the built in fanart options as background for your custom category.
:::The button below will display the chosen background option and the image to the left will display the image(s).

=== Adding, removing or editing submenus ===
:This is a step-by-step guide to adding, removing or editing submenus. You can add up to 7 submenus for each category.
::*Go to Skin Settings > Home > Category Submenu.
:::All of your enabled categories are displayed here: Music / Videos / Movies / TV Shows / Add-ons / Pictures / General / System / Live TV / Weather / Custom Category 1-16
:::Clicking any of them allows you to add, remove or edit the submenus.
::*To '''remove''' an existing hardcoded submenu from the Music / Videos / Movies / TV Shows / Add-ons / Pictures / General / System / Live TV / Weather categories:
:::Enabling Button 1 and leaving everything else blank, will disable the existing submenu 1 for the chosen category and so on. Do this for all the submenu items you wish to remove.
::*To '''edit''' any submenu item for a category:
:::Enabling Button 1 and entering all the necessary information, will replace submenu 1 for the chosen category and so on. Do this for all the submenu items you wish to edit.
::::1. Click Button 1 to 7 to edit the submenu item you wish.
::::2. Choose between editing a submenu item using one of your Favourites, a built in skin preset, a script or an add-on.
::::3. "Path":
:::::If you have chosen editing a submenu item using one of your Favourites, a dialog will open up with all your favourites. You can add almost any item within Kodi to your Favourites using the context menu.
:::::If you have chosen editing a submenu item using a built in skin preset, the presets dialog will open up. This allows you to choose any item in the sections or to enter a custom action yourself (bottom left item).
:::::If you have chosen editing a submenu item using a script, a dialog will open up where you can select one of the scripts.
:::::If you have chosen editing a submenu item using an add-on, a dialog will open up where you can select one of the add-ons.
::::4. "Label" allows you to enter the name of the submenu.
::*To '''add''' a submenu item for any category:
:::You can add additional submenus to a category with less than 7 submenu items: eg. if a category has 4 submenus, you can enable Button 5, 6 and 7 to add 3 additional custom submenus.
::::1. Click Button 1 to 7 to add the submenu item you wish.
::::2. Choose between adding a submenu item from one of your Favourites, a built in skin preset, a script or an add-on.
::::3. "Path":
:::::If you have chosen adding a submenu item from a Favourite, a dialog will open up with all your favourites. You can add almost any item within Kodi to your Favourites using the context menu.
:::::If you have chosen adding a submenu item from a built in skin preset, the presets dialog will open up. This allows you to choose any item in the sections or to enter a custom action yourself (bottom left item).
:::::If you have chosen adding a submenu item from a script, a dialog will open up where you can select one of the scripts.
:::::If you have chosen adding a submenu item from an add-on, a dialog will open up where you can select one of the add-ons.
::::4. "Label" allows you to enter the name of the submenu.

=== Proper naming of files ===
:Rapier reads all file names.
:If you use some of the below tags in the file name, additional media flags are displayed automatically.
::* "bluray" / "blu-ray" / "bdrip" / "brrip" / "bdremux" / "bd25" / "bd50": displays a Blu-ray logo
::* "web-dl" / "web-download" / "webrip": displays a web-dl logo
::* ".3d." / "hsbs" / "sbs" / "half-sbs": displays a 3D logo
:::The stereoscopic mode can also be automatically detected by Kodi, so you might see this logo without the tags in the file name.
::* "hddvd" / "hd-dvd": displays a HD-DVD logo
::* "dvd" / "dvdrip": displays a DVD logo
:::The DVD logo will also be displayed if the file extension is: .img / .ifo / .vob
::* "hdtv": displays a HD TV logo
::* "sdtv" / "pdtv": displays a SD TV logo
::* "vhs": displays a VHS logo
::* ".atmos": if your file contains either TrueHD or E-AC3 (Dolby Digital Plus) audio, a Dolby Atmos logo will display
::* "dtsx" / "dts-x": if your file contains DTS-HD Master Audio, a DTS:X logo will display
::* "dtses" / "dts-es": if your file contains DTS Audio, a DTS-ES logo will display
::* ".bdxl" / "bd66" / "bd100": displays an Ultra-HD Blu-ray logo
::* ".unrated": displays an "Unrated" media flag
::* "missingvideo" or "Missingvideo" will grey out a missing movie or episode. [[Add-on:Rapier#Using_the_missing_movie_or_episode_feature|Click here for details.]]

=== Using the missing movie or episode feature ===
:''Added from Rapier 12 / Kodi 19''
:You can add the missing movies for a movie set and missing episodes for tv shows. They will be greyed out in the listing, so it's easy to see which ones are missing.
::''What is required for missing movies:''
:::*Use any video file in any format (the smaller size, the better).
:::*Create a movie folder for the missing movie (like you normally do for movies)
:::*Name the file anything and add "Missingvideo" or "missingvideo" anywhere in the filename.
::::- Eg. "Star.Wars.The.Rise.of.Skywalker.2019.missingvideo.mp4"
:::*Scrape the movie into your library and you're done.
::''What is required for episodes:''
:::*Use any video file in any format (the smaller size, the better).
:::*Place the file in your tv show folder and give it the appropiate episode number and name.
:::*Add "Missingvideo" or "missingvideo" anywhere in the filename.
::::- Eg. "Simpsons.S20E18.missingvideo.mp4"
:::*Scrape the episode into your library and you're done.

=== Missing tv show clear logos in the TV Shows Today widget in the home screen ===
:Go to Skin Settings -> Add-ons -> Artwork Downloader -> Download Presets - TV Shows -> Click the Clear Logo button and wait for the script to finish. This should add all clear logos for the tv shows to your library. You can do this with clear art as well if you wish.

=== Missing Upcoming TV Shows widget ===
:If you don't see the Upcoming TV Shows widget on the home screen, you probably need to enable it in the Tv Show - Next Aired add-on settings.
::* Go to Add-ons > My Add-ons > Program Add-ons > TV Show - Next Aired > Settings
::* ENABLE the setting "Show all tv shows for home screen (needs skin support)"
::* Restart Kodi

=== ExtendedInfo (using script.extendedinfo) for movie/tv show cast/crew members ===
:To activate ExtendedInfo for movie/tv show cast members, press down from the selected cast member in the video information window.
:You can click any director/writer throughout the skin to activate ExtendedInfo.

=== Mouse / touch device support ===
:Mouse and touch devices are indeed supported by this skin.
:To make the most of your experience, make sure these skin settings are set:
::*Skin Settings > General > Hide dialog close buttons > DISABLED
::*Skin Settings > General > Hide top options menu bar (only show when selected) > DISABLED
::*Skin Settings > General > Hide top bar when idle > DISABLED
::*Skin Settings > Home > Show navigation buttons > ENABLED

=== Low powered devices ===
:Rapier can be a bit rough on lower powered devices. Especially entering libraries for the first time after launch can take a while.
:Several skin settings have been made to improve performance:
::*Skin Settings > General > Enable low CPU power mode
:::''When enabled, you can choose between these two options:''
:::1. Disable animations only. Selecting this option will disable selected animations.
:::2. Disable animations and CPU demanding skin settings. Selecting this option will disable selected animations AND these CPU demanding skin settings:
::::* Video playing in the background
::::* Play trailers in a window
::::* Music CD art
::::* Animated backgrounds and fanart (both music and video)
::::* Music visualization and artist fanart in the background (when playing music)
::::* Fanart slideshow using script.artistslideshow (when playing music)
::*Skin Settings > Views
:::Here you can disable '''all''' view types you don't use in all windows and sections of Kodi.
:::TIP: Disabling '''every single''' view type you don't use will significantly speed up load times when entering windows and libraries.

== Skin Settings ==
Rapier is highly customizable and has a great deal of skin settings. This section details all the skin settings options for Rapier.
=== General ===
:'''GENERAL'''
::'''Enable kiosk mode'''
:::Once you've got everything set up the way you want, you can enable "kiosk mode" to lock your chosen views and hide selected buttons / functions.
::'''Enable low CPU power mode'''
:::This setting might improve performance on lower powered systems.
::::''When enabled, you can choose between these two options:''
::::* Disable animations only. Selecting this option will disable selected animations.
::::* Disable animations and CPU demanding skin settings. Selecting this option will disable selected animations AND these CPU demanding skin settings:
:::::* Video playing in the background
:::::* Play trailers in a window
:::::* Music CD art
:::::* Animated backgrounds and fanart (both music and video)
:::::* Music visualization and artist fanart in the background (when playing music)
:::::* Fanart slideshow using script.artistslideshow (when playing music)
::'''Hide dialog close buttons'''
:::Hides the dialog close buttons on all dialogs. Dialog close buttons are very useful when using a mouse or touch device.
::'''Hide date'''
:::Hides the date in the top status bar.
::'''Date format'''
:::Choose the date format according to your region: UK / Australia / Central Europa / India or USA / Canada.
::'''Hide top options menu bar (only show when selected)'''
:::This will permanently show the menu bar in the library or hide it. If you choose to hide it, it will only be visible when focused.
::'''Hide top bar when idle'''
:::''This setting is only enabled when the setting "Hide top options menu bar" above is enabled.''
:::This will hide the top bar, when the system has been left idle for 3 seconds. The top bar will still be visible, when the top options menu bar is visible.
::'''Use scrollbar / Use quick jump'''
:::''This setting requires [[Add-on:Skin_Helper_Service|script.skin.helper.service]].''
:::Use scrollbar: Choose this to enable scrollbars throughout the skin.
:::Use quick jump: Choose this to enable quick jump alphabet navigation wherever possible.
::'''Enable battery notification'''
:::If you enable this option, a battery notification will be displayed in the top status bar. This will only be visible when using a battery powered device.
::'''Enable autocompletions for keyboard dialog'''
:::''This setting requires [[Add-on:ExtendedInfo_Script|script.extendedinfo]].''
:::This setting enables autocompletions by Google or Youtube for the keyboard dialog in Kodi. They show up as up to 9 clickable suggestions below the actual keyboard.
:'''STARTUP'''
:::''Rapier 11 / Kodi 18 Leia only: This section requires [[Add-on:Skin_Helper_Service|script.skin.helper.service]].''
:::''Rapier 12 / Kodi 19 Matrix has built in support for this feature.''
::'''Enable splash screen (photo, video or music)'''
:::This allows you to enable the setting and choose a video, image or piece of music to play as a splash screen when Kodi starts up.
::'''File'''
:::''Added from Rapier 12 / Kodi 19 Matrix''
:::This allows you to choose a video, image or piece of music to play as a splash screen when Kodi starts up.
::'''Splash screen image duration'''
:::''This button is only visible if an image is chosen as splash screen.''
:::Pressing this button brings up a numeric dialog where you can set the amount of time the image is displayed. Defaults to 5 seconds.
::'''Preview'''
:::''This button is only visible if splash screen is enabled.''
:::Pressing this button will preview your chosen media.

=== Home ===
:'''HOME'''
::'''Show navigation buttons'''
:::This will display navigation buttons in each side of the category menu and can be very useful to mouse or touch device users.
::'''Enable music playing progressbar'''
:::When playing music and leaving the system idle for 5 seconds, the category section will turn into a progressbar.
:'''CATEGORY MENU'''
::'''Use white / coloured categories'''
:::Toggle this button to switch between white and coloured home screen category names. The coloured categories will follow the chosen theme - blue, red or orange.
::'''Change category actions'''
:::Here you can change the functions of all main home screen categories. Clicking a category name will open up a dialog.
:::Full support for all library nodes.
::'''Hide categories'''
:::Select to hide main categories: Music, Videos, Movies, TV Shows, Add-ons, Pictures, General, System, TV, Radio, Weather, Power.
::'''Add more categories'''
:::Add up to 16 custom categories to the home screen and choose between any favourite (add-ons, playlists, paths etc.) or a built-in skin preset. You can choose your own icon, category image (name of the category), background and add a custom widget.
:::''[[Add-on:Rapier#Creating_a_custom_category|Click here for a detailed guide on creating a custom category.]]''
::'''Reorder categories'''
:::Use this menu to completely reorder all home screen categories.
:::Category 1 will be the startup category when launching Kodi.
:::''Please make sure all categories are used, or you will end up missing categories!''
:'''CATEGORY SUBMENU'''
::'''Hide submenus'''
:::Hides all submenus.
::'''Music / Videos / Movies / TV Shows / Programs / Add-ons / Games / Pictures / General / System / Live TV / Weather / Custom Category 1-16'''
:::You can remove, edit or create up to 7 custom submenus for each category using any favourite (add-ons, playlists, paths etc.), built-in skin preset, script or plugin. This is very useful in a lot of different ways.
:::''[[Add-on:Rapier#Adding.2C_removing_or_editing_submenus|Click here for a detailed guide on adding, removing or editing a submenu item.]]''
:'''CATEGORY ICON'''
::'''Hide category icons'''
:::Hides all category icons.
::'''Custom category icon'''
:::Select a custom category icon for the main categories.
:'''INFO PANEL'''
::'''Hide now playing'''
:::When playing music or video, Rapier will display a Now Playing widget. This setting allows you to hide the widget.
::'''Hide recently added'''
:::Hide the Recently Added widget. Enabling this will also hide the In Progress widget.
::'''Hide "in progress" / random'''
:::Enabling this option will hide the In Progress widget.
::'''Hide in cinemas / upcoming movies'''
:::''Requires the add-on [[Add-on:ExtendedInfo_Script|script.extendedinfo]] (minimum version 3.0.0)''
:::Enabling this option will hide the In Cinemas / Upcoming Movies widget for the movie category.
::'''Hide tv show next aired'''
:::Enabling this option will hide the TV Show Next Aired widget for the tv shows category.
::'''Hide videos'''
:::Enabling this option will hide the video widget for the Videos category.
::'''Hide Add-ons'''
:::Enabling this option will hide the Add-on widgets for the Add-ons category.
::'''Hide Games'''
:::Enabling this option will hide the Games widget for the Games category.
::'''Hide favourites'''
:::Enabling this option will hide the favourites widget for the general category. If the weather category is disabled, the weather widget is displayed for the general category instead.
::'''Hide weather'''
:::Enabling this option will hide the weather widget for the weather category.
::'''Hide PVR channels'''
:::Enabling this option will hide the PVR channels / recordings widgets for the TV / Radio category.
::'''Hide recording information'''
:::Enabling this option will hide the recording information widgets when recording tv / radio.
::'''Hide system information'''
:::Enabling this option will hide the system information widget for the system category.
:'''ADD-ON SHORTCUTS'''
::'''Enable add-on shortcut titles'''
:::Enabling this option will display add-on titles for each of the add-on shortcuts.
::'''Videos / Movies / TV Shows / Music / Pictures / Programs / Add-ons / General'''
:::Select up to 6 add-on shortcuts for each category. Selecting an add-on shortcut will disable the category icon for the chosen category.

=== Media ===
:'''GENERAL'''
::'''Select rating'''
:::This will open a dialog to select if the ratings used in media windows are the default ratings or user ratings ("My rating").
:'''VIDEOS'''
::'''Play trailers in a window (video information window)'''
:::This will play trailers in windowed mode in the video information window only.
::'''Right clicking scrollbar plays trailer'''
:::This setting will disable the playback of trailers when moving right or down from a scrollbar inside the video libraries.
::'''Use alternative duration'''
:::By default Kodi displays duration of videos in minutes (eg. 112 minutes). Enabling this setting will display the duration in hours and minutes (eg. 1h52).
::'''Select movie genre icon pack'''
:::This setting allows you to select an image resource add-on genre pack to use with the skin. I recommend installing Xzener's Reflected Icons.
:::Defaults to use the skin.rapier/extras/moviegenres/ folder for manually adding images if no image resource add-on is selected.
:'''VIDEO PLAYING'''
::'''Enable video playing in the background'''
:::When playing video, this setting will enable the video playing in the background throughout the skin.
:'''FULLSCREEN VIDEO'''
::'''Hide seekbar OSD during fullscreen playback'''
:::Hides the seekbar when playing fullscreen audio or video.
::'''Show information when paused'''
:::Shows the information dialog, when video is paused.
::'''Automatically close OSD'''
:::''Added from Kodi 20 / Rapier 13.''
:::This will automatically close the OSD, when the system has been idle for x seconds.
::'''OSD autoclose time (seconds)'''
:::''Added from Kodi 20 / Rapier 13.''
:::This is the time in seconds before the OSD will automatically close, when the system is idle.
:::Defaults to 4 seconds.
::'''Show clear art on OSD'''
:::Displays clear art images on the OSD when playing movies or tv show episodes. If no clear art is available, a clear logo will be displayed. If no clear logo is available, the cover image will be displayed. Clear art and clear logos require the add-on Artwork Downloader. You can either run Artwork Downloader in the background using the add-on's settings, manually download the artwork in the movie or tv show library or download using Rapier's Add-ons skin settings section.
::'''Show clear logo on OSD'''
:::Displays clear logo images on the OSD when playing movies or tv show episodes. If no clear logo is available, the cover image will be displayed. Clear logos require the add-on Artwork Downloader. You can either run Artwork Downloader in the background using the add-on's settings, manually download the artwork in the movie or tv show library or download using Rapier's Add-ons skin settings section.
::'''Show "Paused" in fullscreen video'''
:::When pausing fullscreen video, this setting will dim the screen slighly and display a "Paused" label.
:'''TV SHOWS'''
::'''Use banner / poster layout'''
:::Choose between displaying tv show poster or banner images throughout the skin.
:'''TV / RADIO'''
:::''This section will only be visible if live tv / PVR is enabled.''
::'''Select multi image path for tv channels / recordings'''
:::Use this option to select a folder of images (or a folder with a single image) to be used in the tv channels / recordings view.
:::If no folder is selected, the default images will be used.
::'''Select multi image path for radio channels / recordings'''
:::Use this option to select a folder of images (or a folder with a single image) to be used in the radio channels / recordings view.
:::If no folder is selected, the default images will be used.
:'''MUSIC'''
::'''Enable music CD art'''
:::Enabling this will display CD Art images throughout the skin when playing music. This requires either the add-on CDArt Manager and/or manually adding cdart.png images to your music library folders.
::'''Select music library path for clear logos'''
:::Enter the path to your music library if you wish to enable clear logos in your Kodi music library.
:::''Leaving this blank will disable clear logos in the music library.''
::'''Select music genre icon pack'''
:::This setting allows you to select an image resource add-on genre pack to use with the skin. I recommend installing Music Genre Icons - Text.
:::Defaults to use the skin.rapier/extras/musicgenres/ folder for manually adding images if no image resource add-on is selected.
:'''MUSIC PLAYING'''
::'''Enable fullscreen window when starting music'''
:::''Removed from Kodi 19 / Rapier 12. Go to "Settings > Media > Music > Switch to visualization on playback" instead.''
:::Enabling this setting will immediately open up the fullscreen music window when music playback is started.
::'''Enable music visualization / artist fanart in the background'''
:::Enable this setting to display music visualization or artist fanart in the background throughout the skin when playing music.
::'''Choose background'''
:::Clicking this button will open up a dialog, where you can choose between these background options throughout the skin:
:::* Use only visualization for background
:::* Use only artist fanart for background
:::* Use both music visualization and artist fanart for background
::'''Fanart slideshow'''
:::Enabling this will display an artist slideshow in the background when playing music.
:::This setting requires the add-on [[Add-on:Artist_Slideshow|Artist Slideshow]] and the skin setting "Use only artist fanart for background" or "Use both music visualization and artist fanart for background".
::'''Animate fanart backgrounds'''
:::Enabling this will animate the fanart in the background throughout the skin when music is playing.
:::This requires the skin setting "Use only artist fanart for background" or "Use both music visualization and artist fanart for background".
:'''FULLSCREEN MUSIC'''
::'''Show CD art and info in fullscreen music playback'''
:::Enabling this will display CD Art images in the music visualization when playing music. This requires either the add-on CDArt Manager and/or manually adding cdart.png images to your music library folders.
::'''Show "Paused" in fullscreen music'''
:::When pausing fullscreen music, this setting will dim the screen slighly and display a "Paused" label.
::'''Lyrics add-on'''
:::''Added from Rapier 12 / Kodi 19''
:::Select your preferred lyrics add-on to use in the music visualization window.
::'''Lyrics settings'''
:::''Added from Rapier 12 / Kodi 19''
:::This will open the settings dialog for the selected lyrics add-on.
::'''Enable video lyrics'''
:::''Requires the add-on [[Add-on:CU_LRC_Lyrics|CU LRC Lyrics]]''
:::During fullscreen music playback, this will enable music video style animated lyrics in sync with the music playing.
:::''[[Add-on:Rapier#Video_lyrics_for_fullscreen_music_playback_in_Rapier|Watch the video demo above.]]''
::'''Automatically close OSD'''
:::''Added from Kodi 20 / Rapier 13.''
:::This will automatically close the OSD, when the system has been idle for x seconds.
::'''OSD autoclose time (seconds)'''
:::''Added from Kodi 20 / Rapier 13.''
:::This is the time in seconds before the OSD will automatically close, when the system is idle.
:::Defaults to 4 seconds.
:'''PICTURES'''
::'''Show "Paused" in picture slideshow'''
:::When pausing a fullscreen picture slideshow, this setting will display the current time and a "Paused" label.
:'''MEDIA FLAGGING'''
::'''Enable media flags ''(Enabling all media flags may break the layout)'''
:::This setting will enable or disable all media flags.
::'''Use default theme colour / Use white theme colour'''
:::Choose between blue (default) or white media flags.
::'''Hide video resolution'''
:::This setting will hide the video resolution media flags.
::'''Hide aspect ratio'''
:::This setting will hide the aspect ratio media flags.
::'''Hide rating
:::This setting will hide the rating media flags.
::'''Hide subtitle count'''
:::Enabling this setting will display a media flag with the number of subtitles available.
::'''Hide audio language count'''
:::Enabling this setting will display a media flag with the number of audio languages available.
::'''Hide Next Aired'''
:::''Requires installation of the add-on [[Add-on:TV_Show_-_Next_Aired|TV Show Next Aired]]''
:::This setting will hide the tv show status media flag in the tv show and season library.

=== Views ===
:'''VIDEOS / MOVIES / TV SHOWS / EPISODES / MUSIC / MUSIC VIDEOS / PICTURES / ADD-ONS / PROGRAMS / MISCELLANEOUS
:::Here you can disable all view types you don't use in all windows and sections of Kodi.
:::TIP: Disabling '''every single''' view type you don't use will significantly speed up load times when entering windows and libraries.

=== Configure Menus ===
:'''CONFIGURE MENUS'''
::'''Shutdown Menu'''
:::Here you can enable/disable shutdown menu items. The items are enabled according to your hardware specifications.
::'''Context Menu'''
:::Here you can enable/disable context menu items. Most items requires add-ons. If a required add-on is not installed, clicking an item will prompt you to install it.

=== Weather ===
:'''WEATHER'''
::'''Enable weather'''
:::''Removed from Rapier 12 / Kodi 19''
:::This will enable or disable the weather notification in the top status bar.
::'''Weather add-on'''
:::''Added from Rapier 12 / Kodi 19''
:::If a weather add-on is installed and enabled, the add-on name will display here.
:::If a weather add-on is not installed or disabled, you will be redirected to the weather settings window.
::'''Weather add-on settings'''
:::''Added from Rapier 12 / Kodi 19''
:::This will open the settings dialog for the selected weather add-on.
::'''Show in home window only / Show in all windows'''
:::This will either display the weather notification in the home window only or in all windows.
::'''Select weather icon pack'''
:::This setting allows you to select an image resource add-on weather icons pack to use with the skin.
:::Defaults to Kodi's default weather icons if no image resource add-on is selected.

=== Backgrounds ===
:'''BACKGROUNDS'''
::'''Fanart brightness - low / medium'''
:::Opens up a dialog to select the fanart background brightness on a 0-100% scale. Default is 30%.
::'''Animate custom backgrounds'''
:::Enable this setting to animate the custom backgrounds.
::'''Animate fanart backgrounds'''
:::Enable this setting to animate the fanart backgrounds.
::'''Time per Image for fanart backgrounds'''
:::''Removed from Rapier 12 / Kodi 19.
:::''This setting is only visible if the add-on [https://github.com/marcelveldt/script.skin.helper.backgrounds Skin Helper Backgrounds] is installed.
:::''This setting is only enabled if fanart backgrounds have been selected for either the music, videos, movies, tv shows or pvr sections.
:::Clicking this button will bring up a numeric dialog. Use this to set the time in seconds each fanart image is shown. Defaults to 8 seconds.
::'''Select movie / tv show genre background pack'''
:::Select a genre background image pack to be used in the movies and tv shows genre node.
::'''Select music / music video genre background pack'''
:::Select a genre background image pack to be used in the music and music videos genre node.
:'''WIDGETS'''
::'''Hide all widget backgrounds'''
:::Enabling this will hide the backgrounds for all home screen widgets, when they are focused.
:'''CUSTOM BACKGROUNDS'''
::'''Global'''
:::Choose a custom single image or multi images to use globally throughout the skin. You can set the background brightness from 0-100%.
::'''Music / Videos / Movies / TV Shows / Add-ons ''(from Rapier 12 / Kodi 19)'' '''
:::For the music, videos, movies, tv shows and add-ons ''(from Rapier 12 / Kodi 19)'' sections, you can choose between four background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Fanart images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin. Select to display either random, recent, in progress or unwatched fanart images (all options will not be available for every category).
::'''TV / Radio'''
:::For the tv and radio sections, you can choose between four background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Random fanart images ''(Removed from Rapier 12 / Kodi 19)''. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::'''Pictures'''
:::For the pictures section, you can choose between five background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Latest images from your library. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin. This setting requires the add-on [[forum:133905|MyPicsDB]].
::::* Random images from your library. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin. This setting requires the add-on [[forum:133905|MyPicsDB]].
::'''Add-ons (Rapier 11 / Kodi 18 and below) / Games / General / System / Power'''
:::For the programs, add-ons, games, general, system and power sections, you can choose between three background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::'''Weather'''
:::For the weather section, you can choose between 5 background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Weather condition backgrounds. Select the path to your weather fanart folder. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Condition (Add-on). This setting allows you to select an image resource add-on weather fanart pack.

=== Add-ons ===
::'''''NOTE: Category completely removed from Rapier 12 / Kodi 19'''''
:'''LYRICS'''
::'''Path'''
:::Select your preferred lyrics add-on to use in the music visualization window.
::'''Lyrics settings'''
:::This will open the settings dialog for the selected lyrics add-on.
:'''ARTWORK DOWNLOADER'''
::'''Settings'''
:::This will open the settings dialog for the Artwork Downloader add-on.
::'''Download according to add-on settings'''
:::This will download all artwork specified in the Artwork Downloader settings.
::'''Download presets - movies'''
:::Hide or show all the settings for the movie artwork downloads.
::'''All'''
:::Download all movie artwork: poster, fanart, extra fanart, extra thumbs, thumbnail 16:9, clear art, clear logo. All artwork for every movie will be downloaded.
::'''Poster / Fanart / Extra fanart / Extra thumbs / Thumbnail 16:9 / Clear art / Clear logo'''
:::Download only the movie artwork specified. The selected artwork for all movies wil be downloaded.
::'''Download presets - tv shows'''
:::Hide or show all the settings for the tv shows artwork downloads.
::'''All'''
:::Download all tv show artwork: poster, season poster, banner, season banner, fanart, extra fanart, extra thumbs, clear art, clear logo, tv thumb 16:9. All artwork for every tv show will be downloaded.
::'''Poster / Season poster / Banner / Season banner / Fanart / Extra fanart / Extra thumbs / Clear art / Clear logo / TV thumb 16:9'''
:::Download only the tv show artwork specified. The selected artwork for all tv shows will be downloaded.
::'''Download presets - music videos'''
:::Hide or show all the settings for the music videos artwork downloads.
::'''All'''
:::Download all music video artwork: poster, fanart, extra fanart, clear art, clear logo. All artwork for every music video will be downloaded.
::'''Poster / Fanart / Extra fanart / Clear art / Clear logo'''
:::Download only the music video artwork specified. The selected artwork for all music videos will be downloaded.
:'''IMDB UPDATE'''
:::''This section will only be available of you have installed the add-on [http://forum.kodi.tv/showthread.php?tid=167754 IMDb Update] on your system.''
::'''Settings'''
:::This will open the settings dialog for the add-on [http://forum.kodi.tv/showthread.php?tid=167754 IMDb Update].
::'''Update IMDb movie rating'''
:::This will update the IMDb movie rating for all movies in your library.
::'''Update IMDb movie rating (hidden)'''
:::This will update the IMDb movie rating for all movies in your library. The service will run in the background.
::'''Update IMDb top 250'''
:::This will update the IMDb top 250 for all movies in your library.
::'''Update IMDb top 250 (hidden)'''
:::This will update the IMDb top 250 for all movies in your library. The service will run in the background.
::'''Update MPAA rating'''
:::This will update the MPAA rating for all movies in your library.
::'''Update MPAA rating (hidden)'''
:::This will update the MPAA rating for all movies in your library. The service will run in the background.
::'''Update All'''
:::This will update all options for this add-on.
::'''Update All (hidden)'''
:::This will update all options for this add-on. The service will run in the background.

=== Supported Add-ons ===
:::This section contains two sub sections:
::::*Automatic installation from Kodi add-on repository
:::::This is a list of add-ons from the official Kodi add-on repository supported by Rapier. Each add-on will display a description when focused.
::::::If an add-on is installed and enabled you will see the add-on version information. Clicking the add-on will open up the settings dialog.
::::::If an add-on is installed but disabled, clicking the item will prompt you to enable the add-on and guide you through the process. (Rapier 12 / Kodi 19 only)
::::::If an add-on is not installed, clicking the item will prompt you to install the add-on and guide you through the process.
::::*Manual installation
:::::This list of add-ons supported by Rapier is ''not'' in the official Kodi add-on repository. Each add-on will display a description when focused.
::::::If an add-on is installed and enabled you will see the add-on version information. Clicking the add-on will open up the settings dialog.
::::::If an add-on is installed but disabled, clicking the item will prompt you to enable the add-on and guide you through the process. (Rapier 12 / Kodi 19 only)
::::::If an add-on is not installed, clicking the item will display an error notification. You can only install these add-ons manually from zip.

=== Reset Skin / Skin Settings ===
:'''SKIN SETTINGS'''
::'''Reset skin settings to default (press to confirm).'''
:::This will reset all skin settings to default. You can NOT undo this action.
::'''Export skin settings'''
:::''Requires the add-on [https://github.com/marcelveldt/script.skin.helper.skinbackup Skin Helper Skinbackup]''
:::Exports all the Rapier skin settings to your selected location.
::'''Import skin settings.'''
:::''Requires the add-on [https://github.com/marcelveldt/script.skin.helper.skinbackup Skin Helper Skinbackup]''
:::Imports all the Rapier skin settings from your selected location.
:'''OTHER'''
::'''Reload skin'''
:::This will reload the skin and can be useful for reloading xml files, images, fonts and other changes.

== Translations ==
[https://www.transifex.com/teamxbmc/kodi-skins/skin-rapier/ Translations of the skin are handled on Transifex.]

Please take a moment to check if your language is up to date, and all strings are translated. You can help out by signing up on Transifex, join the project and translate the skin to your native language.

A huge thanks to all the translators for the great work - it's really appreciated!

== Development ==
You can follow the latest development on Github.
* [https://github.com/gade01/Rapier Rapier 12 - Kodi 19 Matrix]
* [https://github.com/gade01/Rapier/tree/Leia Rapier 11 - Kodi 18 Leia]
* [https://github.com/gade01/Rapier/tree/Krypton Rapier 10 - Kodi 17 Krypton] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Jarvis Rapier 9 - Kodi 16 Jarvis] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Isengard Rapier 8 - Kodi 15 Isengard] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Helix Rapier 7 - Kodi 14 Helix] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Gotham Rapier 6 - XBMC 13 Gotham] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Frodo Rapier 5 - XBMC 12 Frodo] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Eden Rapier 4 - XBMC 11 Eden] - DEPRECATED

== Changelogs ==
* [https://www.dropbox.com/s/dv4jk2fcudw3k4z/changelog.txt?dl=0 View changelog for Rapier 12 - Kodi 19 Matrix]
* [https://www.dropbox.com/s/mqyx0wy7tqchee0/changelog.txt?dl=0 View changelog for Rapier 11 - Kodi 18 Leia]
* [https://www.dropbox.com/s/fpr7kaqxwsk61sy/changelog.txt?dl=0 View changelog for Rapier 10 - Kodi 17 Krypton]
* [https://www.dropbox.com/s/niaeaddbfifk6s6/changelog.txt?dl=0 View changelog for Rapier 9 - Kodi 16 Jarvis]
* [https://www.dropbox.com/s/chwzv9mbctsrlip/changelog.txt?dl=0 View changelog for Rapier 8 - Kodi 15 Isengard]
* [https://www.dropbox.com/s/091grvjawrif5rw/changelog.txt?dl=0 View changelog for Rapier 7 - Kodi 14 Helix]
* [https://www.dropbox.com/s/oi0y8c80quyn93b/changelog.txt?dl=0 View changelog for Rapier 6 - XBMC 13 Gotham]
* [https://www.dropbox.com/s/5q4zvdig1y4u72t/changelog.txt?dl=0 View changelog for Rapier 5 - XBMC 12 Frodo]
* [https://raw.githubusercontent.com/gade01/Rapier/Eden/changelog.txt View changelog for Rapier 4.x - XBMC 11 Eden]

{{Compat
| Works with Atlantis = {{No}}
| Works with Babylon = {{No}}
| Works with Camelot = {{Yes}}
| Works with Dharma = {{Yes}}
| Works with Eden = {{Yes}}
| Works with Frodo = {{Yes}}
| Works with Gotham = {{Yes}}
| Works with Helix = {{Yes}}
| Works with Isengard = {{Yes}}
| Works with Jarvis = {{Yes}}
| Works with Krypton = {{Yes}}
| Works with Leia = {{Yes}}
| Works with Matrix = {{Yes}}
}}

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Skins]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Jarvis add-on repository]]
[[Category:Krypton add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]

Add-on:Rapier

2022-10-11T09:54:55Z

Gade: /* Media */

{{Addon
|Name=Rapier
|provider-name=Scarfa, Gade
|ID=skin.rapier
|latest-version=12.3.5
|extension point=xbmc.gui.skin
|provides=
|Summary=Rapier skin by Scarfa, Gade.
|Description=The goal is to provide a simple to use but clean and elegant interface that focuses on efficiency when browsing your media. Important considerations are put on usability, performance, and providing the user with flexibility when it comes to customization. Rapier tries to support all the latest features Kodi has to offer as long as it fits in with the skin's design goals.
|Platform=all
|Language=
|License=Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
|Forum=https://forum.kodi.tv/forumdisplay.php?fid=120
|Website=https://kodi.wiki/view/Add-on:Rapier
|Source=https://github.com/gade01/Rapier
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/skin.rapier/resources/icon.png}}

== Development version / Gade's Add-on Repository ==
<section begin=DevelopmentVersion/>I have created an add-on repository for Rapier and my other add-ons. This means that if you install this repository, you will always automatically receive the newest and freshest development updates of Rapier. You will still automatically get the official updates.

To install this repository, you must do so by following these steps:
# [https://github.com/gade01/repository.gade/raw/master/leia/repository.gade/repository.gade-2.1.1.zip Download the zip file containing Gade's Add-on Repository from Github]
# Start Kodi
# Navigate to Settings
# Add-ons
# Install from zip file
# Locate the zip file you downloaded
# Install

Recommended Kodi settings:
* ''Settings > System > Add-ons > Updates'':
:- Install updates automatically
* ''Settings > System > Add-ons > Unknown sources'':
:- Enabled
* ''Settings > System > Add-ons > Update official add-ons from (Kodi 19 Matrix only)'':
:- Any repositories

After this, you will automatically receive the latest development versions directly within Kodi.
<section end=DevelopmentVersion/>

== Required add-ons ==
<section begin=RequiredAdd-ons/>To get the most out of Rapier the following add-ons are required - they should be installed automatically when installing the skin. If this is not the case, please install using the XBMC Add-on Manager or manually using the links below. Certain skin features will not be available if one or more of these add-ons are not installed on your system.

* [[Add-on:Favourites_script|Favourites]]
* [[forum:345471|Embuary Helper]] ''(Added from Rapier 12 / Kodi 19!)''
* [[forum:235676|Skin Helper Service]] ''(Moved to Supported Add-ons from Rapier 12 / Kodi 19!)''
* [https://github.com/marcelveldt/script.skin.helper.widgets Skin Helper Widgets] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[Add-on:TV_Show_-_Next_Aired|TV Show Next Aired]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [http://mirrors.kodi.tv/addons/jarvis/resource.images.studios.white/ White Studio Icons add-on]
<section end=RequiredAdd-ons/>

== Supported add-ons (Kodi Add-on Repository Installation) ==
<section begin=SupportedAdd-ons1/>The following add-ons are supported by Rapier. They can be installed using the Kodi Add-on Manager or manually using the links below.

* [[Add-on:Rapier_UI_Sounds|Rapier UI Sounds]]
* [[forum:235676|Skin Helper Service]] ''(Moved to Supported Add-ons from Rapier 12 / Kodi 19!)''
* [[Add-on:Artist_Slideshow|Artist Slideshow]]
* Artwork Downloader ''(Support removed from Rapier 12 / Kodi 19!)''
* [[Add-on:Global_Search|Global Search]]
* [[forum:345847|TheMovieDb Helper]] ''(Added from Kodi 19 / Rapier 12)''
* [https://github.com/marcelveldt/script.skin.helper.backgrounds Skin Helper Backgrounds] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[Add-on:Random_and_Last_items_script|Random and Last items]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:239558|Image Resource Selection script]]
* [[Add-on:CU_LRC_Lyrics|CU LRC Lyrics]]
* CDArt Manager ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:335425|Weatherbit IO]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:352028|Multi Weather]] ''(Added from Rapier 12 / Kodi 19)''
* [[Add-on:ExtendedInfo_Script|ExtendedInfo Script]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [https://github.com/marcelveldt/script.skin.helper.skinbackup Skin Helper Skinbackup]
* [[forum:336747|Up Next]]
* [[Add-on:Embuary_Info|Embuary Info]] ''(Added from Rapier 12 / Kodi 19)''
* [[forum:231881|CinemaVision]]
* [[forum:224512|User Rating Script]]
* [https://github.com/phil65/script.module.t9.search T9 Search Script]
* [[forum:224512|Library Node Editor]]
* [[forum:200081|Audio Profiles]]
* [https://github.com/phil65/plugin.program.autocompletion Autocompletion for virtual keyboard]
* [[Add-on:Special_Features|Special Features]]
* ''Image resource genre icons, weather icons and genre fanart, weather fanart add-ons...''
<section end=SupportedAdd-ons1/>

== Supported add-ons (Manual Installation) ==
<section begin=SupportedAdd-ons2/>The following add-ons are supported by Rapier. They can be installed manually using the links below.

* [[forum:329767|Netflix Add-on]]
* [[forum:258886|Artwork Beef]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:133905|MyPicsDB]]
* [[forum:167754|IMDB Update]] ''(Support removed from Rapier 12 / Kodi 19!)''
* [[forum:158775|Library Editor]]
* [https://github.com/phil65/script.youtube.browser Script.youtube.browser] ''(Support removed from Rapier 12 / Kodi 19!)''
<section end=SupportedAdd-ons2/>

== Special skin features ==
<section begin=Skin features/>{{Skin features
| skin = [[Add-on:Rapier|Rapier]]
| custom home items = {{yes}}
| custom submenu items = {{yes}}
| Media flags = {{yes}}
| TV show logo = {{yes}}
| TV logo downloader = {{yes}}
| Artwork downloader = {{yes}}
| Clear Art = {{yes}}
| cdArt = {{yes}}
| Extra fanart = {{yes}}
| Season fanart = {{no}}
| Weather fanart = {{yes}}
| Live TV = {{yes}}
| Next Aired = {{yes}}
| TvTunes = {{yes}}
| Advanced Launcher = {{no}}
| Watchlist = {{yes}}
| MovieSets = {{yes}}
| Metadata Actors = {{yes}}
| Cinema Experience = {{yes}}
| Touch = {{yes}}
| PVR = {{yes}}
| Skin Widgets = {{yes}}
| Intro movie = {{yes}}
| Random And Last Items = {{yes}}
}}
* '''All of the above mentioned add-ons'''
* '''[[Custom home items]]'''
* '''Movie, tv show and music video clear logos and clear art'''
* '''Music clear logos and cd art'''
* '''[[Artwork|Extra fanart]]'''
* '''Touch support'''
* '''Splash screen (video, audio or image)'''
* '''[[PVR|PVR & Live TV/Radio]]'''
* '''Audio DSP support including all Audio DSP add-ons.'''
* '''Games support'''
<section end=Skin features/>

== Screenshots ==
<section begin="screenshots"/>
<gallery caption="Screenshots" widths=200px heights=113px>
File:Rapier_new_home_movies.png|Home screen Movies without widgets
File:skin.rapier_new_home_movies_widgets.jpg|Home screen Movies with widgets
File:Rapier02.jpg|Movies Thumbnail View
File:Rapier03.jpg|Movies Wrap Info View
File:Rapier04.jpg|Movies List Info 2 View
File:Rapier05.jpg|Movies Wall View
File:skin.rapier.16.png|Movies 3D Wrap View
File:Rapier_movie_genres.png|Movie Genres Extended List View
File:Rapier_new_tvshows.jpg|Home screen TV Shows with widgets
File:Rapier07.jpg|TV Shows Thumbs Info View (clear logo)
File:Rapier08.jpg|TV Shows Thumbs Info View (banners)
File:Rapier10.jpg|Movies Icon View (clear logo)
File:skin.rapier_fullscreen_video.jpg|Paused fullscreen video
File:Rapier_new_videos.jpg|Home screen Videos with add-on shortcuts
File:Rapier13.jpg|Music Albums List View
File:Rapier14.png|Music playing visualization 1
File:Skin.rapier fullscreen music.jpg|Music playing visualization 2
File:skin.rapier_custom_addons.png|Custom add-ons manager window
</gallery>
<section end="screenshots"/>

== Videos ==
=== Kodi 15.x - Rapier Demo ===
{{youtube|CZQWrJYgTa0}}
=== Kodi / Rapier Splash Video ===
{{youtube|G-l_tIKgbzE}}
=== Video lyrics for fullscreen music playback in Rapier ===
{{youtube|O0TqCmvIRJ8}}

== Tips and guides ==
=== Creating a custom category ===
:This is a step-by-step guide to adding a custom category. Up to 16 custom categories are available.
::1. Go to Skin Settings > Home > Category Menu
::2. Click "Add more categories"
::3. Click "Category 1-4" to activate custom category 1-4, "Category 5-8" to activate custom category 5-8, "Category 9-12" to activate custom category 9-12 or "Category 13-16" to activate custom category 13-16
::4. Choose between adding a custom category from one of your Favourites or from a built in skin preset.
::5. "Path":
:::*If you have chosen adding a custom category from a Favourite, a dialog will open up with all your favourites. You can add almost any item within Kodi to your Favourites using the context menu.
:::*If you have chosen adding a custom category from a built in skin preset, the presets dialog will open up. This allows you to choose any item in the sections or to enter a custom action yourself (bottom left item).
::6. "Name":
:::Enter a name for your custom category. If no name is entered, "Custom X" (where X is the custom category number) will be used.
::::If navigation buttons are disabled, it's recommended to use 11 characters or less for best results.
::::If navigation buttons are enabled, it's recommended to use 10 characters or less for best results.
::7. You can choose a category icon from any location on your system.
::8. You can add up to 6 add-on shortcuts.
::::''Added from Rapier 12 / Kodi 19''
::::Choose between any add-on.
::::Selecting an add-on shortcut will disable the category icon for the chosen category.
::9. You can choose a widget. Adding a widget brings up a dialog:
:::*Movies, tv shows, music videos or albums will display recently added and in progress/featured items from your library.
:::*Add-ons will display random add-ons.
:::*Games will display all game add-ons.
:::*Playlist (movies, episodes or music) will display recently added and featured items from your selected playlist (useful when the custom category is a playlist from your favourites).
:::*In Cinemas / Upcoming Movies, Top Rated Movies / Top Rated TV Shows, Trending Movies / TV Shows will use the add-on script.extendedinfo to fill the widgets.
:::*Favourite ''(added from Rapier 12 / Kodi 19)'' will bring up a dialog to choose a custom top widget and a custom bottom widget using your favourites. You can choose either one, as both are not required. You can set the name and choose aspect (poster, wide or square) individually for both widgets.
:::*Custom ''(script.skinshortcuts required)'' will bring up a dialog to choose a custom top widget and a custom bottom widget. You can choose either one, as both are not required. You can set the name and choose aspect (poster, wide or square) individually for both widgets.
::10. You can choose between 3 background options for your custom category.
:::*"Single image" will open up a dialog, where you can choose any image on your system as background for your custom category.
:::*"Multi image" will open up a dialog, where you can choose any folder with images on your system as multi backgrounds for your custom category.
:::*"Fanart" will open up a dialog, where you can choose one of the built in fanart options as background for your custom category.
:::The button below will display the chosen background option and the image to the left will display the image(s).

=== Adding, removing or editing submenus ===
:This is a step-by-step guide to adding, removing or editing submenus. You can add up to 7 submenus for each category.
::*Go to Skin Settings > Home > Category Submenu.
:::All of your enabled categories are displayed here: Music / Videos / Movies / TV Shows / Add-ons / Pictures / General / System / Live TV / Weather / Custom Category 1-16
:::Clicking any of them allows you to add, remove or edit the submenus.
::*To '''remove''' an existing hardcoded submenu from the Music / Videos / Movies / TV Shows / Add-ons / Pictures / General / System / Live TV / Weather categories:
:::Enabling Button 1 and leaving everything else blank, will disable the existing submenu 1 for the chosen category and so on. Do this for all the submenu items you wish to remove.
::*To '''edit''' any submenu item for a category:
:::Enabling Button 1 and entering all the necessary information, will replace submenu 1 for the chosen category and so on. Do this for all the submenu items you wish to edit.
::::1. Click Button 1 to 7 to edit the submenu item you wish.
::::2. Choose between editing a submenu item using one of your Favourites, a built in skin preset, a script or an add-on.
::::3. "Path":
:::::If you have chosen editing a submenu item using one of your Favourites, a dialog will open up with all your favourites. You can add almost any item within Kodi to your Favourites using the context menu.
:::::If you have chosen editing a submenu item using a built in skin preset, the presets dialog will open up. This allows you to choose any item in the sections or to enter a custom action yourself (bottom left item).
:::::If you have chosen editing a submenu item using a script, a dialog will open up where you can select one of the scripts.
:::::If you have chosen editing a submenu item using an add-on, a dialog will open up where you can select one of the add-ons.
::::4. "Label" allows you to enter the name of the submenu.
::*To '''add''' a submenu item for any category:
:::You can add additional submenus to a category with less than 7 submenu items: eg. if a category has 4 submenus, you can enable Button 5, 6 and 7 to add 3 additional custom submenus.
::::1. Click Button 1 to 7 to add the submenu item you wish.
::::2. Choose between adding a submenu item from one of your Favourites, a built in skin preset, a script or an add-on.
::::3. "Path":
:::::If you have chosen adding a submenu item from a Favourite, a dialog will open up with all your favourites. You can add almost any item within Kodi to your Favourites using the context menu.
:::::If you have chosen adding a submenu item from a built in skin preset, the presets dialog will open up. This allows you to choose any item in the sections or to enter a custom action yourself (bottom left item).
:::::If you have chosen adding a submenu item from a script, a dialog will open up where you can select one of the scripts.
:::::If you have chosen adding a submenu item from an add-on, a dialog will open up where you can select one of the add-ons.
::::4. "Label" allows you to enter the name of the submenu.

=== Proper naming of files ===
:Rapier reads all file names.
:If you use some of the below tags in the file name, additional media flags are displayed automatically.
::* "bluray" / "blu-ray" / "bdrip" / "brrip" / "bdremux" / "bd25" / "bd50": displays a Blu-ray logo
::* "web-dl" / "web-download" / "webrip": displays a web-dl logo
::* ".3d." / "hsbs" / "sbs" / "half-sbs": displays a 3D logo
:::The stereoscopic mode can also be automatically detected by Kodi, so you might see this logo without the tags in the file name.
::* "hddvd" / "hd-dvd": displays a HD-DVD logo
::* "dvd" / "dvdrip": displays a DVD logo
:::The DVD logo will also be displayed if the file extension is: .img / .ifo / .vob
::* "hdtv": displays a HD TV logo
::* "sdtv" / "pdtv": displays a SD TV logo
::* "vhs": displays a VHS logo
::* ".atmos": if your file contains either TrueHD or E-AC3 (Dolby Digital Plus) audio, a Dolby Atmos logo will display
::* "dtsx" / "dts-x": if your file contains DTS-HD Master Audio, a DTS:X logo will display
::* "dtses" / "dts-es": if your file contains DTS Audio, a DTS-ES logo will display
::* ".bdxl" / "bd66" / "bd100": displays an Ultra-HD Blu-ray logo
::* ".unrated": displays an "Unrated" media flag
::* "missingvideo" or "Missingvideo" will grey out a missing movie or episode. [[Add-on:Rapier#Using_the_missing_movie_or_episode_feature|Click here for details.]]

=== Using the missing movie or episode feature ===
:''Added from Rapier 12 / Kodi 19''
:You can add the missing movies for a movie set and missing episodes for tv shows. They will be greyed out in the listing, so it's easy to see which ones are missing.
::''What is required for missing movies:''
:::*Use any video file in any format (the smaller size, the better).
:::*Create a movie folder for the missing movie (like you normally do for movies)
:::*Name the file anything and add "Missingvideo" or "missingvideo" anywhere in the filename.
::::- Eg. "Star.Wars.The.Rise.of.Skywalker.2019.missingvideo.mp4"
:::*Scrape the movie into your library and you're done.
::''What is required for episodes:''
:::*Use any video file in any format (the smaller size, the better).
:::*Place the file in your tv show folder and give it the appropiate episode number and name.
:::*Add "Missingvideo" or "missingvideo" anywhere in the filename.
::::- Eg. "Simpsons.S20E18.missingvideo.mp4"
:::*Scrape the episode into your library and you're done.

=== Missing tv show clear logos in the TV Shows Today widget in the home screen ===
:Go to Skin Settings -> Add-ons -> Artwork Downloader -> Download Presets - TV Shows -> Click the Clear Logo button and wait for the script to finish. This should add all clear logos for the tv shows to your library. You can do this with clear art as well if you wish.

=== Missing Upcoming TV Shows widget ===
:If you don't see the Upcoming TV Shows widget on the home screen, you probably need to enable it in the Tv Show - Next Aired add-on settings.
::* Go to Add-ons > My Add-ons > Program Add-ons > TV Show - Next Aired > Settings
::* ENABLE the setting "Show all tv shows for home screen (needs skin support)"
::* Restart Kodi

=== ExtendedInfo (using script.extendedinfo) for movie/tv show cast/crew members ===
:To activate ExtendedInfo for movie/tv show cast members, press down from the selected cast member in the video information window.
:You can click any director/writer throughout the skin to activate ExtendedInfo.

=== Mouse / touch device support ===
:Mouse and touch devices are indeed supported by this skin.
:To make the most of your experience, make sure these skin settings are set:
::*Skin Settings > General > Hide dialog close buttons > DISABLED
::*Skin Settings > General > Hide top options menu bar (only show when selected) > DISABLED
::*Skin Settings > General > Hide top bar when idle > DISABLED
::*Skin Settings > Home > Show navigation buttons > ENABLED

=== Low powered devices ===
:Rapier can be a bit rough on lower powered devices. Especially entering libraries for the first time after launch can take a while.
:Several skin settings have been made to improve performance:
::*Skin Settings > General > Enable low CPU power mode
:::''When enabled, you can choose between these two options:''
:::1. Disable animations only. Selecting this option will disable selected animations.
:::2. Disable animations and CPU demanding skin settings. Selecting this option will disable selected animations AND these CPU demanding skin settings:
::::* Video playing in the background
::::* Play trailers in a window
::::* Music CD art
::::* Animated backgrounds and fanart (both music and video)
::::* Music visualization and artist fanart in the background (when playing music)
::::* Fanart slideshow using script.artistslideshow (when playing music)
::*Skin Settings > Views
:::Here you can disable '''all''' view types you don't use in all windows and sections of Kodi.
:::TIP: Disabling '''every single''' view type you don't use will significantly speed up load times when entering windows and libraries.

== Skin Settings ==
Rapier is highly customizable and has a great deal of skin settings. This section details all the skin settings options for Rapier.
=== General ===
:'''GENERAL'''
::'''Enable kiosk mode'''
:::Once you've got everything set up the way you want, you can enable "kiosk mode" to lock your chosen views and hide selected buttons / functions.
::'''Enable low CPU power mode'''
:::This setting might improve performance on lower powered systems.
::::''When enabled, you can choose between these two options:''
::::* Disable animations only. Selecting this option will disable selected animations.
::::* Disable animations and CPU demanding skin settings. Selecting this option will disable selected animations AND these CPU demanding skin settings:
:::::* Video playing in the background
:::::* Play trailers in a window
:::::* Music CD art
:::::* Animated backgrounds and fanart (both music and video)
:::::* Music visualization and artist fanart in the background (when playing music)
:::::* Fanart slideshow using script.artistslideshow (when playing music)
::'''Hide dialog close buttons'''
:::Hides the dialog close buttons on all dialogs. Dialog close buttons are very useful when using a mouse or touch device.
::'''Hide date'''
:::Hides the date in the top status bar.
::'''Date format'''
:::Choose the date format according to your region: UK / Australia / Central Europa / India or USA / Canada.
::'''Hide top options menu bar (only show when selected)'''
:::This will permanently show the menu bar in the library or hide it. If you choose to hide it, it will only be visible when focused.
::'''Hide top bar when idle'''
:::''This setting is only enabled when the setting "Hide top options menu bar" above is enabled.''
:::This will hide the top bar, when the system has been left idle for 3 seconds. The top bar will still be visible, when the top options menu bar is visible.
::'''Use scrollbar / Use quick jump'''
:::''This setting requires [[Add-on:Skin_Helper_Service|script.skin.helper.service]].''
:::Use scrollbar: Choose this to enable scrollbars throughout the skin.
:::Use quick jump: Choose this to enable quick jump alphabet navigation wherever possible.
::'''Enable battery notification'''
:::If you enable this option, a battery notification will be displayed in the top status bar. This will only be visible when using a battery powered device.
::'''Enable autocompletions for keyboard dialog'''
:::''This setting requires [[Add-on:ExtendedInfo_Script|script.extendedinfo]].''
:::This setting enables autocompletions by Google or Youtube for the keyboard dialog in Kodi. They show up as up to 9 clickable suggestions below the actual keyboard.
:'''STARTUP'''
:::''Rapier 11 / Kodi 18 Leia only: This section requires [[Add-on:Skin_Helper_Service|script.skin.helper.service]].''
:::''Rapier 12 / Kodi 19 Matrix has built in support for this feature.''
::'''Enable splash screen (photo, video or music)'''
:::This allows you to enable the setting and choose a video, image or piece of music to play as a splash screen when Kodi starts up.
::'''File'''
:::''Added from Rapier 12 / Kodi 19 Matrix''
:::This allows you to choose a video, image or piece of music to play as a splash screen when Kodi starts up.
::'''Splash screen image duration'''
:::''This button is only visible if an image is chosen as splash screen.''
:::Pressing this button brings up a numeric dialog where you can set the amount of time the image is displayed. Defaults to 5 seconds.
::'''Preview'''
:::''This button is only visible if splash screen is enabled.''
:::Pressing this button will preview your chosen media.

=== Home ===
:'''HOME'''
::'''Show navigation buttons'''
:::This will display navigation buttons in each side of the category menu and can be very useful to mouse or touch device users.
::'''Enable music playing progressbar'''
:::When playing music and leaving the system idle for 5 seconds, the category section will turn into a progressbar.
:'''CATEGORY MENU'''
::'''Use white / coloured categories'''
:::Toggle this button to switch between white and coloured home screen category names. The coloured categories will follow the chosen theme - blue, red or orange.
::'''Change category actions'''
:::Here you can change the functions of all main home screen categories. Clicking a category name will open up a dialog.
:::Full support for all library nodes.
::'''Hide categories'''
:::Select to hide main categories: Music, Videos, Movies, TV Shows, Add-ons, Pictures, General, System, TV, Radio, Weather, Power.
::'''Add more categories'''
:::Add up to 16 custom categories to the home screen and choose between any favourite (add-ons, playlists, paths etc.) or a built-in skin preset. You can choose your own icon, category image (name of the category), background and add a custom widget.
:::''[[Add-on:Rapier#Creating_a_custom_category|Click here for a detailed guide on creating a custom category.]]''
::'''Reorder categories'''
:::Use this menu to completely reorder all home screen categories.
:::Category 1 will be the startup category when launching Kodi.
:::''Please make sure all categories are used, or you will end up missing categories!''
:'''CATEGORY SUBMENU'''
::'''Hide submenus'''
:::Hides all submenus.
::'''Music / Videos / Movies / TV Shows / Programs / Add-ons / Games / Pictures / General / System / Live TV / Weather / Custom Category 1-16'''
:::You can remove, edit or create up to 7 custom submenus for each category using any favourite (add-ons, playlists, paths etc.), built-in skin preset, script or plugin. This is very useful in a lot of different ways.
:::''[[Add-on:Rapier#Adding.2C_removing_or_editing_submenus|Click here for a detailed guide on adding, removing or editing a submenu item.]]''
:'''CATEGORY ICON'''
::'''Hide category icons'''
:::Hides all category icons.
::'''Custom category icon'''
:::Select a custom category icon for the main categories.
:'''INFO PANEL'''
::'''Hide now playing'''
:::When playing music or video, Rapier will display a Now Playing widget. This setting allows you to hide the widget.
::'''Hide recently added'''
:::Hide the Recently Added widget. Enabling this will also hide the In Progress widget.
::'''Hide "in progress" / random'''
:::Enabling this option will hide the In Progress widget.
::'''Hide in cinemas / upcoming movies'''
:::''Requires the add-on [[Add-on:ExtendedInfo_Script|script.extendedinfo]] (minimum version 3.0.0)''
:::Enabling this option will hide the In Cinemas / Upcoming Movies widget for the movie category.
::'''Hide tv show next aired'''
:::Enabling this option will hide the TV Show Next Aired widget for the tv shows category.
::'''Hide videos'''
:::Enabling this option will hide the video widget for the Videos category.
::'''Hide Add-ons'''
:::Enabling this option will hide the Add-on widgets for the Add-ons category.
::'''Hide Games'''
:::Enabling this option will hide the Games widget for the Games category.
::'''Hide favourites'''
:::Enabling this option will hide the favourites widget for the general category. If the weather category is disabled, the weather widget is displayed for the general category instead.
::'''Hide weather'''
:::Enabling this option will hide the weather widget for the weather category.
::'''Hide PVR channels'''
:::Enabling this option will hide the PVR channels / recordings widgets for the TV / Radio category.
::'''Hide recording information'''
:::Enabling this option will hide the recording information widgets when recording tv / radio.
::'''Hide system information'''
:::Enabling this option will hide the system information widget for the system category.
:'''ADD-ON SHORTCUTS'''
::'''Enable add-on shortcut titles'''
:::Enabling this option will display add-on titles for each of the add-on shortcuts.
::'''Videos / Movies / TV Shows / Music / Pictures / Programs / Add-ons / General'''
:::Select up to 6 add-on shortcuts for each category. Selecting an add-on shortcut will disable the category icon for the chosen category.

=== Media ===
:'''GENERAL'''
::'''Select rating'''
:::This will open a dialog to select if the ratings used in media windows are the default ratings or user ratings ("My rating").
:'''VIDEOS'''
::'''Play trailers in a window (video information window)'''
:::This will play trailers in windowed mode in the video information window only.
::'''Right clicking scrollbar plays trailer'''
:::This setting will disable the playback of trailers when moving right or down from a scrollbar inside the video libraries.
::'''Use alternative duration'''
:::By default Kodi displays duration of videos in minutes (eg. 112 minutes). Enabling this setting will display the duration in hours and minutes (eg. 1h52).
::'''Select movie genre icon pack'''
:::This setting allows you to select an image resource add-on genre pack to use with the skin. I recommend installing Xzener's Reflected Icons.
:::Defaults to use the skin.rapier/extras/moviegenres/ folder for manually adding images if no image resource add-on is selected.
:'''VIDEO PLAYING'''
::'''Enable video playing in the background'''
:::When playing video, this setting will enable the video playing in the background throughout the skin.
:'''FULLSCREEN VIDEO'''
::'''Hide seekbar OSD during fullscreen playback'''
:::Hides the seekbar when playing fullscreen audio or video.
::'''Show information when paused'''
:::Shows the information dialog, when video is paused.
::'''Automatically close OSD'''
:::''Added from Kodi 20 / Rapier 13.''
:::This will automatically close the video OSD, when the system has been idle for x seconds.
::'''OSD autoclose time (seconds)'''
:::''Added from Kodi 20 / Rapier 13.''
:::This is the time in seconds before the video OSD will automatically close, when the system is idle.
:::Defaults to 4 seconds.
::'''Show clear art on OSD'''
:::Displays clear art images on the OSD when playing movies or tv show episodes. If no clear art is available, a clear logo will be displayed. If no clear logo is available, the cover image will be displayed. Clear art and clear logos require the add-on Artwork Downloader. You can either run Artwork Downloader in the background using the add-on's settings, manually download the artwork in the movie or tv show library or download using Rapier's Add-ons skin settings section.
::'''Show clear logo on OSD'''
:::Displays clear logo images on the OSD when playing movies or tv show episodes. If no clear logo is available, the cover image will be displayed. Clear logos require the add-on Artwork Downloader. You can either run Artwork Downloader in the background using the add-on's settings, manually download the artwork in the movie or tv show library or download using Rapier's Add-ons skin settings section.
::'''Show "Paused" in fullscreen video'''
:::When pausing fullscreen video, this setting will dim the screen slighly and display a "Paused" label.
:'''TV SHOWS'''
::'''Use banner / poster layout'''
:::Choose between displaying tv show poster or banner images throughout the skin.
:'''TV / RADIO'''
:::''This section will only be visible if live tv / PVR is enabled.''
::'''Select multi image path for tv channels / recordings'''
:::Use this option to select a folder of images (or a folder with a single image) to be used in the tv channels / recordings view.
:::If no folder is selected, the default images will be used.
::'''Select multi image path for radio channels / recordings'''
:::Use this option to select a folder of images (or a folder with a single image) to be used in the radio channels / recordings view.
:::If no folder is selected, the default images will be used.
:'''MUSIC'''
::'''Enable music CD art'''
:::Enabling this will display CD Art images throughout the skin when playing music. This requires either the add-on CDArt Manager and/or manually adding cdart.png images to your music library folders.
::'''Select music library path for clear logos'''
:::Enter the path to your music library if you wish to enable clear logos in your Kodi music library.
:::''Leaving this blank will disable clear logos in the music library.''
::'''Select music genre icon pack'''
:::This setting allows you to select an image resource add-on genre pack to use with the skin. I recommend installing Music Genre Icons - Text.
:::Defaults to use the skin.rapier/extras/musicgenres/ folder for manually adding images if no image resource add-on is selected.
:'''MUSIC PLAYING'''
::'''Enable fullscreen window when starting music'''
:::''Removed from Kodi 19 / Rapier 12. Go to "Settings > Media > Music > Switch to visualization on playback" instead.''
:::Enabling this setting will immediately open up the fullscreen music window when music playback is started.
::'''Enable music visualization / artist fanart in the background'''
:::Enable this setting to display music visualization or artist fanart in the background throughout the skin when playing music.
::'''Choose background'''
:::Clicking this button will open up a dialog, where you can choose between these background options throughout the skin:
:::* Use only visualization for background
:::* Use only artist fanart for background
:::* Use both music visualization and artist fanart for background
::'''Fanart slideshow'''
:::Enabling this will display an artist slideshow in the background when playing music.
:::This setting requires the add-on [[Add-on:Artist_Slideshow|Artist Slideshow]] and the skin setting "Use only artist fanart for background" or "Use both music visualization and artist fanart for background".
::'''Animate fanart backgrounds'''
:::Enabling this will animate the fanart in the background throughout the skin when music is playing.
:::This requires the skin setting "Use only artist fanart for background" or "Use both music visualization and artist fanart for background".
:'''FULLSCREEN MUSIC'''
::'''Show CD art and info in fullscreen music playback'''
:::Enabling this will display CD Art images in the music visualization when playing music. This requires either the add-on CDArt Manager and/or manually adding cdart.png images to your music library folders.
::'''Show "Paused" in fullscreen music'''
:::When pausing fullscreen music, this setting will dim the screen slighly and display a "Paused" label.
::'''Lyrics add-on'''
:::''Added from Rapier 12 / Kodi 19''
:::Select your preferred lyrics add-on to use in the music visualization window.
::'''Lyrics settings'''
:::''Added from Rapier 12 / Kodi 19''
:::This will open the settings dialog for the selected lyrics add-on.
::'''Enable video lyrics'''
:::''Requires the add-on [[Add-on:CU_LRC_Lyrics|CU LRC Lyrics]]''
:::During fullscreen music playback, this will enable music video style animated lyrics in sync with the music playing.
:::''[[Add-on:Rapier#Video_lyrics_for_fullscreen_music_playback_in_Rapier|Watch the video demo above.]]''
::'''Automatically close OSD'''
:::''Added from Kodi 20 / Rapier 13.''
:::This will automatically close the music OSD, when the system has been idle for x seconds.
::'''OSD autoclose time (seconds)'''
:::''Added from Kodi 20 / Rapier 13.''
:::This is the time in seconds before the music OSD will automatically close, when the system is idle.
:::Defaults to 4 seconds.
:'''PICTURES'''
::'''Show "Paused" in picture slideshow'''
:::When pausing a fullscreen picture slideshow, this setting will display the current time and a "Paused" label.
:'''MEDIA FLAGGING'''
::'''Enable media flags ''(Enabling all media flags may break the layout)'''
:::This setting will enable or disable all media flags.
::'''Use default theme colour / Use white theme colour'''
:::Choose between blue (default) or white media flags.
::'''Hide video resolution'''
:::This setting will hide the video resolution media flags.
::'''Hide aspect ratio'''
:::This setting will hide the aspect ratio media flags.
::'''Hide rating
:::This setting will hide the rating media flags.
::'''Hide subtitle count'''
:::Enabling this setting will display a media flag with the number of subtitles available.
::'''Hide audio language count'''
:::Enabling this setting will display a media flag with the number of audio languages available.
::'''Hide Next Aired'''
:::''Requires installation of the add-on [[Add-on:TV_Show_-_Next_Aired|TV Show Next Aired]]''
:::This setting will hide the tv show status media flag in the tv show and season library.

=== Views ===
:'''VIDEOS / MOVIES / TV SHOWS / EPISODES / MUSIC / MUSIC VIDEOS / PICTURES / ADD-ONS / PROGRAMS / MISCELLANEOUS
:::Here you can disable all view types you don't use in all windows and sections of Kodi.
:::TIP: Disabling '''every single''' view type you don't use will significantly speed up load times when entering windows and libraries.

=== Configure Menus ===
:'''CONFIGURE MENUS'''
::'''Shutdown Menu'''
:::Here you can enable/disable shutdown menu items. The items are enabled according to your hardware specifications.
::'''Context Menu'''
:::Here you can enable/disable context menu items. Most items requires add-ons. If a required add-on is not installed, clicking an item will prompt you to install it.

=== Weather ===
:'''WEATHER'''
::'''Enable weather'''
:::''Removed from Rapier 12 / Kodi 19''
:::This will enable or disable the weather notification in the top status bar.
::'''Weather add-on'''
:::''Added from Rapier 12 / Kodi 19''
:::If a weather add-on is installed and enabled, the add-on name will display here.
:::If a weather add-on is not installed or disabled, you will be redirected to the weather settings window.
::'''Weather add-on settings'''
:::''Added from Rapier 12 / Kodi 19''
:::This will open the settings dialog for the selected weather add-on.
::'''Show in home window only / Show in all windows'''
:::This will either display the weather notification in the home window only or in all windows.
::'''Select weather icon pack'''
:::This setting allows you to select an image resource add-on weather icons pack to use with the skin.
:::Defaults to Kodi's default weather icons if no image resource add-on is selected.

=== Backgrounds ===
:'''BACKGROUNDS'''
::'''Fanart brightness - low / medium'''
:::Opens up a dialog to select the fanart background brightness on a 0-100% scale. Default is 30%.
::'''Animate custom backgrounds'''
:::Enable this setting to animate the custom backgrounds.
::'''Animate fanart backgrounds'''
:::Enable this setting to animate the fanart backgrounds.
::'''Time per Image for fanart backgrounds'''
:::''Removed from Rapier 12 / Kodi 19.
:::''This setting is only visible if the add-on [https://github.com/marcelveldt/script.skin.helper.backgrounds Skin Helper Backgrounds] is installed.
:::''This setting is only enabled if fanart backgrounds have been selected for either the music, videos, movies, tv shows or pvr sections.
:::Clicking this button will bring up a numeric dialog. Use this to set the time in seconds each fanart image is shown. Defaults to 8 seconds.
::'''Select movie / tv show genre background pack'''
:::Select a genre background image pack to be used in the movies and tv shows genre node.
::'''Select music / music video genre background pack'''
:::Select a genre background image pack to be used in the music and music videos genre node.
:'''WIDGETS'''
::'''Hide all widget backgrounds'''
:::Enabling this will hide the backgrounds for all home screen widgets, when they are focused.
:'''CUSTOM BACKGROUNDS'''
::'''Global'''
:::Choose a custom single image or multi images to use globally throughout the skin. You can set the background brightness from 0-100%.
::'''Music / Videos / Movies / TV Shows / Add-ons ''(from Rapier 12 / Kodi 19)'' '''
:::For the music, videos, movies, tv shows and add-ons ''(from Rapier 12 / Kodi 19)'' sections, you can choose between four background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Fanart images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin. Select to display either random, recent, in progress or unwatched fanart images (all options will not be available for every category).
::'''TV / Radio'''
:::For the tv and radio sections, you can choose between four background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Random fanart images ''(Removed from Rapier 12 / Kodi 19)''. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::'''Pictures'''
:::For the pictures section, you can choose between five background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Latest images from your library. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin. This setting requires the add-on [[forum:133905|MyPicsDB]].
::::* Random images from your library. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin. This setting requires the add-on [[forum:133905|MyPicsDB]].
::'''Add-ons (Rapier 11 / Kodi 18 and below) / Games / General / System / Power'''
:::For the programs, add-ons, games, general, system and power sections, you can choose between three background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::'''Weather'''
:::For the weather section, you can choose between 5 background options:
::::* The global background.
::::* A custom single image. You can set the background brightness from 0-100%, and choose between displaying the background in the home screen only or throughout the skin.
::::* Multi images. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Weather condition backgrounds. Select the path to your weather fanart folder. You can set the background brightness from 0-100%, and choose between displaying the backgrounds in the home screen only or throughout the skin.
::::* Condition (Add-on). This setting allows you to select an image resource add-on weather fanart pack.

=== Add-ons ===
::'''''NOTE: Category completely removed from Rapier 12 / Kodi 19'''''
:'''LYRICS'''
::'''Path'''
:::Select your preferred lyrics add-on to use in the music visualization window.
::'''Lyrics settings'''
:::This will open the settings dialog for the selected lyrics add-on.
:'''ARTWORK DOWNLOADER'''
::'''Settings'''
:::This will open the settings dialog for the Artwork Downloader add-on.
::'''Download according to add-on settings'''
:::This will download all artwork specified in the Artwork Downloader settings.
::'''Download presets - movies'''
:::Hide or show all the settings for the movie artwork downloads.
::'''All'''
:::Download all movie artwork: poster, fanart, extra fanart, extra thumbs, thumbnail 16:9, clear art, clear logo. All artwork for every movie will be downloaded.
::'''Poster / Fanart / Extra fanart / Extra thumbs / Thumbnail 16:9 / Clear art / Clear logo'''
:::Download only the movie artwork specified. The selected artwork for all movies wil be downloaded.
::'''Download presets - tv shows'''
:::Hide or show all the settings for the tv shows artwork downloads.
::'''All'''
:::Download all tv show artwork: poster, season poster, banner, season banner, fanart, extra fanart, extra thumbs, clear art, clear logo, tv thumb 16:9. All artwork for every tv show will be downloaded.
::'''Poster / Season poster / Banner / Season banner / Fanart / Extra fanart / Extra thumbs / Clear art / Clear logo / TV thumb 16:9'''
:::Download only the tv show artwork specified. The selected artwork for all tv shows will be downloaded.
::'''Download presets - music videos'''
:::Hide or show all the settings for the music videos artwork downloads.
::'''All'''
:::Download all music video artwork: poster, fanart, extra fanart, clear art, clear logo. All artwork for every music video will be downloaded.
::'''Poster / Fanart / Extra fanart / Clear art / Clear logo'''
:::Download only the music video artwork specified. The selected artwork for all music videos will be downloaded.
:'''IMDB UPDATE'''
:::''This section will only be available of you have installed the add-on [http://forum.kodi.tv/showthread.php?tid=167754 IMDb Update] on your system.''
::'''Settings'''
:::This will open the settings dialog for the add-on [http://forum.kodi.tv/showthread.php?tid=167754 IMDb Update].
::'''Update IMDb movie rating'''
:::This will update the IMDb movie rating for all movies in your library.
::'''Update IMDb movie rating (hidden)'''
:::This will update the IMDb movie rating for all movies in your library. The service will run in the background.
::'''Update IMDb top 250'''
:::This will update the IMDb top 250 for all movies in your library.
::'''Update IMDb top 250 (hidden)'''
:::This will update the IMDb top 250 for all movies in your library. The service will run in the background.
::'''Update MPAA rating'''
:::This will update the MPAA rating for all movies in your library.
::'''Update MPAA rating (hidden)'''
:::This will update the MPAA rating for all movies in your library. The service will run in the background.
::'''Update All'''
:::This will update all options for this add-on.
::'''Update All (hidden)'''
:::This will update all options for this add-on. The service will run in the background.

=== Supported Add-ons ===
:::This section contains two sub sections:
::::*Automatic installation from Kodi add-on repository
:::::This is a list of add-ons from the official Kodi add-on repository supported by Rapier. Each add-on will display a description when focused.
::::::If an add-on is installed and enabled you will see the add-on version information. Clicking the add-on will open up the settings dialog.
::::::If an add-on is installed but disabled, clicking the item will prompt you to enable the add-on and guide you through the process. (Rapier 12 / Kodi 19 only)
::::::If an add-on is not installed, clicking the item will prompt you to install the add-on and guide you through the process.
::::*Manual installation
:::::This list of add-ons supported by Rapier is ''not'' in the official Kodi add-on repository. Each add-on will display a description when focused.
::::::If an add-on is installed and enabled you will see the add-on version information. Clicking the add-on will open up the settings dialog.
::::::If an add-on is installed but disabled, clicking the item will prompt you to enable the add-on and guide you through the process. (Rapier 12 / Kodi 19 only)
::::::If an add-on is not installed, clicking the item will display an error notification. You can only install these add-ons manually from zip.

=== Reset Skin / Skin Settings ===
:'''SKIN SETTINGS'''
::'''Reset skin settings to default (press to confirm).'''
:::This will reset all skin settings to default. You can NOT undo this action.
::'''Export skin settings'''
:::''Requires the add-on [https://github.com/marcelveldt/script.skin.helper.skinbackup Skin Helper Skinbackup]''
:::Exports all the Rapier skin settings to your selected location.
::'''Import skin settings.'''
:::''Requires the add-on [https://github.com/marcelveldt/script.skin.helper.skinbackup Skin Helper Skinbackup]''
:::Imports all the Rapier skin settings from your selected location.
:'''OTHER'''
::'''Reload skin'''
:::This will reload the skin and can be useful for reloading xml files, images, fonts and other changes.

== Translations ==
[https://www.transifex.com/teamxbmc/kodi-skins/skin-rapier/ Translations of the skin are handled on Transifex.]

Please take a moment to check if your language is up to date, and all strings are translated. You can help out by signing up on Transifex, join the project and translate the skin to your native language.

A huge thanks to all the translators for the great work - it's really appreciated!

== Development ==
You can follow the latest development on Github.
* [https://github.com/gade01/Rapier Rapier 12 - Kodi 19 Matrix]
* [https://github.com/gade01/Rapier/tree/Leia Rapier 11 - Kodi 18 Leia]
* [https://github.com/gade01/Rapier/tree/Krypton Rapier 10 - Kodi 17 Krypton] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Jarvis Rapier 9 - Kodi 16 Jarvis] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Isengard Rapier 8 - Kodi 15 Isengard] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Helix Rapier 7 - Kodi 14 Helix] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Gotham Rapier 6 - XBMC 13 Gotham] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Frodo Rapier 5 - XBMC 12 Frodo] - DEPRECATED
* [https://github.com/gade01/Rapier/tree/Eden Rapier 4 - XBMC 11 Eden] - DEPRECATED

== Changelogs ==
* [https://www.dropbox.com/s/dv4jk2fcudw3k4z/changelog.txt?dl=0 View changelog for Rapier 12 - Kodi 19 Matrix]
* [https://www.dropbox.com/s/mqyx0wy7tqchee0/changelog.txt?dl=0 View changelog for Rapier 11 - Kodi 18 Leia]
* [https://www.dropbox.com/s/fpr7kaqxwsk61sy/changelog.txt?dl=0 View changelog for Rapier 10 - Kodi 17 Krypton]
* [https://www.dropbox.com/s/niaeaddbfifk6s6/changelog.txt?dl=0 View changelog for Rapier 9 - Kodi 16 Jarvis]
* [https://www.dropbox.com/s/chwzv9mbctsrlip/changelog.txt?dl=0 View changelog for Rapier 8 - Kodi 15 Isengard]
* [https://www.dropbox.com/s/091grvjawrif5rw/changelog.txt?dl=0 View changelog for Rapier 7 - Kodi 14 Helix]
* [https://www.dropbox.com/s/oi0y8c80quyn93b/changelog.txt?dl=0 View changelog for Rapier 6 - XBMC 13 Gotham]
* [https://www.dropbox.com/s/5q4zvdig1y4u72t/changelog.txt?dl=0 View changelog for Rapier 5 - XBMC 12 Frodo]
* [https://raw.githubusercontent.com/gade01/Rapier/Eden/changelog.txt View changelog for Rapier 4.x - XBMC 11 Eden]

{{Compat
| Works with Atlantis = {{No}}
| Works with Babylon = {{No}}
| Works with Camelot = {{Yes}}
| Works with Dharma = {{Yes}}
| Works with Eden = {{Yes}}
| Works with Frodo = {{Yes}}
| Works with Gotham = {{Yes}}
| Works with Helix = {{Yes}}
| Works with Isengard = {{Yes}}
| Works with Jarvis = {{Yes}}
| Works with Krypton = {{Yes}}
| Works with Leia = {{Yes}}
| Works with Matrix = {{Yes}}
}}

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Skins]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Jarvis add-on repository]]
[[Category:Krypton add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Matrix add-on repository]]
[[Category:Nexus add-on repository]]

Translations

2022-04-14T03:16:44Z

Gade: /* History */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised. 
The former strings.xml file has been superseeded by the appropriate GNU gettext strings.po files.
 
[https://kodi.tv/article/switching-translations-to-weblate/ In 2021 Kodi switched translation platform to Weblate.]

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
You can create a new account or use an existing Google, Facebook or Github account. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged. 
It depends how many translations are done for a specific language, but usually new versions are released once a month.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Language portal

2022-04-14T01:20:09Z

Gade: /* Fonts */

{{mininav}}
__NOTOC__
__NONUMBEREDHEADINGS__

= Languages =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Language_support|Language Support]]}}'''
This page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_language_codes_(ISO-639:1988)|Language Codes - (ISO-639)]]}}'''
|}
 

= Translations =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translations|Translations in {{kodi}}]]}}'''
This page is mostly for users and translators, detailing how to translate Kodi and other add-ons into native languages. 
A full introduction is made to our translation system at Weblate.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translating_add-ons|Translating your Add-on]]}}'''
This page is mostly for add-on developers, detailing how to add your add-on, skin etc. to our translation system at Weblate. 
Make sure to read the best practices guide, as many errors and merge conflicts can be avoided by following these steps.
|}

= Fonts =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Fonts|Using Fonts]]}}'''
Information and details about font.xml and supported font types.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_supported_charsets|Supported Character Sets]]}}'''
|}
 

= Other =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Interface/Regional|Change {{kodi}} language and regional settings]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Player/Language|Change Audio and Subtitle Languages]]}}'''
|}

{{updated|19}}

[[Category:Development]]
[[Category:Karellen]]
[[Category:Languages]]

Language support

2022-04-14T01:07:16Z

Gade: /* What is strings.po */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{cleanup}}
The following page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi. 
English (United Kingdom) is the default language of Kodi so it is the English language in the Git repository that is always up-to-date. 
Please always base your translations of the latest English language file from Git. The latest language files for Kodi can be found and downloaded [https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po here (link)].

=== Language add-ons ===
By default Kodi only includes one language which is English (united Kingdom). All other languages have been moved to [https://kodi.wiki/view/Category:Language_add-ons individual language add-ons] which are available form our Kodi repository for download and install. They are auto update by Team Kodi once in a while and pushed to our repository from which you will receive these updates depending on what language(s) you have installed.

=== What is langinfo.xml ===
The langinfo.xml file contains language and region specific localization settings used internally by Kodi. Basically it is the default [http://en.wikipedia.org/wiki/Code_page code page] Kodi uses for this language file.

==== Layout of a langinfo.xml file ====
<syntaxhighlight lang="xml" enclose="div">
<language>
<charsets>
<gui>GB2312</gui>
<subtitle>GB2312</subtitle>
</charsets>

<dvd>
<menu>cn</menu>
<audio>cn</audio>
<subtitle>cn</subtitle>
</dvd>
</language>
</syntaxhighlight>

The <charset> section:
<gui>: Specifies the character encoding of everything within Kodi that is not unicode. E.g. id3 tags with none unicode encoding.
<subtitle>: Default character encoding of subtitles when using a TTF (True-Type-Font).
Choose one encoding for each in the list below. The values may differ if you like.
 
The <dvd> section:
Defines the default languages for DVD-Video menu, audio and subtitle language for the [[VideoPlayer]]. Choose one for each entry out of the list of ISO-639 language abbreviations. If the DVD-Video you are playing does not support the language that you specified then it will default to English.

=== What is strings.po ===
This GNU Gettext format file contains all text strings displayed in the user interface of Kodi. 
Using that file the entire application or any add-on can be translated to any language whose graphemes are available within Unicode.

==== Layout of the strings.po file ====

<syntaxhighlight lang="python" enclose="div">
# Kodi Media Center language file
# Addon Name: Skin Widgets
# Addon id: service.skin.widgets
# Addon Provider: Martijn, phil65
msgid ""
msgstr ""
"Project-Id-Version: Kodi Addons\n"
"Report-Msgid-Bugs-To: translations@kodi.tv\n"
"POT-Creation-Date: YEAR-MO-DA HO:MI+ZONE\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Kodi Translation Team\n"
"Language-Team: English (https://kodi.weblate.cloud/languages/en_gb/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgctxt "#32001"
msgid "Recommended"
msgstr ""

msgctxt "#32002"
msgid "Random Items"
msgstr ""

# empty string with id 32003

msgctxt "#32004"
msgid "Randomize time (minutes)"
msgstr ""

msgctxt "#32005"
msgid "Use season folders"
msgstr ""

</syntaxhighlight>

This is a format defined by [https://www.gnu.org/software/gettext/ GNU gettext] but adapted in a very specific way by Kodi. The blocks of 3 settings in the example above are defined by GNU gettext as:

msgctxt ''context''
msgid ''untranslated-string''
msgstr ''translated-string''

Where the text is defined by ''untranslated-string'' and ''context'' serves to differentiate identical values.

Take note, in Kodi, these are used as follows:

msgctxt "#''label_id''"
msgid ''label_text''
msgstr ''translation''

where ''label_id'' is a numeric ID. These IDs are reserved by Kodi:

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

and are used in [[Add-on_settings_conversion|settings.xml]] to label settings.

''label_text'' defines the English text for the label.

''translation'' is empty for "en_GB" labels, and the translation for other languages with msgid retaining the English text.

The important thing is that you cannot refer to the label with msgid in the settings.py file, you need to use the ''label_id'' which must be encoded in msgctxt as above.

You can of course edit .po files in a text editor or with a specialist editor.

==== Layout of the language folders ====

Kodi loads the strings.po file depending on the set interface language. Should it find a matching language it will try to load that strings.po. If not available it will always fall back to English (United Kingdom).
For this to work you will need to place the strings.po in the correctly named folder depending on the language. These folders use "language-country" naming scheme.
 
Add-ons:
<syntaxhighlight lang="python" enclose="div">
/resources/language/resource.language.en_gb/strings.po
/resources/language/resource.language.fr_fr/strings.po
/resources/language/resource.language.it_it/strings.po
</syntaxhighlight>
Skins:
<syntaxhighlight lang="python" enclose="div">
/language/resource.language.en_gb/strings.po
/language/resource.language.fr_fr/strings.po
/language/resource.language.it_it/strings.po
</syntaxhighlight>
Please use lower case for folder and file names.
 
An extensive example list of used languages can be found here https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary/language

== Adding a new language to Kodi ==

{{see|Language portal}}

== Maintaining a language ==
The English (UK) language file ([https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po]) is the master for all language files. 
From time to time the English (UK) language file changes. This will instantly be automatically updated at Weblate translation pages.

== Related articles in the Kodi online manual ==
* [[Translations|Translations in Kodi]]
* [[Translating_add-ons|Translating your add-on]]
* [[List_of_supported_charsets|List of Supported Charsets]]
* [[List of language codes (ISO-639:1988)]]

== Notes for developers ==
Kodi uses UTF-8 as internal character encoding. Please make sure if you add new features to Kodi which depend on external data to convert these to UTF-8 if they aren't already. Use the languagefile from branches/linuxport, since we merge that file into trunk.

[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development]]
[[Category:Languages|*]]

Video nodes

2022-04-14T00:53:28Z

Gade: /* XML node components */

{{mininav|[[Video library]]|[[Video management|Management]] }}
<section begin="intro" />Video nodes are defined views that are used to organize your media from the videos menu. ''Title, Director, Year, Studios, Countries, Genres'' are examples of Nodes. These Nodes can be customised using an XML file which gives flexibility in how you display your media. Custom nodes will work with any skin, but for ease of use a compatible skin is preferred.<section end="intro" />

== Library node editor add-on ==
{{main|Add-on:Library Node Editor}}
Users can now create and edit video and music nodes from within {{kodi}} thanks to the community add-on [[Add-on:Library Node Editor|Lbrary Node Editor]].

== Technical documentation ==

=== Default video nodes ===
[[File:defaultnodes.jpg|right|500px|frame|The standard video nodes]]
You can find a copy of the default nodes in one of two ways. One is to download all or some of the nodes you want form https://github.com/xbmc/xbmc/tree/master/system/library .

The other way is to copy the Kodi system default nodes that come with Kodi, shown in the table below:

{| border="1" cellpadding="4" class="prettytable"
! '''Operative system'''
! '''default nodes paths'''
|-
|'''Android''' || /data/data/org.xbmc.kodi/cache/apk/assets/system/library/
|-
|'''iOS''' - Varied || /Applications/Kodi.frappliance/KodiData/KodiHome/system/library/ /Applications/Kodi.app/KodiData/KodiHome/system/library/
|-
|'''Linux''' || /usr/share/Kodi/system/library/
|-
|'''Mac OS X''' || /Applications/Kodi.app/Contents/Resources/Kodi/system/library/
|-
|'''Windows (32bit)''' || C:\Program Files\Kodi\system\library\
|-
|'''Windows (64bit)''' || C:\Program Files (x86)\Kodi\system\library\
|}

To understand nodes a little better, lets take a look at one of the defaults. As an example take a quick look at the ''video/movies/years.xml'' node in its simplest form:

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="3" type="filter">
<label>562</label>
<icon>DefaultYear.png</icon>
<content>movies</content>
<group>years</group>
</node>
</syntaxhighlight>

As you can see we are using standard xml format here so nothing too complicated.

=== XML node components ===
'''Order''' = This is the order that you want to show the nodes. Starts at 1 for the top and goes sequentially so 2 will be the next node down.

'''Label''' = This is the text that will show for the node. In this case it is pointing to an ID in the strings.po file (for transltion purposes) It can also just be any String you want, just type some text instead of the id number.

'''Path''' = This can be any valid Kodi path, such as a file path. This includes internal Kodi DB paths, such as <code>videodb://movies/genres/</code>. For more on internal paths, see '''[[Opening Windows and Dialogs]]'''.

'''Icon''' = Pretty self explanatory really, this is the icon that will show when the node is navigated over.

== Manually creating or editing a custom node ==
So now we understand how the default nodes work, lets have a look at making a custom node. Custom nodes live inside your [[Userdata]] folder. To create custom nodes, the first step is to copy the whole of the default node file structure from the default library folder to a new folder called ''library'' inside your [[Userdata]] folder.

So, in the case of Windows, copy the 'video' and the 'video_flat' folders from ''C:\Program Files (x86)\Kodi\system\library'' to ''%appdata%\Kodi\userdata\library''.

Why the whole lot? Well, currently it seems that when you have a custom video node in your userdata folder, it's assumed that you are customizing the node structure, and that therefore any nodes that are missing are missing intentionally.

Having copied the node structure, we can now create a new xml file under the relevant directory.

In a vanilla install with the confluence skin, custom nodes in ''/video'' will appear in the sub-list of the Video main menu item.

Custom nodes in the ''/video/movies'' will appear in the sub-list of 'Movies' which in turn appears in the sub-list of Video.

In other skins (notably, Aeon Nox), custom main-menu items can be set to a custom video node, meaning that you can use your custom video nodes to have a main-menu item for your collection of post-modern european arthouse anime, if you so wish.

For now, we're going to place our node under

/userdata/library/video/

Let's call it Custom_Motor_dvds.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="10" type="filter">
<label>(Custom) Motor DVDs</label>
<content>movies</content>
<match>all</match>
<icon>DefaultCars.png</icon>
<limit>20</limit>
<rule field="path" operator="contains"><value>ExtremeSports/Cars/</value></rule>
</node>

As you can see as well as changing the order, we have a few more xml tags this time:

'''Type''' = Can be folder or filter, folder requires path to be set.

'''Match''' = Specifies how many rules should match. In this case we are matching all rules.

'''Rule''' = Any rule created with the smart playlist editor. (See [[Smart playlists]])

'''Limit''' = Limit the number of results returned (can be excluded altogether for unlimited)

[[File:motordvds.jpg|500px|Custom node in action]]

So there you have it, a simple path filter for our Motor DVDs.

One thing that you may want to do now is edit your "Title" xml file to remove the motor dvds from the main movie library. Though if you are attempting to setup a main movie entrypoint for a path labeled "Movies" it may be best to simply hide the default Movies entry from the main menu and create a "Custom Movies" video node that points to your specific path. Still you can remove paths using the DoesNotContain operator:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="2" type="filter">
<label>Movies</label>
<content>movies</content>
<icon>DefaultMovieTitle.png</icon>
<match>all</match>
<rule field="path" operator="doesnotcontain"><value>/ExtremeSports/Cars/</value></rule>
</node>

There are many other rules you can apply, a simple way to find them is to have a go with the smart playlist editor and copy the rule from the resulting xml playlist. There are many possibilities, you could create a rule for any of the database fields such as genre or year, use paths or combine rules together.

[[File:customnodes.jpg|500px|Various custom video nodes]]

== Manually creating or editing a custom parent node ==
You can also create a nested node structure as can be observed in the "unflattened" default structure from [[Video_nodes|above]] (under video).
Then you simply create a folder containing valid xml node files and also include a "index.xml" file that looks like this (which of course can be adapted to the type of media required):

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="1" visible="Library.HasContent(Movies)">

<label>342</label>
<icon>DefaultMovies.png</icon>
</node>

== Examples ==
[[File:PatK_Nodes.jpg|500px]]

== See also ==
* [[Music_nodes| Music nodes]]
* [[Custom home items]]
* [[Smart playlists]]
* [[Video library tags]]

== Notes ==

{{Updated|16}}

[[Category:Video library]]
[[Category:Manual]]

Music nodes

2022-04-14T00:53:07Z

Gade: /* XML node components */

{{mininav|[[Music library]]|[[:Category:Music_library|Category:Music Library]] }}

<section begin="intro" />Music nodes are defined views that are used to organize your media from the music menu. In the past Kodi has had a number of standard nodes such as Artist, Album, Tracks that were hard coded. As of v15 Isengard, Kodi introduces the ability to customize these nodes using an XML file. Using XML files really gives great flexibility in how you display your media and lets you browse large collections quickly. Don't want your country music in your main album node... exclude it. Want a genre in a separate node, create it. Don't like how Top 100 Played is presented, change it.

To get full functionality from custom nodes, you need to use a skin that allows you to deploy them as you would like (e.g. latest builds of Aeon Nox). Confluence will show your nodes, but doesn't allow you to decide exactly where.<section end="intro" />

== Audio node editor add-on ==
{{main|Add-on:Library Node Editor}}
Users can now create and edit audio nodes from within {{kodi}} thanks to the add-on [[Add-on:Library Node Editor|Library Node Editor]].

== Technical documentation ==

=== Default audio nodes ===
[[File:defaultaudionodes.jpg|right|500px|frame|The standard audio nodes]]
You can find a copy of the default nodes in one of two ways. One is to download all or some of the nodes you want form https://github.com/xbmc/xbmc/tree/master/system/library .

The other way is to copy the Kodi system default nodes that come with Kodi, shown in the table below:

{| border="1" cellpadding="4" class="prettytable"
! '''Operative system'''
! '''default nodes paths'''
|-
|'''Android''' || ?
|-
|'''iOS''' - Varied || /Applications/XBMC.frappliance/XBMCData/XBMCHome/system/library/ /Applications/XBMC.app/XBMCData/XBMCHome/system/library/
|-
|'''Linux''' || /usr/share/xbmc/system/library/
|-
|'''Mac OS X''' || /Applications/XBMC.app/Contents/Resources/XBMC/system/library/
|-
|'''Windows (32bit)''' || C:\Program Files\XBMC\system\library\
|-
|'''Windows (64bit)''' || C:\Program Files (x86)\XBMC\system\library\
|}

To understand nodes a little better, lets take a look at one of the defaults. As an example take a quick look at the ''system/library/music/genres.xml'' node in its simplest form:

<syntaxhighlight lang="XML" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="1" type="filter" visible="Library.HasContent(Music)">
<label>135</label>
<icon>DefaultMusicGenres.png</icon>
<content>artists</content>
<group>genres</group>
</node>
</syntaxhighlight>

As you can see we are using standard XML format here so nothing too complicated.

=== XML node components ===
'''Order''' = This is the order that you want to show the nodes. Starts at 1 for the top and goes sequentially so 2 will be the next node down.

'''Label''' = This is the text that will show for the node. In this case it is pointing to an ID in the strings.po file (for translation purposes) It can also just be any String you want, just type some text instead of the id number.

'''Path''' = This can be any valid Kodi path, such as a file path. This includes internal Kodi DB paths, such as <code>musicdb://recentlyaddedalbums</code>. For more on internal paths, see '''[[Opening Windows and Dialogs]]'''.

'''Icon''' = Pretty self explanatory really, this is the icon that will show when the node is navigated over.

== Manually creating or editing a custom node ==
So now we understand how the default nodes work, lets have a look at making a custom node. Custom nodes live inside your [[Userdata]] folder. To create custom nodes, the first step is to copy the whole of the default node file structure from the default library folder to a new folder called ''library'' inside your [[Userdata]] folder.

So, in the case of Windows, copy the 'music' folder from ''C:\Program Files (x86)\XBMC\system\library'' to ''%appdata%\XBMC\userdata\library''.

Having copied the node structure, we can now create a new xml file under the relevant directory.

In a vanilla install with the confluence skin, custom nodes in ''/music'' will appear in the sub-list of the Music main menu item.

For now, we're going to place our node under

/userdata/library/music/

Let's call it Custom_Genre_Country.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<node order="10" type="filter">
<label>(Custom) Genre Country</label>
<content>artists</content>
<match>all</match>
<rule field="genre" operator="is">
<value>Country</value>
</rule>
</node>

As you can see as well as changing the order, we have a few more xml tags this time:

'''Type''' = Can be folder or filter, folder requires path to be set.

'''Match''' = Specifies how many rules should match. In this case we are matching all rules.

'''Rule''' = Any rule created with the smart playlist editor. (See [[Smart playlists]])

'''Limit''' = Limit the number of results returned (can be excluded altogether for unlimited)

[[File:Custommusicnodecountry.png|500px|Custom node in action]]

So there you have it, a simple genre filter for country music.

There are many other rules you can apply, a simple way to find them is to have a go with the smart playlist editor and copy the rule from the resulting xml playlist. There are many possibilities, you could create a rule for any of the database fields such as genre or year, use paths or combine rules together.

A more advanced idea would be a node structure so you could browse your albums by the first letter like this:

[[File:Atoznodes.jpg|500px|A more advanced custom node]]

== See also ==
* [[Custom home items]]
* [[Smart playlists]]
* [[Video nodes]]

== Notes ==

{{Top}}

{{Isengard updated}}
[[Category:Music library|Nodes]]
[[Category:Manual]]

Radio button control

2022-04-14T00:52:18Z

Gade: /* Available tags */

<section begin="main content" />
The radio button control is used for creating push button on/off settings in Kodi. You can choose the position, size, and look of the button. When the user clicks on the radio button, the state will change, toggling the extra textures (textureradioon and textureradiooff). Used for settings controls.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="radiobutton" id="2">
<description>My first radiobutton control</description>
<type>radiobutton</type>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<texturefocus>myfocustexture.png</texturefocus>
<texturenofocus>mynormaltexture.png</texturenofocus>
<textureradioonfocus colordiffuse="FFFFAAFF">myradiobutton.png</textureradioonfocus>
<textureradioonnofocus colordiffuse="FFFFAAFF">myradiobutton.png</textureradioonnofocus>
<textureradioofffocus colordiffuse="FFFFAAFF">myradiobutton_nf.png</textureradioofffocus>
<textureradiooffnofocus colordiffuse="FFFFAAFF">myradiobutton_nf.png</textureradiooffnofocus>
<selected>Player.Paused</selected>
<onclick>PlayerControls(Pause)</onclick>
<label>29</label>
font12
<textcolor>FFFFFFFF</textcolor>
<focusedcolor>FFFFFFFF</focusedcolor>
<disabledcolor>80FFFFFF</disabledcolor>
<align>left</align>
<aligny>center</aligny>
<textoffsetx>4</textoffsetx>
<textoffsety>5</textoffsety>
<pulseonselect>false</pulseonselect>
<onfocus></onfocus>
<onunfocus></onunfocus>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''texturefocus'''
|
Specifies the image file which should be displayed when the button has focus. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''texturenofocus'''
| Specifies the image file which should be displayed when the button does not have focus.
|-
| '''textureradioonfocus'''
| Specifies the image file which should be displayed for the radio button portion when it's the button is on and focused. This texture is positioned on the right of the button – it's positioned 24 pixels from the right edge of the button, and 8 pixels above the center vertically.
|-
| '''textureradioonnofocus'''
| Specifies the image file which should be displayed for the radio button portion when it's the button is on and unfocused. This texture is positioned on the right of the button – it's positioned 24 pixels from the right edge of the button, and 8 pixels above the center vertically.
|-
| '''textureradioon'''
| A shortcut to set both of the above textures to the same image file.
|-
| '''textureradioondisabled'''
| Specifies the image file which should be displayed for the radio button portion when the button is on and disabled.
|-
| '''textureradioofffocus'''
| Specifies the image file which should be displayed for the radio button portion when the button is off and focused.
|-
| '''textureradiooffnofocus'''
| Specifies the image file which should be displayed for the radio button portion when the button is off and unfocused.
|-
| '''textureradiooff'''
| A shortcut to set both of the above textures to the same image file.
|-
| '''textureradioondisabled'''
| Specifies the image file which should be displayed for the radio button portion when the button is off and disabled.
|-
| '''label'''
| The label used on the button. It can be a link into strings.po, or an actual text label.
|-
| '''label2'''
| Optional. Will display an 'on' or 'off' label. Only available if you specify an empty radiowidth and radioheight.
|-
| '''font'''
| Font used for the button label. From fonts.xml.
|-
| '''textcolor'''
| Color used for displaying the button label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''focusedcolor'''
| Color used for the button label when the button has in focus. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''disabledcolor'''
| Color used for the button label if the button is disabled. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''align'''
| Label horizontal alignment on the button. Defaults to left, can also be center or right.
|-
| '''aligny'''
| Label vertical alignment on the button. Defaults to top, can also be center.
|-
| '''textoffsetx'''
| Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
|-
| '''textoffsety'''
| Amount to offset the label from the top edge of the button when using top alignment.
|-
| '''textwidth'''
| Will truncate any text that's too long.
|-
| '''selected'''
| The boolean condition that when met will cause the control to become selected. [[Conditional_visibility|see here for more information.]]
|-
| '''onclick'''
| The function to perform when the radio button is clicked. Should be a [[Built-in_scripting|built in function.]]
|-
| '''radioposx'''
| X offset of the ''dot'' or radio button itself
|-
| '''radioposy'''
| Y offset of the ''dot'' or radio button itself
|-
| '''radiowidth'''
| Width in Pixels of the ''dot'' or radio button itself
|-
| '''radioheight'''
| Height in Pixels of the ''dot'' or radio button itself
|-
| '''onfocus'''
| Specifies the action to perform when the button is focused. Should be a built in function. The action is performed after any focus animations have completed. [[List_of_built-in_functions|See here for more information.]]
|-
| '''onunfocus'''
| Specifies the action to perform when the button loses focus. Should be a built in function.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Fixed List Container

2022-04-14T00:52:01Z

Gade: /* Available tags */

The '''Fixed List Container''' is one of several containers used to display items from file lists in a certain way. It is identical to the [[List Container]] with one exception: the focus area has a fixed position, while the list appears to move beneath it in response to directional input. Thus, moving up or down scrolls the items, not the focused position. As with all container controls, the [[Container Item Layout|layout]] of the items within the control is very flexible.

<syntaxhighlight lang="xml">
<control type="fixedlist" id="50">
<description>My first fixed list container</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
<viewtype label="3D list">list</viewtype>
<orientation>vertical</orientation>
<pagecontrol>25</pagecontrol>
<scrolltime tween="sine" easing="out">200</scrolltime>
<autoscroll>true</autoscroll>
<focusposition>4</focusposition>
<movement>6</movement>
<itemlayout width="650" height="29">
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</itemlayout>
<focusedlayout height="29" width="650">
<control type="image">
<width>485</width>
<height>29</height>
<left>0</left>
<top>0</top>
<visible>Control.HasFocus(50)</visible>
<texture>list-focus.png</texture>
</control>
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</focusedlayout>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[default control tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important as this file is written in XML, a language where tag names are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''viewtype'''
| The type of view, valid values are: <code>list</code>, <code>icon</code>, <code>wide</code>, <code>wrap</code>, <code>biglist</code>, <code>bigicon</code>, <code>bigwide</code>, <code>bigwrap</code>, <code>info</code> and <code>biginfo</code>. The label attribute indicates the label that will be used in the "View As" control within the GUI. It is localizable via strings.po. ''viewtype'' has no effect on the view itself. It is used by Kodi when switching skins to automatically select a view with a similar layout. Skinners should try to set ''viewtype'' to describe the layout as best as possible.
|-
| '''orientation'''
| The orientation of the list, defaults to vertical.
|-
| '''pagecontrol'''
| Used to set the <id> of the page control used to control this list.
|-
| '''scrolltime'''
| The time (in milliseconds) to scroll from one item to another, defaults to 200ms. The list will scroll smoothly from one item to another as needed, or setting it to zero to disables the smooth scrolling effect. The scroll movement can be further adjusted by selecting one of the available [[Tweeners|tween]] methods.
|-
| '''focusposition'''
| Specifies the focus position (from 0 -> number of displayable items - 1). The focused position doesn't change—instead, the items move up or down (or left and right) through the focus area.
|-
| '''movement'''
| This will make the focused position scroll again at the end of the list. (ie. <movement>6</movement> if there are only 6 items below the focus, the focus moves down to the bottom)
|-
| '''itemlayout'''
| Specifies the layout of items in the list and requires the height attribute to be set in a vertical list, or the width attribute set for a horizontal one. The <itemlayout> then contains as many label and image controls as required. ''See: '''[[Container Item Layout]]'''''
|-
| '''focusedlayout'''
| Specifies the layout of items in the list that have focus and requires the height attribute to be set in a vertical list, or the width attribute set for a horizontal one. The <focusedlayout> then contains as many label and image controls as required. ''See: '''[[Container Item Layout]]'''''
|-
| '''content'''
| Used to set the item content that this list will contain, allowing the skinner to setup a list anywhere they want with a static set of content, as a useful alternative to the <code>grouplist</code> control. ''See: '''[[Static List Content]]'''''
|-
| '''preloaditems'''
| Used in association with the [[Archive:Background Image Loader|Background Image Loader]].
|-
| '''autoscroll'''
| Used to make the container scroll automatically
|}

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Settings Spin Control

2022-04-14T00:51:48Z

Gade: /* Available tags */

<section begin="main content" />
The settings spin control is used in the settings screens for when a list of options can be chosen from using up/down arrows. You can choose the position, size, and look of the spin control. It is basically a cross between the button control and a spin control. It has a label and focus and non focus textures, as well as a spin control on the right.
=== Example ===
<syntaxhighlight lang="xml" enclose="div">
<control type="spincontrolex" id="12">
<description>My first settings spin control</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<spinposx>220</spinposx>
<spinposy>180</spinposy>
<spinwidth>16</spinwidth>
<spinheight>16</spinheight>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<texturefocus>myfocustexture.png</texturefocus>
<texturenofocus>mynofocustexture.png</texturenofocus>
<textureup>myuptexture.png</textureup>
<textureupfocus>myupfocustexture.png</textureupfocus>
<texturedown>mydowntexture.png</texturedown>
<texturedownfocus>mydownfocustexture.png</texturedownfocus>
<textureupdisabled colordiffuse="AAFFAAFF">mydowntexture.png</textureupdisabled>
<texturedowndisabled colordiffuse="AAFFAAFF">mydownfocustexture.png</texturedowndisabled>
<label>46</label>
font12
<textcolor>FFFFFFFF</textcolor>
<disabledcolor>80FFFFFF</disabledcolor>
<align></align>
<aligny></aligny>
<textoffsetx></textoffsetx>
<textoffsety></textoffsety>
<pulseonselect></pulseonselect>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''spinposx'''
| The horizontal position of the spin control for multipage lists. This is offset from the top left of the list.
|-
| '''spinposy'''
| The vertical position of the spin control for multipage lists. This is offset from the top left of the list.
|-
| '''spinwidth'''
| The width of one of the spin control buttons. The textures for this spin control will be scaled to fit this width.
|-
| '''spinheight'''
| The height of one of the spin control buttons. The textures for this spin control will be scaled to fit this height.
|-
| '''texturefocus'''
| Specifies the image file which should be displayed for the control when it has focus. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''texturenofocus'''
| Specifies the image file which should be displayed for the control when it doesn't focus.
|-
| '''textureup'''
| Specifies the image file which should be displayed for the up arrow when it doesn't have focus. It is displayed to the left of the down arrow.
|-
| '''textureupfocus'''
| Specifies the image file which should be displayed for the up arrow when it has focus.
|-
| '''textureupdisabled'''
| Specifies the image file which should be displayed for the up arrow when the button is disabled.
|-
| '''texturedown'''
| Specifies the image file which should be displayed for the down arrow when it is not focused. It is displayed to the right of the up arrow so that it's right edge is <textoffsetx> pixels away from the right edge of the control.
|-
| '''texturedownfocus'''
| Specifies the image file which should be displayed for the down arrow when it has focus.
|-
| '''texturedowndisabled'''
| Specifies the image file which should be displayed for the up arrow when the button is disabled.
|-
| '''label'''
| Either a numeric reference into strings.po (for localization), or a string that will be shown on the left of the control.
|-
| '''font'''
| Font used for the controls label. From fonts.xml.
|-
| '''textcolor'''
| Color used for displaying the label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''disabledcolor'''
| Color used for the label if the control is disabled. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''align'''
| Label horizontal alignment on the control. Defaults to left.
|-
| '''aligny'''
| Label vertical alignment on the control. Defaults to top, can also be center.
|-
| '''textoffsetx'''
| Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
|-
| '''textoffsety'''
| Amount to offset the label from the top edge of the button when using top alignment.
|-
| '''textwidth'''
| Will truncate any text that's too long.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Wrap List Container

2022-04-14T00:51:34Z

Gade: /* Available tags */

<section begin="main content" />
The wrap list container is one of several containers used to display items from file lists in various ways. The wrap list container is the same as the [[List Container]], with two exceptions:

# The focused item is fixed.
# The items "wrap" around once they reach the end.

As with all container controls, the layout of the items within the control is very flexible.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="wraplist" id="50">
<description>My first wraplist container</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
<viewtype label="3D list">list</viewtype>
<orientation>vertical</orientation>
<pagecontrol>25</pagecontrol>
<focusposition>3</focusposition>
<scrolltime tween="sine" easing="out">200</scrolltime>
<autoscroll>true</autoscroll>
<itemlayout width="650" height="29">
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</itemlayout>
<focusedlayout height="29" width="650">
<control type="image">
<width>485</width>
<height>29</height>
<left>0</left>
<top>0</top>
<visible>Control.HasFocus(50)</visible>
<texture>list-focus.png</texture>
</control>
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</focusedlayout>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''viewtype'''
| The type of view. Choices are list, icon, wide, wrap, biglist, bigicon, bigwide, bigwrap, info and biginfo. The label attribute indicates the label that will be used in the "View As" control within the GUI. It is localizable via strings.po. ''viewtype'' has no effect on the view itself. It is used by kodi when switching skin to automatically select a view with a similar layout. Skinners should try to set ''viewtype'' to describe the layout as best as possible.
|-
| '''orientation'''
| The orientation of the list. Defaults to vertical.
|-
| '''pagecontrol'''
| Used to set the <id> of the page control used to control this list.
|-
| '''scrolltime'''
| The time (in ms) to scroll from one item to another. By default, this is 200ms. The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling. The scroll movement can be further adjusted by selecting one of the available [[Tweeners|tween]] methods.
|-
| '''focusposition'''
| Specifies the index (from 0 -> number items displayable - 1) of the focused item. The focused item doesn't move - as the user moves up and down (or left and right) the items scroll instead.
|-
| '''itemlayout'''
| Specifies the layout of items in the list. Requires the height attribute set in a vertical list, and the width attribute set for a horizontal list. The <itemlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''focusedlayout'''
| Specifies the layout of items in the list that have focus. Requires the height attribute set in a vertical list, and the width attribute set for a horizontal list. The <focusedlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''content'''
| Used to set the item content that this list will contain. Allows the skinner to setup a list anywhere they want with a static set of content, as a useful alternative to the grouplist control. [[Static List Content|See here for more information]]
|-
| '''autoscroll'''
| Used to make the container scroll automatically
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

List Container

2022-04-14T00:51:22Z

Gade: /* Available tags */

<section begin="main content" />
The list container is one of several containers used to display items from file lists in various ways. The list container is very flexible - it's only restriction is that it is a list - i.e. a single column or row of items. The layout of the items is very flexible and is up to the skinner.
=== Example ===
<syntaxhighlight lang="XML">
<control type="list" id="50">
<description>My first list container</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
<viewtype label="3D list">list</viewtype>
<orientation>vertical</orientation>
<pagecontrol>25</pagecontrol>
<autoscroll>true</autoscroll>
<scrolltime tween="sine" easing="out">200</scrolltime>
<itemlayout width="650" height="29">
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</itemlayout>
<focusedlayout height="29" width="650">
<control type="image">
<width>485</width>
<height>29</height>
<left>0</left>
<top>0</top>
<visible>Control.HasFocus(50)</visible>
<texture>list-focus.png</texture>
</control>
<control type="image">
<left>5</left>
<top>3</top>
<width>22</width>
<height>22</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="label">
<left>30</left>
<top>3</top>
<width>430</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<align>left</align>
<label>$INFO[ListItem.Label]</label>
</control>
<control type="label">
<left>475</left>
<top>3</top>
<width>300</width>
<height>22</height>
font13
<aligny>center</aligny>
<selectedcolor>green</selectedcolor>
<textcolor>grey</textcolor>
<align>right</align>
<label>$INFO[ListItem.Label2]</label>
</control>
</focusedlayout>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''viewtype'''
| The type of view. Choices are list, icon, wide, wrap, biglist, bigicon, bigwide, bigwrap, info and biginfo. The label attribute indicates the label that will be used in the "View As" control within the GUI. It is localizable via strings.po. ''viewtype'' has no effect on the view itself. It is used by kodi when switching skin to automatically select a view with a similar layout. Skinners should try to set ''viewtype'' to describe the layout as best as possible.
|-
| '''orientation'''
| The orientation of the list. Defaults to vertical.
|-
| '''pagecontrol'''
| Used to set the <id> of the page control used to control this list.
|-
| '''scrolltime'''
| The time (in ms) to scroll from one item to another. By default, this is 200ms. The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling. The scroll movement can be further adjusted by selecting one of the available [[Tweeners|tween]] methods.
|-
| '''itemlayout'''
| Specifies the layout of items in the list. Requires the height attribute set in a vertical list, and the width attribute set for a horizontal list. The <itemlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''focusedlayout'''
| Specifies the layout of items in the list that have focus. Requires the height attribute set in a vertical list, and the width attribute set for a horizontal list. The <focusedlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''content'''
| Used to set the item content that this list will contain. Allows the skinner to setup a list anywhere they want with a static set of content, as a useful alternative to the grouplist control. [[Static List Content|See here for more information]]
|-
| '''preloaditems'''
| Used in association with the [[Archive:Background Image Loader|Background Image Loader]].
|-
| '''autoscroll'''
| Used to make the container scroll automatically
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Panel Container

2022-04-14T00:51:11Z

Gade: /* Available tags */

<section begin="main content" />
The panel container is one of several containers used to display items from file lists in various ways. The panel container is very flexible - it's essentially a multi-column list. The layout of the items is very flexible and is up to the skinner.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="panel" id="52">
<left>190</left>
<top>100</top>
<width>485</width>
<height>425</height>
<onleft>9000</onleft>
<onright>60</onright>
<onup>52</onup>
<ondown>52</ondown>
<scrolltime tween="sine" easing="out">200</scrolltime>
<autoscroll>true</autoscroll>
<viewtype label="536">icon</viewtype>
<pagecontrol>60</pagecontrol>
<include>contentpanelslide</include>
<itemlayout height="150" width="120">
<control type="image">
<left>10</left>
<top>10</top>
<width>100</width>
<height>100</height>
<texture>$INFO[ListItem.Icon]</texture>
</control>
<control type="image">
<left>80</left>
<top>75</top>
<width>32</width>
<height>32</height>
<texture>$INFO[ListItem.Overlay]</texture>
</control>
<control type="label">
<left>0</left>
<top>115</top>
<width>110</width>
<height>22</height>
font13
<selectedcolor>green</selectedcolor>
<align>center</align>
<label>$INFO[ListItem.Label]</label>
</control>
</itemlayout>
<focusedlayout height="150" width="120">
<control type="image">
<width>110</width>
<height>110</height>
<left>5</left>
<top>5</top>
<texture>folder-focus.png</texture>
<animation effect="zoom" end="0,0,120,120" time="100">focus</animation>
</control>
<control type="image">
<left>10</left>
<top>10</top>
<width>100</width>
<height>100</height>
<texture>$INFO[ListItem.Icon]</texture>
<animation effect="zoom" end="5,5,110,110" time="100">focus</animation>
</control>
<control type="image">
<left>80</left>
<top>75</top>
<width>32</width>
<height>32</height>
<texture>$INFO[ListItem.Overlay]</texture>
<animation effect="slide" end="5,5" time="100">focus</animation>
</control>
<control type="label">
<left>0</left>
<top>120</top>
<width>110</width>
<height>22</height>
font13
<selectedcolor>green</selectedcolor>
<align>center</align>
<label>$INFO[ListItem.Label]</label>
</control>
</focusedlayout>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''viewtype'''
| The type of view. Choices are list, icon, wide, wrap, biglist, bigicon, bigwide, bigwrap, info and biginfo. The label attribute indicates the label that will be used in the "View As" control within the GUI. It is localizable via strings.po. ''viewtype'' has no effect on the view itself. It is used by kodi when switching skin to automatically select a view with a similar layout. Skinners should try to set ''viewtype'' to describe the layout as best as possible.
|-
| '''orientation'''
| The orientation of the panel. Defaults to vertical.
|-
| '''pagecontrol'''
| Used to set the <id> of the page control used to control this panel.
|-
| '''scrolltime'''
| The time (in ms) to scroll from one item to another. By default, this is 200ms. The panel will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling. The scroll movement can be further adjusted by selecting one of the available [[Tweeners|tween]] methods.
|-
| '''itemlayout'''
| Specifies the layout of items in the list. Requires both width and height attributes set. The <itemlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''focusedlayout'''
| Specifies the layout of items in the list that have focus. Requires both width and height attributes set. The <focusedlayout> then contains as many label and image controls as required. [[Container Item Layout|See here for more information.]]
|-
| '''content'''
| Used to set the item content that this panel will contain. Allows the skinner to setup a panel anywhere they want with a static set of content, as a useful alternative to the grouplist control. [[Static List Content|See here for more information]]
|-
| '''preloaditems'''
| Used in association with the background image loader. [[Background Image Loader|See here for more information]]
|-
| '''autoscroll'''
| Used to make the container scroll automatically
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Button control

2022-04-14T00:50:44Z

Gade: /* Available tags */

<section begin="main content" />
The button control is used for creating push buttons in {{kodi}}. You can choose the position, size, and look of the button, as well as choosing what action(s) should be performed when pushed.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="button" id="1">
<description>My first button control</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<texturefocus colordiffuse="FFFFAAFF">myfocustexture.png</texturefocus>
<texturenofocus colordiffuse="FFFFAAFF">mynormaltexture.png</texturenofocus>
<label>29</label>
<wrapmultiline>true</wrapmultiline>
font12
<textcolor>FFFFFFFF</textcolor>
<focusedcolor>FFFFFFFF</focusedcolor>
<disabledcolor>80FFFFFF</disabledcolor>
<invalidcolor>FFFFFFFF</invalidcolor>
<align></align>
<aligny></aligny>
<textoffsetx></textoffsetx>
<textoffsety></textoffsety>
<pulseonselect></pulseonselect>
<onclick>ActivateWindow(MyVideos)</onclick>
<onfocus></onfocus>
<onunfocus></onunfocus>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default_control_tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''texturefocus'''
| Specifies the image file which should be displayed when the button has focus. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''texturenofocus'''
| Specifies the image file which should be displayed when the button does not have focus.
|-
| '''label'''
| The label used on the button. It can be a link into strings.po, or an actual text label.
|-
| '''font'''
| Font used for the button label. From fonts.xml.
|-
| '''textcolor'''
| Color used for displaying the button label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''focusedcolor'''
| Color used for the button label when the button has in focus. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''disabledcolor'''
| Color used for the button label if the button is disabled. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''invalidcolor'''
| Color used for the button if the user entered some invalid value. In AARRGGBB hex format or a name from the [[Colour themes|colour theme.]]
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''angle'''
| The angle the text should be rendered at, in degrees. A value of 0 is horizontal.
|-
| '''align'''
| Label horizontal alignment on the button. Defaults to left, can also be center or right.
|-
| '''aligny'''
| Label vertical alignment on the button. Defaults to top, can also be center.
|-
| '''textoffsetx'''
| Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
|-
| '''textoffsety'''
| Amount to offset the label from the top edge of the button when using top alignment.
|-
| '''textwidth'''
| Will truncate any text that's too long.
|-
| '''onclick'''
| Specifies the action to perform when the button is pressed. Should be a built in function. [[Built-in_scripting|See here for more information.]] You may have more than one <onclick> tag, and they'll be executed in sequence.
|-
| '''onfocus'''
| Specifies the action to perform when the button is focused. Should be a built in function. The action is performed after any focus animations have completed. [[Built-in_scripting|See here for more information.]]
|-
| '''onunfocus'''
| Specifies the action to perform when the button loses focus. Should be a built in function.
|-
| '''wrapmultiline'''
| Will wrap the label across multiple lines if the label exceeds the control width.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Fade label control

2022-04-14T00:50:28Z

Gade: /* Tag descriptions */

<section begin="main content" />
The fade label control is used for displaying multiple pieces of text in the same space in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed. The first piece of information to display fades in over 50 frames, then scrolls off to the left. Once it is finished scrolling off screen, the second piece of information fades in and the process repeats. A fade label control is not supported in a list container.
=== Example ===
<syntaxhighlight lang=xml enclose="div">
<control type="fadelabel" id="1">
<description>My First fadelabel</description>
<left>80</left>
<top>60</top>
<width>250</width>
<visible>true</visible>
<scrollout>true</scrollout>
<pauseatend>200</pauseatend>
<label>6</label>
<info>MusicPlayer.Genre</info>
<info>MusicPlayer.Artist</info>
<info>MusicPlayer.Album</info>
<info>MusicPlayer.Year</info>
font14
<textcolor>FFB2D4F5</textcolor>
<textoffsetx>20</textoffsetx>
<scroll>true</scroll>
<randomize>true</randomize>
</control>
</syntaxhighlight>

=== Tag descriptions ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tags !! Description
|-
| '''label'''
|
Specifies the text which should be drawn. You should specify an entry from the strings.po here, however you may also specify a piece of text yourself if you wish, though ofcourse it will not be localisable. [[Label Parsing|You may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.]]
|-
| '''info'''
|
Specifies the information that should be presented. Kodi will auto-fill in this info in place of the <label>. [[InfoLabels|See here for more information.]]
|-
| '''font'''
| Specifies the font to use from the font.xml file.
|-
| '''textcolor'''
| Specified the color the text should be, in hex AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''textoffsetx'''
| Specify the offset from the left edge that the text should be rendered at when static (not scrolling). The scrolling text will still scroll using the full <width> of the control.
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''angle'''
| Specifies the angle at which the text should be drawn, measured counter clockwise from the horizontal.
|-
| '''scrollout'''
| If set to False the fadelabel will only scroll until the last char is to the right side of the width of the fadelabel instead of all the way out to the left. Defaults to true
|-
| '''pauseatend'''
| Specifies the time that the text will wait until it fades away before it scrolls again or moves to the next item.
|-
| '''resetonlabelchange'''
| If set to false the fadelabel will not reset the scrolling offset when the label's content changes. Useful if you have things such as the play time (in seconds) inside a fadelabel. Defaults to true.
|-
| '''scrollspeed'''
| Scroll speed of text in pixels per second. Defaults to 60.
|-
| '''scroll'''
| If set to false, the labels won't scroll. Defaults to true.
|-
| '''randomize'''
| If set to true, the labels will be displayed in a random order. Defaults to false.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Settings Slider Control

2022-04-14T00:50:10Z

Gade: /* Available tags */

The settings slider control is used in the settings screens for when an option is best specified on a sliding scale. You can choose the position, size, and look of the slider control. It is basically a cross between the button control and a slider control. It has a label and focus and non focus textures, as well as a slider control on the right.
=== Example ===
<syntaxhighlight lang="xml" enclose="div">
<control type="sliderex" id="12">
<description>My first settings slider control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<sliderwidth>100</sliderwidth>
<sliderheight>20</sliderheight>
<visible>true</visible>
<texturefocus>myfocustexture.png</texturefocus>
<texturenofocus>mynofocustexture.png</texturenofocus>
<texturebg>mybackgroundtexture.png</texturebg>
<textureslidernib>mydowntexture.png</textureslidernib>
<textureslidernibfocus>mydownfocustexture.png</textureslidernibfocus>
<info></info>
<label>46</label>
font12
<textcolor>FFFFFFFF</textcolor>
<disabledcolor>80FFFFFF</disabledcolor>
<textoffsetx></textoffsetx>
<pulseonselect></pulseonselect>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tag !! Description
|-
| '''sliderwidth'''
| Specifies the width of the slider portion of the slider control (ie without the text value, if present). The texture image for the slider background will be resized to fit into this width, and the nib textures will be resized by the same amount.
|-
| '''sliderheight'''
| Specifies the height of the slider portion of the slider control (ie without the text value, if present). The texture image for the slider background will be resized to fit into this height, and the nib textures will be resized by the same amount.
|-
| '''texturefocus'''
|
Specifies the image file which should be displayed for the control when it has focus. [[Texture Attributes|See here for additional information about textures.]]
|-
| '''texturenofocus'''
| Specifies the image file which should be displayed for the control when it doesn't focus.
|-
| '''texturebg'''
| Specifies the image file which should be displayed in the background of the slider portion of the control. Will be positioned so that the right edge is <textoffsetx> away from the right edge of the <texturefocus> image, and centered vertically.
|-
| '''textureslidernib'''
| Specifies the image file which should be displayed for the slider nib.
|-
| '''textureslidernibfocus'''
| Specifies the image file which should be displayed for the slider nib when it has focus.
|-
| '''label'''
| Either a numeric reference into strings.po (for localization), or a string that will be shown on the left of the control.
|-
| '''font'''
| Font used for the controls label. From fonts.xml.
|-
| '''textcolor'''
| Color used for displaying the label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''disabledcolor'''
| Color used for the label if the control is disabled. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''textoffsetx'''
| Amount to offset the label from the left edge of the control.
|-
| '''textwidth'''
| Will truncate any text that's too long.
|-
| '''info'''
|
Specifies the information that the slider controls. [[InfoLabels|See here for more information.]]
|}

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Label Parsing

2022-04-14T00:49:55Z

Gade: /* How the parsing works */

In label controls, fadelabel controls, built-in functions as well as in the LCD label definition files you can specify more than one piece of information to be displayed in a single line of text (or across multiple lines of text) by using the $INFO, $ESCINFO[] and $LOCALIZE keywords in a <label> tag. In addition to this, you can use the [[Label Formatting]] syntax to specify color and style information for the text (changeable within a single label).

=== Example ===
<syntaxhighlight lang="xml" enclose="div">
<label>A good example of a $INFO[MusicPlayer.Title,song title: , $COMMA and a]$INFO[MusicPlayer.Artist, song artist:]</label>
</syntaxhighlight>

<syntaxhighlight lang="xml" enclose="div">
<label>$LOCALIZE[31005]</label>
</syntaxhighlight>

<syntaxhighlight lang="xml" enclose="div">
<label>The following will be localized from an addons strings - $ADDON[addon.id.here 32001]</label>
</syntaxhighlight>

=== How the parsing works ===

# Kodi runs through and replaces any $LOCALIZE[number] blocks with the real string from strings.po.
# Kodi then runs through and translates the $INFO[infolabel,prefix,postfix] blocks from left to right.
# If the Info manager returns an empty string from the infolabel, then nothing is rendered for that block.
# If the Info manager returns a non-empty string from the infolabel, then Kodi prints the prefix string, then the returned infolabel information, then the postfix string. Note that any $COMMA fields are replaced by real commas, and $$ is replaced by $.
# Any pieces of information outside of the $INFO blocks are rendered unchanged.

So, in the above example, if nothing is playing then the label will print:
A good example of a 
If a song is playing but it has no Title (ie MusicPlayer.Title returns an empty string) but does have an artist, it will return:
A good example of a song artist: <Artist> 
If a song is playing that has title and artist information, it will return:
A good example of a song title: <Title>, and a song artist: <Artist>

$ESCINFO[] should be used when passing an infolabel to a built-in function, when this infolabel is likely to contain commas (,) and/or quotes (").

eg: PlayMedia($INFO[ListItem.Path]) might return: PlayMedia(/some/path/with_a_file_that_includes,a_comma.avi)

This will be read by the builtin function generator as PlayMedia called with 2 parameters: "/some/path/with_a_file_that_includes" and "a_comma.avi".

If you use PlayMedia($ESCINFO[ListItem.Path]) however, it will make sure that whatever is returned by the infolabel is sent on to the builtin as a single parameter.

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Toggle button control

2022-04-14T00:49:34Z

Gade: /* Available tags */

<section begin="main content" />
The toggle button control is used for creating buttons that have 2 states. You can choose the position, size, and look of the button. When the user clicks on the toggle button, the state will change, toggling the extra textures (alttexturefocus and alttexturenofocus). Used for controls where two states are needed (pushed in and pushed out for instance).
=== Example ===
<syntaxhighlight lang="xml" enclose="div">
<control type="togglebutton" id="25">
<description>My first togglebutton control</description>
<left>80</left>
<top>60</top>
<width>250</width>
<height>200</height>
<visible>true</visible>
<colordiffuse>FFFFFFFF</colordiffuse>
<texturefocus>myfocustexture.png</texturefocus>
<texturenofocus>mynormaltexture.png</texturenofocus>
<alttexturefocus>myselectedTexture.png</alttexturefocus>
<alttexturenofocus>myselectedTexture_nf.png</alttexturenofocus>
<usealttexture>!Player.IsPaused</usealttexture>
<label>29</label>
<altlabel>29</altlabel>
font12
<textcolor>FFFFFFFF</textcolor>
<disabledcolor>80FFFFFF</disabledcolor>
<align>left</align>
<aligny>center</aligny>
<textoffsetx>4</textoffsetx>
<textoffsety>5</textoffsety>
<pulseonselect>false</pulseonselect>
<onclick>Player.Pause</onclick>
<onfocus></onfocus>
<onunfocus></onunfocus>
<onup>2</onup>
<ondown>3</ondown>
<onleft>1</onleft>
<onright>1</onright>
<wrapmultiline>false</wrapmultiline>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''texturefocus'''
|
Specifies the image file which should be displayed when the button has focus. [[Texture Attributes|See here for additional information about texture tags.]]
|-
| '''texturenofocus'''
| Specifies the image file which should be displayed when the button does not have focus.
|-
| '''alttexturefocus'''
| Specifies the image file which should be displayed when the toggle button is in it's selected state. This texture replaces the <texturefocus> texture when the toggle button is selected.
|-
| '''alttexturenofocus'''
| Specifies the image file which should be displayed when the button is in it's selected state but unfocused.
|-
| '''usealttexture'''
|
Specifies the conditions under which the Alternative Textures should be shown. Some toggle button controls are handled by Kodi internally, but any extra ones that the skinner has can be controlled using this tag. [[Conditional Visibility|See here for more information.]]
|-
| '''label'''
| The label used on the button. It can be a link into strings.po, or an actual text label.
|-
| '''altlabel'''
| The alternate label used on the button. It can be a link into strings.po, or an actual text label.
|-
| '''altclick'''
| The alternate action to perform when the button is pressed. Should be a built in function. [[List of Built In Functions|See here for more information.]] You may have more than one <altclick> tag, and they'll be executed in sequence.
|-
| '''font'''
| Font used for the button label. From fonts.xml.
|-
| '''textcolor'''
| Color used for displaying the button label. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''disabledcolor'''
| Color used for the button label if the button is disabled. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text. In AARRGGBB hex format, or a name from the [[Colour themes|colour theme.]]
|-
| '''align'''
| Label horizontal alignment on the button. Defaults to left, can also be center or right.
|-
| '''aligny'''
| Label vertical alignment on the button. Defaults to top, can also be center.
|-
| '''textoffsetx'''
| Amount to offset the label from the left (or right) edge of the button when using left or right alignment.
|-
| '''textoffsety'''
| Amount to offset the label from the top edge of the button when using top alignment.
|-
| '''textwidth'''
| Will truncate any text that's too long.
|-
| '''onclick'''
|
Specifies the action to perform when the button is pressed. Should be a built in function. [[List of Built In Functions|See here for more information.]] You may have more than one <onclick> tag, and they'll be executed in sequence.
|-
| '''onfocus'''
|
Specifies the action to perform when the button is focused. Should be a built in function. The action is performed after any focus animations have completed. [[List of Built In Functions|See here for more information.]]
|-
| '''onunfocus'''
|
Specifies the action to perform when the button loses focus. Should be a built in function.
|-
| '''wrapmultiline'''
|
Allows wrapping on the label across multiple lines. Defaults to false.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Plugin sources

2022-04-14T00:48:48Z

Gade: /* Interacting with Kodi */

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}

Plugin sources are [[Add-on development|add-ons for Kodi]] that provide a media listing for the user. They are currently written in python, and can provide video, music, image or executable content. Once a user installs your plugin source, it will automatically show up in the appropriate section(s) within Kodi based on the content it provides.

== Basic overview ==
When the user clicks on your plugin source, your python plugin gets called, allowing you to fetch a listing of media and return it for Kodi to display. You may return either media items directly (for immediate playback) or may return folder items that contain links back into your plugin source. When the user clicks on a media item it'll start playing straight away, just like any other media. When the user clicks on a folder that you provide, your plugin will be called again with information on what folder item was clicked on given in the arguments. You may then return a different listing of media content and folders as required.

== What Kodi requires for your add-on ==
For Kodi to know what to do with your add-on, we require your plugin, and an addon.xml file which describes your plugin source. See [[Add-on development|here]] for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends Kodi via the xbmc.python.pluginsource extension point. The layout of the XML describing this extension point is as follows:

<syntaxhighlight lang="xml" enclose="div">
<extension point="xbmc.python.pluginsource"
library="myplugin.py">
<provides>image video</provides>
</extension>
</syntaxhighlight>

The library attribute provides the file of the python plugin that contains the main entry point of your plugin. The <provides> element is a whitespace separated list of image, video, audio, executable. There is a [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.python/pluginsource.xsd schema available here] to check you have your XML correctly defined.

== Interacting with Kodi ==
The main form of interacting with Kodi will be parsing what Kodi feeds you in terms of arguments to your plugin to find out what "folder" the user wants to retrieve, and then returning items to Kodi as you construct them. Given that your plugin can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.po file (in resources/language/resurce.language.<name_of_language>/strings.po) which associates integer id's with each label. Kodi then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the '''getString''' function in the xbmcaddon module.

Your plugin only runs while it's retrieving a listing - once it has finished the listing it is terminated. Thus, if you wish to store state information, you can do so either in the URLs you return to Kodi (for different folders for instance) or by storing information in a settings file. In addition, you may have particular configuration settings for your addon which can also be accessed via the settings functions in the xbmcaddon module.

If your plugin can provide several content types, Kodi will pass a 'content_type' parameter to the plugin when listing the root directory. This can be used to only return content of the requested type.

== See also ==

'''Development:'''
* [[Add-on development]]
* [[Python development]]

[[Category:Add-on development]]
[[Category:Development]]

Plugin sources

2022-04-14T00:47:10Z

Gade: /* Interacting with Kodi */

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}

Plugin sources are [[Add-on development|add-ons for Kodi]] that provide a media listing for the user. They are currently written in python, and can provide video, music, image or executable content. Once a user installs your plugin source, it will automatically show up in the appropriate section(s) within Kodi based on the content it provides.

== Basic overview ==
When the user clicks on your plugin source, your python plugin gets called, allowing you to fetch a listing of media and return it for Kodi to display. You may return either media items directly (for immediate playback) or may return folder items that contain links back into your plugin source. When the user clicks on a media item it'll start playing straight away, just like any other media. When the user clicks on a folder that you provide, your plugin will be called again with information on what folder item was clicked on given in the arguments. You may then return a different listing of media content and folders as required.

== What Kodi requires for your add-on ==
For Kodi to know what to do with your add-on, we require your plugin, and an addon.xml file which describes your plugin source. See [[Add-on development|here]] for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends Kodi via the xbmc.python.pluginsource extension point. The layout of the XML describing this extension point is as follows:

<syntaxhighlight lang="xml" enclose="div">
<extension point="xbmc.python.pluginsource"
library="myplugin.py">
<provides>image video</provides>
</extension>
</syntaxhighlight>

The library attribute provides the file of the python plugin that contains the main entry point of your plugin. The <provides> element is a whitespace separated list of image, video, audio, executable. There is a [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.python/pluginsource.xsd schema available here] to check you have your XML correctly defined.

== Interacting with Kodi ==
The main form of interacting with Kodi will be parsing what Kodi feeds you in terms of arguments to your plugin to find out what "folder" the user wants to retrieve, and then returning items to Kodi as you construct them. Given that your plugin can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.po file (in resources/language/<name_of_language>/strings.po) which associates integer id's with each label. Kodi then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the '''getString''' function in the xbmcaddon module. '''N.B.''' From Kodi 19 onwards, strings.po has been replaced with [[Language_support#What_is_strings.po|strings.po]].

Your plugin only runs while it's retrieving a listing - once it has finished the listing it is terminated. Thus, if you wish to store state information, you can do so either in the URLs you return to Kodi (for different folders for instance) or by storing information in a settings file. In addition, you may have particular configuration settings for your addon which can also be accessed via the settings functions in the xbmcaddon module.

If your plugin can provide several content types, Kodi will pass a 'content_type' parameter to the plugin when listing the root directory. This can be used to only return content of the requested type.

== See also ==

'''Development:'''
* [[Add-on development]]
* [[Python development]]

[[Category:Add-on development]]
[[Category:Development]]

Script subtitles

2022-04-14T00:46:36Z

Gade: /* Interacting with XBMC */

==What Kodi requires for your add-on==
For XBMC to know what to do with your addon, we require your script, and an addon.xml file. See [[Add-on_development|here]] for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends XBMC via the xbmc.python.subtitles extension point. The layout of the XML describing this extension point is as follows:

<syntaxhighlight lang="xml" enclose="div">
<extension point="xbmc.python.subtitles"
library="default.py" />
</syntaxhighlight>

list of extension points and their explanation:

"xbmc.python.script" This is the standard Script extension point

below listed extensions will not appear in the Scripts/Programs window and can only be run via skin shortcuts

"xbmc.python.weather" Used for weather scripts
"xbmc.python.subtitles" Used for subtitle scripts
"xbmc.python.lyrics" Used for lyrics scripts
"xbmc.python.library" Used for skin dependent scripts (e.g. recently added script)

Example of "xbmc.python.subtitles":
<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="script.xbmc.subtitles"
name="XBMC Subtitles"
version="1.7.4"
provider-name="Amet">
<requires>
<import addon="xbmc.python" version="1.0"/>
</requires>
<extension point="xbmc.python.subtitles"
library="default.py" />
<extension point="xbmc.addon.metadata">
<summary lang="en">XBMC Subtitles</summary>
<summary lang="hu">XBMC feliratok</summary>
<description lang="en">Search and download subtitles from OpenSubtitles.org, Podnapisi.net, Sublight.si and Bierdopje.com. Subtitle button on OSD needs to be activated and path set to Kodi Subtitles under System-> Skin-> Addon Scripts</description>
<description lang="hu">Film feliratok keresése letöltése az OpenSubtitles.org, Podnapisi.net, Sublight.si and Bierdopje.com webhelyekról. A dalszöveg OSD gombot aktiválni kell az elérési út megadásával a Beállítások -> Skin -> Szkriptek alatt.</description>
<description lang="sr">Претражи и скини преводе са OpenSubtitles.org, Podnapisi.net, Sublight.si и Bierdopje.com. Дугме за преводе на OSD треба да се активира и изабере Kodi Subtitles у Систем-> Маска-> Скрипт додаци</description>
<platform>all</platform>
</extension>
</addon>

</syntaxhighlight>

== Interacting with XBMC ==
Given that your script can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.po file (in resources/language/<name_of_language>/strings.po) which associates integer id's with each label. XBMC then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the '''getString''' function in the xbmcaddon module.

[[Category:Add-on development]]

Script lyrics

2022-04-14T00:45:19Z

Gade: /* Interacting with XBMC */

{{mininav|[[Development]]|[[Add-on development]]}}
==What Kodi requires for your add-on==
For XBMC to know what to do with your add-on, we require your script, and an addon.xml file. See [[Add-on development|here]] for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends XBMC via the xbmc.python.lyrics extension point. The layout of the XML describing this extension point is as follows:

<syntaxhighlight lang="xml" enclose="div">
<extension point="xbmc.python.lyrics"
library="default.py" />
</syntaxhighlight>

list of extension points and their explanation:

"xbmc.python.script" This is the standard Script extension point

below listed extensions will not appear in the Scripts/Programs window and can only be run via skin shortcuts

"xbmc.python.weather" Used for weather scripts
"xbmc.python.subtitles" Used for subtitle scripts
"xbmc.python.lyrics" Used for lyrics scripts
"xbmc.python.library" Used for skin dependent scripts (e.g. recently added script)

Example of "xbmc.python.lyrics":
<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="script.cu.lyrics"
name="CU Lyrics"
version="0.8.6"
provider-name="Amet">
<requires>
<import addon="xbmc.python" version="1.0"/>
</requires>
<extension point="xbmc.python.lyrics"
library="default.py" />
<extension point="xbmc.addon.metadata">
<summary lang="en">CU Lyrics</summary>
<description lang="en">Search, download and display lyrics from LyricWIKI.org. Downloaded lyrics will be saved in userdata/addon_data.Lyrics button on OSD needs to be activated and path set to CU Lyrics under Settings-> Skin-> Scripts </description>
<platform>all</platform>
</extension>
</addon>
</syntaxhighlight>

== Interacting with XBMC ==
Given that your script can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.po file (in resources/language/<name_of_language>/strings.po) which associates integer id's with each label. XBMC then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the '''getString''' function in the xbmcaddon module.

== See also ==
* [[Add-ons]]
* [[Unofficial add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Addon Settings]]
* [[Add-on repositories]]
* [[Official add-on repository]]

[[Category:Python]]
[[Category:Add-on development]]

Label control

2022-04-14T00:43:28Z

Gade: /* Available tags */

<section begin="main content" />
The label control is used for displaying text in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="label" id="1">
<description>My First label</description>
<left>80</left>
<top>60</top>
<width>250</width>
<visible>true</visible>
<align>center</align>
<aligny>center</aligny>
<scroll>false</scroll>
<label fallback="$LOCALIZE[123]">$INFO[MusicPlayer.Artist]</label>
<angle>30</angle>
<haspath>false</haspath>
font14
<textcolor>FFB2D4F5</textcolor>
<shadowcolor>ff000000</shadowcolor>
<wrapmultiline>false</wrapmultiline>
<scrollspeed>50</scrollspeed>
<scrollsuffix> - </scrollsuffix>
</control>
</syntaxhighlight>

=== Auto size labels ===

Wrapping your label in a grouplist with the auto width and appropriate minium and maximum values. Allows the labels width to dynamically change relevalant to how long the label text is. This allows a image or other control to be alligned to the right of the actual label text no matter how wide the label is.

<syntaxhighlight lang="XML" enclose="div">
<width min="29" max="200">auto</width>
</syntaxhighlight>

Also, simply specifying <width>auto</width> is also supported.

=== Multi-line labels ===
If you want your label control to span multiple lines, you can insert a new line character in your label. For example:

<syntaxhighlight lang="XML" enclose="div">
<label>This will be on the first line[CR]And this will be on the second line</label>
</syntaxhighlight>

Also, if you want your label control to conform to the <width> parameter, but still want to be able to give it more content than will fit on one line, then setting:

<syntaxhighlight lang="XML" enclose="div">
<wrapmultiline>true</wrapmultiline>
</syntaxhighlight>
will cause the text to be cut up (at the spaces in the text) onto multiple lines. Note that if a single word is larger than <width> then it will not be cut, and will still overflow.

=== Available tags ===
In addition to the '''[[Default Control Tags]]''' the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case'''-'''sensitive.

{| class="prettytable"
! Tag
! Description
|-
! align
| Can be left, right, or center. Aligns the text within the given label <code><width></code>. Defaults to left
|-
! aligny
| Can be top or center. Aligns the text within its given label <code><height></code>. Defaults to top
|-
! scroll
| When true, the text will scroll if longer than the label's <code><width></code>. If false, the text will be truncated. Defaults to false.
|-
! label
| Specifies the text which should be drawn. You should specify an entry from the strings.po here (either the Kodi strings.po or your skin's strings.po file). The fallback attribute will be used when the infolabel returns empty. You can use the full [[Label Formatting|label formatting syntax]] and [[Label Parsing|you may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.]]
|-
! info
| Specifies the information that should be presented. Kodi will auto-fill in this info in place of the <code><label></code>. [[InfoLabels|See here for more information.]]
|-
! number
| Specifies a number that should be presented. This is just here to allow a skinner to use a number rather than a text label (as any number given to <code><label></code> will be used to lookup in strings.po)
|-
! angle
| The angle the text should be rendered at, in degrees. A value of 0 is horizontal.
|-
! haspath
| Specifies whether or not this label is filled with a path. Long paths are shortened by compressing the file path while keeping the actual filename full length.
|-
! font
| Specifies the font to use from the font.xml file.
|-
! textcolor
| Specifies the color the text should be, in hex AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
! shadowcolor
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
! wrapmultiline
| If true, any text that doesn't fit on one line will be wrapped onto multiple lines.
|-
! scrollspeed
| Scroll speed of text in pixels per second. Defaults to 60.
|-
! scrollsuffix
| Specifies the suffix used in scrolling labels. Defaults to " <nowiki>|</nowiki> ".
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Edit Control

2022-04-14T00:42:44Z

Gade: /* Available tags */

<section begin="main content" />
The edit control allows a user to input text in Kodi. You can choose the font, size, colour, location and header of the text to be displayed.
=== Example ===
<syntaxhighlight lang="xml">
<control type="edit" id="1">
<description>My First edit control</description>
<left>80</left>
<top>60</top>
<width>250</width>
<visible>true</visible>
<aligny>center</aligny>
<label>Search</label>
<hinttext>Enter search string</hinttext>
font14
<textoffsetx>10</textoffsetx>
<textcolor>FFB2D4F5</textcolor>
<disabledcolor>FF000000</disabledcolor>
<invalidcolor>FFFFFFFF</invalidcolor>
<texturefocus>button-focus.png</texturefocus>
<texturenofocus>button-nofocus.png</texturenofocus>
<pulseonselect>no</pulseonselect>
</control>
</syntaxhighlight>

=== Available tags ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.

{| class="prettytable"
! Tag !! Description
|-
| '''aligny'''
| Can be top or center. Aligns the text within its given control <height>. Defaults to top
|-
| '''label'''
|
Specifies the header text which should be shown. You should specify an entry from the strings.po here (either the Kodi strings.po or your skin's strings.po file), however you may also hardcode a piece of text also if you wish, though of course it will not be localized. You can use the full [[Label Formatting|label formatting syntax]] and [[Label Parsing|you may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.strings]].xml)
|-
| '''hinttext'''
| Specifies the text which should be displayed in the edit label control, until the user enters some text. It can be used to provide a clue as to what a user should enter in this control.
|-
| '''font'''
| Specifies the font to use from the font.xml file.
|-
| '''textcolor'''
| Specifies the color the text should be, in hex AARRGGBB format, or a name from the [[Colour themes|colour theme.]]
|-
| '''textwidth'''
| Will truncate any text that's too long.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Language support

2022-04-14T00:40:24Z

Gade: /* Layout of the strings.po file */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{cleanup}}
The following page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi. 
English (United Kingdom) is the default language of Kodi so it is the English language in the Git repository that is always up-to-date. 
Please always base your translations of the latest English language file from Git. The latest language files for Kodi can be found and downloaded [https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po here (link)].

=== Language add-ons ===
By default Kodi only includes one language which is English (united Kingdom). All other languages have been moved to [https://kodi.wiki/view/Category:Language_add-ons individual language add-ons] which are available form our Kodi repository for download and install. They are auto update by Team Kodi once in a while and pushed to our repository from which you will receive these updates depending on what language(s) you have installed.

=== What is langinfo.xml ===
The langinfo.xml file contains language and region specific localization settings used internally by Kodi. Basically it is the default [http://en.wikipedia.org/wiki/Code_page code page] Kodi uses for this language file.

==== Layout of a langinfo.xml file ====
<syntaxhighlight lang="xml" enclose="div">
<language>
<charsets>
<gui>GB2312</gui>
<subtitle>GB2312</subtitle>
</charsets>

<dvd>
<menu>cn</menu>
<audio>cn</audio>
<subtitle>cn</subtitle>
</dvd>
</language>
</syntaxhighlight>

The <charset> section:
<gui>: Specifies the character encoding of everything within Kodi that is not unicode. E.g. id3 tags with none unicode encoding.
<subtitle>: Default character encoding of subtitles when using a TTF (True-Type-Font).
Choose one encoding for each in the list below. The values may differ if you like.
 
The <dvd> section:
Defines the default languages for DVD-Video menu, audio and subtitle language for the [[VideoPlayer]]. Choose one for each entry out of the list of ISO-639 language abbreviations. If the DVD-Video you are playing does not support the language that you specified then it will default to English.

=== What is strings.po ===
This files contains all strings displayed in the user interface of Kodi.

==== Layout of the strings.po file ====

<syntaxhighlight lang="python" enclose="div">
# Kodi Media Center language file
# Addon Name: Skin Widgets
# Addon id: service.skin.widgets
# Addon Provider: Martijn, phil65
msgid ""
msgstr ""
"Project-Id-Version: Kodi Addons\n"
"Report-Msgid-Bugs-To: translations@kodi.tv\n"
"POT-Creation-Date: YEAR-MO-DA HO:MI+ZONE\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Kodi Translation Team\n"
"Language-Team: English (https://kodi.weblate.cloud/languages/en_gb/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgctxt "#32001"
msgid "Recommended"
msgstr ""

msgctxt "#32002"
msgid "Random Items"
msgstr ""

# empty string with id 32003

msgctxt "#32004"
msgid "Randomize time (minutes)"
msgstr ""

msgctxt "#32005"
msgid "Use season folders"
msgstr ""

</syntaxhighlight>

This is a format defined by [https://www.gnu.org/software/gettext/ GNU gettext] but adapted in a very specific way by Kodi. The blocks of 3 settings in the example above are defined by GNU gettext as:

msgctxt ''context''
msgid ''untranslated-string''
msgstr ''translated-string''

Where the text is defined by ''untranslated-string'' and ''context'' serves to differentiate identical values.

Take note, in Kodi, these are used as follows:

msgctxt "#''label_id''"
msgid ''label_text''
msgstr ''translation''

where ''label_id'' is a numeric ID. These IDs are reserved by Kodi:

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

and are used in [[Add-on_settings_conversion|settings.xml]] to label settings.

''label_text'' defines the English text for the label.

''translation'' is empty for "en_GB" labels, and the translation for other languages with msgid retaining the English text.

The important thing is that you cannot refer to the label with msgid in the settings.py file, you need to use the ''label_id'' which must be encoded in msgctxt as above.

You can of course edit .po files in a text editor or with a specialist editor.

==== Layout of the language folders ====

Kodi loads the strings.po file depending on the set interface language. Should it find a matching language it will try to load that strings.po. If not available it will always fall back to English (United Kingdom).
For this to work you will need to place the strings.po in the correctly named folder depending on the language. These folders use "language-country" naming scheme.
 
Add-ons:
<syntaxhighlight lang="python" enclose="div">
/resources/language/resource.language.en_gb/strings.po
/resources/language/resource.language.fr_fr/strings.po
/resources/language/resource.language.it_it/strings.po
</syntaxhighlight>
Skins:
<syntaxhighlight lang="python" enclose="div">
/language/resource.language.en_gb/strings.po
/language/resource.language.fr_fr/strings.po
/language/resource.language.it_it/strings.po
</syntaxhighlight>
Please use lower case for folder and file names.
 
An extensive example list of used languages can be found here https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary/language

== Adding a new language to Kodi ==

{{see|Language portal}}

== Maintaining a language ==
The English (UK) language file ([https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po]) is the master for all language files. 
From time to time the English (UK) language file changes. This will instantly be automatically updated at Weblate translation pages.

== Related articles in the Kodi online manual ==
* [[Translations|Translations in Kodi]]
* [[Translating_add-ons|Translating your add-on]]
* [[List_of_supported_charsets|List of Supported Charsets]]
* [[List of language codes (ISO-639:1988)]]

== Notes for developers ==
Kodi uses UTF-8 as internal character encoding. Please make sure if you add new features to Kodi which depend on external data to convert these to UTF-8 if they aren't already. Use the languagefile from branches/linuxport, since we merge that file into trunk.

[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development]]
[[Category:Languages|*]]

Language support

2022-04-14T00:34:25Z

Gade:

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{cleanup}}
The following page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi. 
English (United Kingdom) is the default language of Kodi so it is the English language in the Git repository that is always up-to-date. 
Please always base your translations of the latest English language file from Git. The latest language files for Kodi can be found and downloaded [https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po here (link)].

=== Language add-ons ===
By default Kodi only includes one language which is English (united Kingdom). All other languages have been moved to [https://kodi.wiki/view/Category:Language_add-ons individual language add-ons] which are available form our Kodi repository for download and install. They are auto update by Team Kodi once in a while and pushed to our repository from which you will receive these updates depending on what language(s) you have installed.

=== What is langinfo.xml ===
The langinfo.xml file contains language and region specific localization settings used internally by Kodi. Basically it is the default [http://en.wikipedia.org/wiki/Code_page code page] Kodi uses for this language file.

==== Layout of a langinfo.xml file ====
<syntaxhighlight lang="xml" enclose="div">
<language>
<charsets>
<gui>GB2312</gui>
<subtitle>GB2312</subtitle>
</charsets>

<dvd>
<menu>cn</menu>
<audio>cn</audio>
<subtitle>cn</subtitle>
</dvd>
</language>
</syntaxhighlight>

The <charset> section:
<gui>: Specifies the character encoding of everything within Kodi that is not unicode. E.g. id3 tags with none unicode encoding.
<subtitle>: Default character encoding of subtitles when using a TTF (True-Type-Font).
Choose one encoding for each in the list below. The values may differ if you like.
 
The <dvd> section:
Defines the default languages for DVD-Video menu, audio and subtitle language for the [[VideoPlayer]]. Choose one for each entry out of the list of ISO-639 language abbreviations. If the DVD-Video you are playing does not support the language that you specified then it will default to English.

=== What is strings.po ===
This files contains all strings displayed in the user interface of Kodi.

==== Layout of the strings.po file ====

<syntaxhighlight lang="python" enclose="div">
# Kodi Media Center language file
# Addon Name: Skin Widgets
# Addon id: service.skin.widgets
# Addon Provider: Martijn, phil65
msgid ""
msgstr ""
"Project-Id-Version: Kodi Addons\n"
"Report-Msgid-Bugs-To: translations@kodi.tv\n"
"POT-Creation-Date: YEAR-MO-DA HO:MI+ZONE\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Kodi Translation Team\n"
"Language-Team: English (https://kodi.weblate.cloud/languages/en_gb/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgctxt "#32001"
msgid "Recommended"
msgstr ""

msgctxt "#32002"
msgid "Random Items"
msgstr ""

# empty string with id 32003

msgctxt "#32004"
msgid "Randomize time (minutes)"
msgstr ""

msgctxt "#32005"
msgid "Use season folders"
msgstr ""

</syntaxhighlight>

This is a format defined by [https://www.gnu.org/software/gettext/ GNU gettext] but adapted in a very specific way by Kodi. The blocks of 3 settings in the example above are defined by GNU gettext as:

msgctxt ''context''
msgid ''untranslated-string''
msgstr ''translated-string''

Where the text is defined by ''untranslated-string'' and ''context'' serves to differentiate identical values.

Take note, in Kodi, these are used as follows:

msgctxt "#''label_id''"
msgid ''label_text''
msgstr ''translation''

where ''label_id'' is a numeric ID. These IDs are reserved by Kodi:

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

and are used in [[Add-on_settings_conversion|settings.xml]] to label settings.

''label_text'' defines the English text for the label.

''translation'' is empty for "en_GB" labels, and the translation for other languages with msgid retaining the English text.

The important thing is that you cannot refer to the label with msgid in the settings.py file, you need to use the ''label_id'' which must be encoded in msgctxt as above.

You can of course edit .po files in a text editor or with a specialist editor. There is a tool that will help converting old settings.xml files to the settings.po format:

https://gitlab.com/ronie/script.language-convert

==== Layout of the language folders ====

Kodi loads the strings.po file depending on the set interface language. Should it find a matching language it will try to load that strings.po. If not available it will always fall back to English (United Kingdom).
For this to work you will need to place the strings.po in the correctly named folder depending on the language. These folders use "language-country" naming scheme.
 
Add-ons:
<syntaxhighlight lang="python" enclose="div">
/resources/language/resource.language.en_gb/strings.po
/resources/language/resource.language.fr_fr/strings.po
/resources/language/resource.language.it_it/strings.po
</syntaxhighlight>
Skins:
<syntaxhighlight lang="python" enclose="div">
/language/resource.language.en_gb/strings.po
/language/resource.language.fr_fr/strings.po
/language/resource.language.it_it/strings.po
</syntaxhighlight>
Please use lower case for folder and file names.
 
An extensive example list of used languages can be found here https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary/language

== Adding a new language to Kodi ==

{{see|Language portal}}

== Maintaining a language ==
The English (UK) language file ([https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po]) is the master for all language files. 
From time to time the English (UK) language file changes. This will instantly be automatically updated at Weblate translation pages.

== Related articles in the Kodi online manual ==
* [[Translations|Translations in Kodi]]
* [[Translating_add-ons|Translating your add-on]]
* [[List_of_supported_charsets|List of Supported Charsets]]
* [[List of language codes (ISO-639:1988)]]

== Notes for developers ==
Kodi uses UTF-8 as internal character encoding. Please make sure if you add new features to Kodi which depend on external data to convert these to UTF-8 if they aren't already. Use the languagefile from branches/linuxport, since we merge that file into trunk.

[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development]]
[[Category:Languages|*]]

Translating add-ons

2022-04-13T14:21:13Z

Gade: /* Submit your add-on or skin for translation */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer in addon.xml can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
[[Translating_add-ons#Workflows_and_scripts|See below for more information]]
 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add-on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translating add-ons

2022-04-13T14:20:08Z

Gade: /* Submit your add-on or skin for translation */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer in addon.xml can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
[[Translating_add-ons#Workflows_and_scripts|See below for more information]]
 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add-on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translating add-ons

2022-04-13T14:19:44Z

Gade: /* Submit your add-on or skin for translation */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer in addon.xml can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
[[Translating_add-ons#Workflows_and_scripts||See below for more information]]
 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add-on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translating add-ons

2022-04-13T14:18:50Z

Gade: /* Submit your add-on or skin for translation */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer in addon.xml can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add-on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translations

2022-04-13T14:17:38Z

Gade: /* Sync time schedule */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
You can create a new account or use an existing Google, Facebook or Github account. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged. 
It depends how many translations are done for a specific language, but usually new versions are released once a month.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Language portal

2022-04-13T14:14:20Z

Gade:

{{mininav}}
__NOTOC__
__NONUMBEREDHEADINGS__

= Languages =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Language_support|Language Support]]}}'''
This page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_language_codes_(ISO-639:1988)|Language Codes - (ISO-639)]]}}'''
|}
 

= Translations =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translations|Translations in {{kodi}}]]}}'''
This page is mostly for users and translators, detailing how to translate Kodi and other add-ons into native languages. 
A full introduction is made to our translation system at Weblate.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translating_add-ons|Translating your Add-on]]}}'''
This page is mostly for add-on developers, detailing how to add your add-on, skin etc. to our translation system at Weblate. 
Make sure to read the best practices guide, as many errors and merge conflicts can be avoided by following these steps.
|}

= Fonts =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Fonts|Using Fonts]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_supported_charsets|Supported Character Sets]]}}'''
|}
 

= Other =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Interface/Regional|Change {{kodi}} language and regional settings]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Player/Language|Change Audio and Subtitle Languages]]}}'''
|}

{{updated|19}}

[[Category:Development]]
[[Category:Karellen]]
[[Category:Languages]]

Language support

2022-04-13T14:11:55Z

Gade: /* Related articles in the Kodi online manual */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{cleanup}}
The following page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi. 
English (United Kingdom) is the default language of Kodi so it is the English language in the Git repository that is always up-to-date. 
Please always base your translations of the latest English language file from Git. The latest language files for Kodi can be found and downloaded [https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po here (link)].

=== Language add-ons ===
By default Kodi only includes one language which is English (united Kingdom). All other languages have been moved to [https://kodi.wiki/view/Category:Language_add-ons individual language add-ons] which are available form our Kodi repository for download and install. They are auto update by Team Kodi once in a while and pushed to our repository from which you will receive these updates depending on what language(s) you have installed.

=== What is langinfo.xml ===
The langinfo.xml file contains language and region specific localization settings used internally by Kodi. Basically it is the default [http://en.wikipedia.org/wiki/Code_page code page] Kodi uses for this language file.

==== Layout of a langinfo.xml file ====
<syntaxhighlight lang="xml" enclose="div">
<language>
<charsets>
<gui>GB2312</gui>
<subtitle>GB2312</subtitle>
</charsets>

<dvd>
<menu>cn</menu>
<audio>cn</audio>
<subtitle>cn</subtitle>
</dvd>
</language>
</syntaxhighlight>

The <charset> section:
<gui>: Specifies the character encoding of everything within Kodi that is not unicode. E.g. id3 tags with none unicode encoding.
<subtitle>: Default character encoding of subtitles when using a TTF (True-Type-Font).
Choose one encoding for each in the list below. The values may differ if you like.
 
The <dvd> section:
Defines the default languages for DVD-Video menu, audio and subtitle language for the [[VideoPlayer]]. Choose one for each entry out of the list of ISO-639 language abbreviations. If the DVD-Video you are playing does not support the language that you specified then it will default to English.

=== What is strings.po ===
This files contains all strings displayed in the user interface of Kodi.

==== Layout of the strings.po file ====

<syntaxhighlight lang="python" enclose="div">
# Kodi Media Center language file
# Addon Name: Skin Widgets
# Addon id: service.skin.widgets
# Addon Provider: Martijn, phil65
msgid ""
msgstr ""
"Project-Id-Version: Kodi Addons\n"
"Report-Msgid-Bugs-To: translations@kodi.tv\n"
"POT-Creation-Date: YEAR-MO-DA HO:MI+ZONE\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Kodi Translation Team\n"
"Language-Team: English (https://kodi.weblate.cloud/languages/en_gb/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgctxt "#32001"
msgid "Recommended"
msgstr ""

msgctxt "#32002"
msgid "Random Items"
msgstr ""

# empty string with id 32003

msgctxt "#32004"
msgid "Randomize time (minutes)"
msgstr ""

msgctxt "#32005"
msgid "Use season folders"
msgstr ""

</syntaxhighlight>

This is a format defined by [https://www.gnu.org/software/gettext/ GNU gettext] but adapted in a very specific way by Kodi. The blocks of 3 settings in the example above are defined by GNU gettext as:

msgctxt ''context''
msgid ''untranslated-string''
msgstr ''translated-string''

Where the text is defined by ''untranslated-string'' and ''context'' serves to differentiate identical values.

Take note, in Kodi, these are used as follows:

msgctxt "#''label_id''"
msgid ''label_text''
msgstr ''translation''

where ''label_id'' is a numeric ID. These IDs are reserved by Kodi:

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

and are used in [[Add-on_settings_conversion|settings.xml]] to label settings.

''label_text'' defines the English text for the label.

''translation'' is empty for "en_GB" labels, and the translation for other languages with msgid retaining the English text.

The important thing is that you cannot refer to the label with msgid in the settings.py file, you need to use the ''label_id'' which must be encoded in msgctxt as above.

You can of course edit .po files in a text editor or with a specialist editor. There is a tool that will help converting old settings.xml files to the settings.po format:

https://gitlab.com/ronie/script.language-convert

==== Layout of the language folders ====

Kodi loads the strings.po file depending on the set interface language. Should it find a matching language it will try to load that strings.po. If not available it will always fall back to English (United Kingdom).
For this to work you will need to place the strings.po in the correctly named folder depending on the language. These folders use "language-country" naming scheme.
 
Add-ons:
<syntaxhighlight lang="python" enclose="div">
/resources/language/resource.language.en_gb/strings.po
/resources/language/resource.language.fr_fr/strings.po
/resources/language/resource.language.it_it/strings.po
</syntaxhighlight>
Skins:
<syntaxhighlight lang="python" enclose="div">
/language/resource.language.en_gb/strings.po
/language/resource.language.fr_fr/strings.po
/language/resource.language.it_it/strings.po
</syntaxhighlight>
Please use lower case for folder and file names.
 
An extensive example list of used languages can be found here https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary/language

==== Layout of the old strings.xml file ====

{{warning|1=Strings.xml support was completely removed from v19 Matrix. Addons should update and comply to the strings.po file from now on.}}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<strings>
<string id="32001">Recommended</string>
<string id="32002">Random Items</string>
<string id="32003">Only unplayed</string>
<string id="32004">Randomize time (minutes)</string>
<string id="32005">Use season folders</string>
<string id="32006">Use timer</string>
<string id="32007">After database update</string>
<string id="32008">Update method</string>
<string id="32009">Recent Items</string>
</strings>

Each string is enclosed in a <string> tag. It contains a tag named id="32001" with a number Kodi uses to reference a string internally.

'''Hint: Multi-Line Text-Values''' 
If you want your text-values to span multiple lines, you can insert a new line character [br] in your tag. Although we highly discourage this as it could cause skin problems as not all text boxes have enough room to display these.

For example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<strings>
<string id="32001"><value>This will be on the first line[br]And this will be on the second line</string>
</strings>

The encoding attribute of the XML header sets the charset the file is encoded with. See List of charsets of possible values.
If you don't know what charset your language uses please follow [http://www.science.co.il/Language/Locale-Codes.asp this link] to find out.

=== String ID range ===

Follow the specified string ID range

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

== Adding a new language to Kodi ==

{{see|Language portal}}

== Maintaining a language ==
The English (UK) language file ([https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po]) is the master for all language files. 
From time to time the English (UK) language file changes. This will instantly be automatically updated at Weblate translation pages.

== Related articles in the Kodi online manual ==
* [[Translations|Translations in Kodi]]
* [[Translating_add-ons|Translating your add-on]]
* [[List_of_supported_charsets|List of Supported Charsets]]
* [[List of language codes (ISO-639:1988)]]

== Notes for developers ==
Kodi uses UTF-8 as internal character encoding. Please make sure if you add new features to Kodi which depend on external data to convert these to UTF-8 if they aren't already. Use the languagefile from branches/linuxport, since we merge that file into trunk.

[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development]]
[[Category:Languages|*]]

Language portal

2022-04-13T14:06:38Z

Gade:

{{mininav}}
__NOTOC__
__NONUMBEREDHEADINGS__

= Languages =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Language_support|Language Support]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_language_codes_(ISO-639:1988)|Language Codes - (ISO-639)]]}}'''
|}
 

= Translations =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translations|Translations in {{kodi}}]]}}'''
This page is mostly for users and translators, detailing how to translate Kodi and other add-ons into native languages. 
A full introduction is made to our translation system at Weblate.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translating_add-ons|Translating your Add-on]]}}'''
This page is mostly for add-on developers, detailing how to add your add-on, skin etc. to our translation system at Weblate. 
Make sure to read the best practices guide, as many errors and merge conflicts can be avoided by following these steps.
|}

= Fonts =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Fonts|Using Fonts]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_supported_charsets|Supported Character Sets]]}}'''
|}
 

= Other =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Interface/Regional|Change {{kodi}} language and regional settings]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Player/Language|Change Audio and Subtitle Languages]]}}'''
|}

{{updated|19}}

[[Category:Development]]
[[Category:Karellen]]
[[Category:Languages]]

Language portal

2022-04-13T14:05:44Z

Gade:

{{mininav}}
__NOTOC__
__NONUMBEREDHEADINGS__

= Languages =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Language_support|Language Support]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:language_globe_icon.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_language_codes_(ISO-639:1988)|Language Codes - (ISO-639)]]}}'''
|}
 

= Translations =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translations|Translations in {{kodi}}]]}}'''
This page is mostly for users and translators, detailing how to translate Kodi and other add-ons into native languages. 
A full introduction is made to our translation system at Weblate.
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Translation - Noun project 987.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Translating_add-ons|Translating your Add-on]]}}'''
This page is mostly for add-on developers, detailing how to add your add-on, skin etc. to our translation system at Weblate. 
Make sure to read the best practices guide, as many errors and merge conflicts can be avoided by following these steps.
|}
 

= Fonts =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Fonts|Using Fonts]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Crystal Clear app fonts.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[List_of_supported_charsets|Supported Character Sets]]}}'''
|}
 

= Other =
{| style="width: 100%;"
|-
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Interface/Regional|Change {{kodi}} language and regional settings]]}}'''
| style="width: 2%;" |
| style="width: 5%; vertical-align:top;" | [[File:Thumbnail-symbol-transparent.png|40px|left]]
| style="width: 44%; vertical-align:top;" |'''{{resize|1.3em| [[Settings/Player/Language|Change Audio and Subtitle Languages]]}}'''
|}

{{updated|19}}

[[Category:Development]]
[[Category:Karellen]]
[[Category:Languages]]

Translating add-ons

2022-04-13T13:54:49Z

Gade:

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add-on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translations

2022-04-13T13:54:41Z

Gade:

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
You can create a new account or use an existing Google, Facebook or Github account. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged. 
It depends how many translations are sone for a specific language, but usually new versions are released once a month.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Translations

2022-04-13T13:53:50Z

Gade: /* Sync time schedule */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
You can create a new account or use an existing Google, Facebook or Github account. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged. 
It depends how many translations are sone for a specific language, but usually new versions are released once a month.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Translations

2022-04-13T13:51:18Z

Gade: /* Weblate */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
You can create a new account or use an existing Google, Facebook or Github account. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made. 
 
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Translations

2022-04-13T13:49:58Z

Gade: /* Weblate */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
If you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made. 
 
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Translations

2022-04-13T13:49:24Z

Gade: /* Weblate */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
Addon developers should read this page for information on how to translate add-ons: [[Translating_add-ons|Translating your add-on]]
 
So if you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made. 
 
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Translating add-ons

2022-04-13T13:47:53Z

Gade: /* Workflows and scripts */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add-on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translating add-ons

2022-04-13T13:47:37Z

Gade: /* Workflows and scripts */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons. 
Required workflows are automatically offered to your add'on repository by pull request.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translations

2022-04-13T13:42:48Z

Gade:

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{see also|Add-on development}}

= History =
In the development cycle from Eden (V11) to Frodo (V12) the translation system has been revised.

The former strings.xml file has been superseeded by the appropriate strings.po files. Due to that the way how translations are handled has been changed, too.

= Weblate =
The whole translation system has been moved to [https://kodi.weblate.cloud/ Weblate]. 
So if you want to help translating Kodi into your native language, first thing you need to do is to [https://kodi.weblate.cloud/accounts/register/ sign up at Weblate]. 
Please visit [https://forum.kodi.tv/showthread.php?tid=363132 this forum post] to let us know which language you would like to translate. 
Once added to a langage team, you can start translating immediately.
 
== Profile ==
In the top right, you can find your profile settings:
 
[[File:Weblate_profile_settings.png|300px|Weblate profile settings]]
 
In the '''Language tab''' you can select the interface language, the language you can translate to and your secondary languages:
 
[[File:Weblate language settings new.png|900px|Weblate language settings]]
 
In the '''Notifications tab''' you can select your watched projects. 
Those projects can be selected in the top Projects menu. 
''We recommend selecting all projects to have easy access to all components.''
 
[[File:Weblate watched.png|900px|Weblate watched projects settings]]

Now you are ready to translate components:
 
[[File:Weblate.png|900px|Weblate main screen]]
 
 

== Translating Kodi and other components ==
''Note: Please do not download files, modify them and upload again! Always translate components and strings inside Weblate!''
 
Ok, let's get to work!
 
Search that part of the project that needs updating. 
You can see the percentage of the translations, untranslated strings / words / characters:
 
[[File:Weblate components.png|900px|Components at Weblate]]
 
You might note that there is some untranslated strings in "Kodi core/kodi main". 
So we click either on the pencil to the left or on the language label to translate it:
 
[[File:Weblate component hl close.png|700px|Translate buttons highlighted]]
 
The next screen will show you all information on the chosen language. 
We recommend to take care of most alerts: BBcode markup, mismatched \n, mismatching line breaks, XML markup, starting spaces, trailing spaces, double space, unchanged translations. 
Keeping alerts might break the file and ultimately lead to Kodi crashing. 
Alerts can be cleared when selecting the string with the alert. 
[[File:Weblate translate1.png|900px|Translate window inside Weblate]]
 
If you want to translate the component, '''"Not translated strings"''' is where to go. 
 
Clicking any item in the previous image will take you here:
 
[[File:Weblate translate.png|900px]]
 
* '''SOURCE STRING COMMENT:''' The developers can create useful comments for the string, e.g. what it exactly does or where it can be found in the GUI.
* '''GLOSSARY:''' View the glossary entries matching your current string. You can also add new glossary entries.
* '''NBS:''' "No-break space" is a character used if you can't translate the source string into your native language. It's useful for languages that don't have certain words. It will not take up any character space and will not use the source string.
* '''REVIEW STATE:''' Reviewers/coordinators can approve strings or mark them for editing.
* '''AUTOMATIC SUGGESTIONS:''' Matching strings and translations from other components will be listed here. This is great for keeping consistency. We recommend keeping this tab open when translating.
 
[[File:Weblate translate colors.png|1000px|Colors explaining Weblate translate window]]
 
'''Other languages tab''' is great for looking at the current string translated into other languages. Works well for closely related languages.
 
[[File:Weblate other languages.png|900px|Other languages tab at Weblate]]
 
'''Comments tab''': Here you can make comments on the current string for other translators, reviewers and developers to read. 
You can also make source string comments or suggestions for changes to the string.
 
[[File:Weblate comments2.png|900px|Comments for strings]]
 

= Useful hints =
This part shows some additional information for developers and translators to make things more easy. So it's worth taking a look.

== Details & Comments ==
The developers can set special marks in the strings.po file to give a useful comment on that string. e.g. what it exactly does or where it can be found in the GUI.
 
[[File:Weblate comments.png|900px|Comments in a string]]

In the source file it looks like this:
<syntaxhighlight lang="xml" enclose="div">
#. play GUI sounds
#: xbmc/settings/GUISettings.cpp
msgctxt "#34122"
msgid "Always"
msgstr ""
</syntaxhighlight>

With #. we can add a helper comment or context to help translators understand the meaning or usage of string.

with #: we can specify where the string is used. Sometimes this could also be a useful info.

= Contact and support =
If you have problems with Weblate your first person to contact should be the coordinator of your language!

If you have more general questions you might [https://forum.kodi.tv/forumdisplay.php?fid=90 head over to the forums and post your question in the translations section]. 
Gade and others can help you there.

= Sync time schedule =
Changes to the main source en_gb file are synced instantly from Github to Weblate. 
Translations are pushed from Weblate to Github every 5 days (default, but can be configured) if any translations are made. 
 
For Kodi language add-ons, new versions are released every time a Weblate pull request is merged.

= Syntax verification =
For keeping the strings correctly formatted, we do a constant syntax verification at all times. 
Changes are either done at Weblate or by pull request to the upstream repository.

{{updated|19}}
{{top}}

[[Category:Development|T]]
[[Category:Languages]]

Translating add-ons

2022-04-13T13:42:11Z

Gade: /* Best practices */

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Best practices =
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Translating add-ons

2022-04-13T13:41:34Z

Gade:

{{mininav|Language portal}}

= Submit your add-on or skin for translation =
We encourage all developers with addons in the official Kodi add-on repo to submit their addon for translation at Weblate. 
 
Handling of translations for your add-on will become much more simple, as most things are automated. 
Weblate will get updated instantly whenever you add or remove a translation from your source en_gb file. 
Translations can be synced to your upstream repository whenever you wish (default is 5 days) either by pull request or direct push. 
All languages at Weblate will be kept in sync with the en_gb source file. 
 
Summary, description and disclaimer can be automatically synced between addon.xml and language files either by pull request or direct push whenever changes are made. 
 
We require the following info:
* URL to your repo at Github/Gitlab
* Branch
* Would you like pull requests or direct pushes from Weblate? (Pull requests are safest, direct pushes are easiest.)
* How often would you like pull requests/direct pushes? Default is 5 days, but it's totally up to you.
* Do you want a version bump in addon.xml?
 
For your main source en_gb file to get synced with Weblate, you must add this webhook to your repository for the push event:
<syntaxhighlight lang="xml">https://kodi.weblate.cloud/hooks/github</syntaxhighlight>
[[File:Webhook.png|600px|webhook for Weblate]]

If direct pushes are wanted, you need to add Github user [https://github.com/weblate "weblate"] as collaborator. 
This user will automatically accept any collaboration within 5 minutes. 
If pull requests are the preferred method, Weblate will push to the same pull request until merged or closed.
 
[https://forum.kodi.tv/showthread.php?tid=359836 Please visit this forum post for more information.]

= Best practices =
[[Translations#Submit_your_add-on_or_skin_for_translation|Submit your add-on or skin for translation]]
 
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

{{updated|19}}
[[Category:Development]]
[[Category:Languages]]

Weblate

2022-04-05T08:53:29Z

Gade: /* Best practices */

= Best practices =
[[Translations#Submit_your_add-on_or_skin_for_translation|Submit your add-on or skin for translation]]
 
* Only change the content of en_gb source language file.
:Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
* If you have an open Weblate pull request, always merge that pull request before any other. 
:Failing to do so could result in merge conflicts at Weblate. 
:Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
* If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
:That means that all existing translations will get removed for that string. 
:So be careful before you change existing strings.
 
* Sometimes Weblate will add commented out translations at the end of language files. 
:These '''should not''' be removed and are harmless. 
:They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.

Language support

2022-04-05T08:44:25Z

Gade: /* Maintaining a language */

{{mininav|[[Development]]{{l2|[[Add-on development]]}}}}

{{cleanup}}
The following page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi. 
English (United Kingdom) is the default language of Kodi so it is the English language in the Git repository that is always up-to-date. 
Please always base your translations of the latest English language file from Git. The latest language files for Kodi can be found and downloaded [https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po here (link)].

=== Language add-ons ===
By default Kodi only includes one language which is English (united Kingdom). All other languages have been moved to [https://kodi.wiki/view/Category:Language_add-ons individual language add-ons] which are available form our Kodi repository for download and install. They are auto update by Team Kodi once in a while and pushed to our repository from which you will receive these updates depending on what language(s) you have installed.

=== What is langinfo.xml ===
The langinfo.xml file contains language and region specific localization settings used internally by Kodi. Basically it is the default [http://en.wikipedia.org/wiki/Code_page code page] Kodi uses for this language file.

==== Layout of a langinfo.xml file ====
<syntaxhighlight lang="xml" enclose="div">
<language>
<charsets>
<gui>GB2312</gui>
<subtitle>GB2312</subtitle>
</charsets>

<dvd>
<menu>cn</menu>
<audio>cn</audio>
<subtitle>cn</subtitle>
</dvd>
</language>
</syntaxhighlight>

The <charset> section:
<gui>: Specifies the character encoding of everything within Kodi that is not unicode. E.g. id3 tags with none unicode encoding.
<subtitle>: Default character encoding of subtitles when using a TTF (True-Type-Font).
Choose one encoding for each in the list below. The values may differ if you like.
 
The <dvd> section:
Defines the default languages for DVD-Video menu, audio and subtitle language for the [[VideoPlayer]]. Choose one for each entry out of the list of ISO-639 language abbreviations. If the DVD-Video you are playing does not support the language that you specified then it will default to English.

=== What is strings.po ===
This files contains all strings displayed in the user interface of Kodi.

==== Layout of the strings.po file ====

<syntaxhighlight lang="python" enclose="div">
# Kodi Media Center language file
# Addon Name: Skin Widgets
# Addon id: service.skin.widgets
# Addon Provider: Martijn, phil65
msgid ""
msgstr ""
"Project-Id-Version: Kodi Addons\n"
"Report-Msgid-Bugs-To: translations@kodi.tv\n"
"POT-Creation-Date: YEAR-MO-DA HO:MI+ZONE\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Kodi Translation Team\n"
"Language-Team: English (https://kodi.weblate.cloud/languages/en_gb/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgctxt "#32001"
msgid "Recommended"
msgstr ""

msgctxt "#32002"
msgid "Random Items"
msgstr ""

# empty string with id 32003

msgctxt "#32004"
msgid "Randomize time (minutes)"
msgstr ""

msgctxt "#32005"
msgid "Use season folders"
msgstr ""

</syntaxhighlight>

This is a format defined by [https://www.gnu.org/software/gettext/ GNU gettext] but adapted in a very specific way by Kodi. The blocks of 3 settings in the example above are defined by GNU gettext as:

msgctxt ''context''
msgid ''untranslated-string''
msgstr ''translated-string''

Where the text is defined by ''untranslated-string'' and ''context'' serves to differentiate identical values.

Take note, in Kodi, these are used as follows:

msgctxt "#''label_id''"
msgid ''label_text''
msgstr ''translation''

where ''label_id'' is a numeric ID. These IDs are reserved by Kodi:

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

and are used in [[Add-on_settings_conversion|settings.xml]] to label settings.

''label_text'' defines the English text for the label.

''translation'' is empty for "en_GB" labels, and the translation for other languages with msgid retaining the English text.

The important thing is that you cannot refer to the label with msgid in the settings.py file, you need to use the ''label_id'' which must be encoded in msgctxt as above.

You can of course edit .po files in a text editor or with a specialist editor. There is a tool that will help converting old settings.xml files to the settings.po format:

https://gitlab.com/ronie/script.language-convert

==== Layout of the language folders ====

Kodi loads the strings.po file depending on the set interface language. Should it find a matching language it will try to load that strings.po. If not available it will always fall back to English (United Kingdom).
For this to work you will need to place the strings.po in the correctly named folder depending on the language. These folders use "language-country" naming scheme.
 
Add-ons:
<syntaxhighlight lang="python" enclose="div">
/resources/language/resource.language.en_gb/strings.po
/resources/language/resource.language.fr_fr/strings.po
/resources/language/resource.language.it_it/strings.po
</syntaxhighlight>
Skins:
<syntaxhighlight lang="python" enclose="div">
/language/resource.language.en_gb/strings.po
/language/resource.language.fr_fr/strings.po
/language/resource.language.it_it/strings.po
</syntaxhighlight>
Please use lower case for folder and file names.
 
An extensive example list of used languages can be found here https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary/language

==== Layout of the old strings.xml file ====

{{warning|1=Strings.xml support was completely removed from v19 Matrix. Addons should update and comply to the strings.po file from now on.}}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<strings>
<string id="32001">Recommended</string>
<string id="32002">Random Items</string>
<string id="32003">Only unplayed</string>
<string id="32004">Randomize time (minutes)</string>
<string id="32005">Use season folders</string>
<string id="32006">Use timer</string>
<string id="32007">After database update</string>
<string id="32008">Update method</string>
<string id="32009">Recent Items</string>
</strings>

Each string is enclosed in a <string> tag. It contains a tag named id="32001" with a number Kodi uses to reference a string internally.

'''Hint: Multi-Line Text-Values''' 
If you want your text-values to span multiple lines, you can insert a new line character [br] in your tag. Although we highly discourage this as it could cause skin problems as not all text boxes have enough room to display these.

For example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<strings>
<string id="32001"><value>This will be on the first line[br]And this will be on the second line</string>
</strings>

The encoding attribute of the XML header sets the charset the file is encoded with. See List of charsets of possible values.
If you don't know what charset your language uses please follow [http://www.science.co.il/Language/Locale-Codes.asp this link] to find out.

=== String ID range ===

Follow the specified string ID range

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

== Adding a new language to Kodi ==

{{see|Translations}}

== Maintaining a language ==
The English (UK) language file ([https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po]) is the master for all language files. 
From time to time the English (UK) language file changes. This will instantly be automatically updated at Weblate translation pages.

== Related articles in the Kodi online manual ==
* [[List_of_supported_charsets|List of Supported Charsets]]
* [[List of language codes (ISO-639:1988)]]

== Notes for developers ==
Kodi uses UTF-8 as internal character encoding. Please make sure if you add new features to Kodi which depend on external data to convert these to UTF-8 if they aren't already. Use the languagefile from branches/linuxport, since we merge that file into trunk.

[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development]]
[[Category:Languages|*]]

Weblate

2022-03-22T10:51:15Z

Gade: /* Best practices */

= Best practices =
[[Translations#Submit_your_add-on_or_skin_for_translation|Submit your add-on or skin for translation]]

Only change the content of en_gb source language file. 
Never change anything in other language files, as Weblate will handle syncing and maintaining of all strings for all languages.
 
If you have an open Weblate pull request, always merge that pull request before any other. 
Failing to do so could result in merge conflicts at Weblate. 
Also merge any open Weblate pull request before changing or adding translations to en_gb source file.
 
If doing a minor change for an existing source language (en_gb) string, Weblate will most likely treat this as a completely new string. 
That means that all existing translations will get removed for that string. 
So be careful before you change existing strings.
 
Sometimes Weblate will add commented out translations at the end of language files. 
These '''should not''' be removed and are harmless. 
They are kept as part of translation memory and will benefit translators in a number of ways.

= Workflows and scripts =
We offer several workflows to help integrate Weblate translations into your add-ons.

== sync-addon-metadata-translations.yml ==
This workflow will sync metadata (description, summary, disclaimer etc.) between addon.xml and the language files. 
It will add this metadata from addon.xml to each language file to allow translation at Weblate. 
Whenever changes are done to either addon.xml or any language file, the workflow will run and sync changes both ways. 
Either a pull request or direct commit can be created.

An '''''amt-sync''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''amt-sync'' branch and that force pushing is allowed.

''This workflow is required for proper Weblate translations.''

== increment_version.py ==
This workflow will bump the version number in your addon.xml file whenever changes are done to the language files. 
It can be configured to create a changelog entry as well. 
Either a pull request or direct commit can be created.

An '''''inc-ver''''' branch is created by the workflow where changes are pushed before a pull request is created. 
Once the pull request is merged the branch can be safely deleted. 
Make sure branch protection is disabled for ''inc-ver'' branch and that force pushing is allowed.

= Weblate configuration and add-ons =
The text in your Weblate pull request or direct commit can be changed exactly as you see fit.

We enable several add-ons for your component(s) at Weblate. 
Most of them will be enabled with default configuration, but some of them can be configured to your preference.

==Squash Git commits==
This add-on will squash all Weblate commits into a single one. 
But it can also create one commit per language or per file if wanted.

==Customize gettext output==
Default for this add-on is to only wrap lines at newlines. 
But it can also wrap lines at 77 characters and at newlines or do no line wrapping.