
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


== Usage Notes

For the "big picture" and further details on the framework's support, see xref:userguide:btb:i18n.adoc[here].


== Related Services

* xref:refguide:applib:index/services/i18n/Mode.adoc[Mode]
+
enumerates the mode that the translation service is currently in, as per xref:refguide:applib:index/services/i18n/TranslationService.adoc#getMode_[getMode()].

* xref:refguide:applib:index/services/i18n/LanguageProvider.adoc[LanguageProvider]
+
Used by the default implementation (`TranslationServicePo`) to return the `Locale` of the current user.

* xref:refguide:applib:index/services/i18n/TranslationsResolver.adoc[TranslationsResolver]
+
Used by the default implementation (`TranslationServicePo`) to read existing translations.

* The framework also provides a supporting `TranslationServicePoMenu` provides menu items under the "Prototyping" secondary menu for controlling this service and downloading `.pot` files for translation.
+
If the menu items are not required then these can be suppressed either using security or by implementing a vetoing subscriber.
+
For more details on the implementation, see xref:userguide:btb:i18n.adoc[i18n support].

