Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

This table identifies key names for UI labels and gives the default English labels. For information about enabling translations, see Localize an App.
You can localize the UI labels in an app in multiple languages of your choice.Appkit obtains the correct labels for a language by making calls to an Appkit translation service. The service provides a label in the chosen language, with a fallback to English if no translation exists for the label in the chosen language.

​
Loading translations

You can use the new <translations:localize> JSP tag to load a set of UI label translations into an app. The tag syntax is:
<translations:localize dictionary="dictionary" locale="locale" />
  • dictionary. Name of the resource bundle from which to load translations. This is also the first part of the name of each property file that contains translations. Default: translations
  • locale. Locale Default: en (English)
The dictionary and locale are used to find the file as follows:
  1. In src/main/resources, the Appkit translation service looks for a resource bundle named dictionary, for example, translations.
  2. Within the resource bundle, the translation service looks for property files named {resource}, for example, for the files translations_en.properties and translations_fr.properties.

​
Enabling translations

  1. Find label strings that need to be translated in the UI and identify the key names for the labels.
  2. Create translation property files and add them under the src/main/resources directory. For example, for a dictionary called translations add translations_en.properties and translations_fr.properties.
    Edit the property files and include the label keys and translations. For example: In translations_en.properties: 
    # translations_en.properties
...
components.pagination.next = Next
components.pagination.previous = Previous
...
    In translations_fr.properties: 
    # translations_fr.properties
...
components.pagination.next = Suivant
components.pagination.previous = Précédent
...
    Some translations include variables. For example, components.response-statistics.showing is Showing {first} - {last} of {total} in English. Translations should retain the variables, though their order might differ. Labels can use <em> tags for emphasis, for example, More results like <em>{result}</em>.
  3. Add the following dependency to your app’s pom.xml: 
    <!-- Twigkit translations -->
<dependency>
    <groupId>twigkit</groupId>
    <artifactId>twigkit.translations</artifactId>
    <version>${project.parent.version}</version>
</dependency>
  4. Add this taglib directive at the top of your app’s index.jsp: 
    <%@ taglib prefix="translations" uri="/twigkit/translations" %>
  5. Add the Appkit <translations:localize> JSP tag inside the <head> element of your app’s index.jsp: 
    <translations:localize locale="${param.locale}" />
  6. Add this rule to the url-rules.xml file: 
    <!-- Language specific pages -->
<rule>
    <from>^/lang/(.*)/</from>
    <to last="true">/index.jsp?locale=$1</to>
</rule>
    You can modify other URL rules to suit your application logic. The <translations:localize> JSP tag works the same.
  7. Restart your app.
  8. Verify that the translations are present by visiting pages in the app that should be in different languages.
KeyEnglish LabelAdditional Context
components.search-box.placeholderSearch…​Search input placeholder
components.search-box.button-labelSearchSearch submit button label
components.search-box.savedMy Saved Searches
components.search-box.bookmarkMy bookmarks
components.spelling-suggestions.did-you-meanDid you mean: {correction}.As in, “Did you mean spelling-corrected query?”
components.spelling-suggestions.auto-correctShowing results for {correction}.This is displayed above a list of results of a spelling-corrected query.
components.spelling-suggestions.no-resultsNo results found for {query}.
components.response-statistics.showingShowing {first} - {last} of {total}
components.pagination.nextNext
components.pagination.previousPrevious
components.breadcrumbs.clear-allClear All
components.facet.show-moreShow more
components.facet.show-lessShow less
components.no-results.titleSorry: there are no results that match your search criteria.
components.no-results.subtitleIf you have checked your spelling: try using more general keywords.
components.response-statistics.showing-allShowing All {total}
collaborate.bookmark.tooltipBookmark this?As in, “Would you like to bookmark this item?”
collaborate.bookmark.activeYou have bookmarked thisAs in, this is already bookmarked.
collaborate.bookmark.single{count} person has bookmarked thisAs in the singular: “1 person has bookmarked this.”
collaborate.bookmark.plural{count} people have bookmarked thisAs in the plural: “4 people have bookmarked this.”
collaborate.bookmarkList.empty-textYou do not have any bookmarks yet
collaborate.comment.promptPlease enter a commentAs in a prompt to add a comment.
collaborate.comment.postPostThe comment submit button
collaborate.comment.placeholderLeave a new note…​The text area placeholder
collaborate.comment.deleteDeleteThe delete comment button
collaborate.comment.moreShow more comments
collaborate.comment.lessShow fewerAs in, show fewer comments.
collaborate.comment.delete-messageAre you sure you want to remove this comment?
collaborate.like.tooltipDo you like this?As in, “Do you like this item/result?”
collaborate.like.activeYou have liked this
collaborate.like.singular{count} person has liked thisAs in the singular: “1 person has liked this.”
collaborate.like.plural{count} people have liked thisAs in the plural “2 people have liked this.”
collaborate.saved.buttonSaveThe save query button label
collaborate.saved.empty-textYou do not have any saved queries yet
collaborate.saved.errorPlease enter a name so this query can be savedError message indicating a name is required
collaborate.saved.error-duplicateA saved query with that name already exists, please use a different nameError message flagging duplicate name
collaborate.saved.error-networkUnable to save query, please try againGeneral error message
collaborate.saved.placeholderSearch nameGuidance phrase in search box about searching names of saved searches
collaborate.topic.buttonSaveThe save topic button label
collaborate.topic.promptPlease enter a topic name
collaborate.topic.nameType a name for the new topic…The text input placeholder
collaborate.topic.descriptionDescription…Input placeholder for the topic description text
collaborate.topic.emptyYou do not have any topics yet
components.breadcrumbs.excludenot {breadcrumb}Showing the results that do not include items of this breadcrumb type
components.facet.apply-filtersApply Filters
components.facet.no-resultsNo results found
components.facet.searchSearch…​
content.form.successForm posted successfully
content.form.errorError!{status}-{statusText}
content.form.requiredThis field is required
content.form.submitSubmit
content.form.required-textareaThis field is required