|
|
| (2 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| | {{#pagetitle: Multilingual }} | | {{#pagetitle: Multilingual }} |
| − |
| |
| | [[Main Page]] > [[Development]] > Multilingual | | [[Main Page]] > [[Development]] > Multilingual |
| | | | |
| − | The change in architecture between ICA-AtoM 1.3.1 (Zend Framework, Apache Lucene Search engine) and AtoM 2.0 (ElasticSearch engine) has introduced a number of changes to the multilingual functionality and usability. This wiki page has been created to document the outstanding bugs and tasks related to the multilingual feature, provide use case examples, explain the current functionality and if necessary, suggest workflows for multilingual instances.
| |
| − |
| |
| − | == Introduction: Multilingual design principles ==
| |
| | | | |
| − | ICA-AtoM and AtoM 2.x are multilingual applications which incorporate the following design principles:
| + | On this page you'll find historical development documentation about the the multilingual functionality of AtoM, including historical documentation of the functionality in earlier versions of ICA-AtoM and AtoM, information about development enhancements added to 2.x, and discussions about future development considerations for enhancing multilingual functionality and usability. |
| − | * Both the [https://www.ica-atom.org/doc/Glossary#User_interface user interface] and the [https://www.ica-atom.org/doc/Glossary#Database_content database content] should be capable of existing in multiple languages
| |
| − | * Users should be able to switch the [https://www.ica-atom.org/doc/Glossary#User_interface user interface] to their preferred language using the language drop-down from the main menu,
| |
| − | * When switching the [https://www.ica-atom.org/doc/Glossary#User_interface user interface] to a preferred language, [https://www.ica-atom.org/doc/Glossary#Database_content database content] should also switch, if a translation is available; if not, the content remains in the original source language,
| |
| − | * Users with [https://www.ica-atom.org/doc/Glossary#Translator translator] [https://www.ica-atom.org/doc/Glossary#Access_privilege access privileges] should be able to contribute translations of content (e.g., archival descriptions) from the source language to their assigned languages using the translation interface available in ICA-AtoM and AtoM,
| |
| − | * [https://www.ica-atom.org/doc/Glossary#Administrator Administrators] should be able to remove languages that are not needed in their application; they should be able to easily add back [https://www.ica-atom.org/doc/Glossary#Supported_language supported languages] that were removed,
| |
| − | * Using [https://www.transifex.com/projects/p/atom/ Transifex] translators and translator teams should be able to translate [https://www.ica-atom.org/doc/Glossary#User_interface interface] elements and add new languages for inclusion in the application as [https://www.ica-atom.org/doc/Glossary#Supported_language supported languages].
| |
| − | * When installing ICA-AtoM and AtoM 2.x, the [https://www.ica-atom.org/doc/Glossary#Administrator administrator] specifies the [https://www.ica-atom.org/doc/Glossary#Default_language default language]. Any user can switch the [https://www.ica-atom.org/doc/Glossary#Current_language current language] to display the [https://www.ica-atom.org/doc/Glossary#User_interface|user interface] and [https://www.ica-atom.org/doc/Glossary#Database_content database content] in any of the other [https://www.ica-atom.org/doc/Glossary#Supported_language supported languages].
| |
| | | | |
| − | <div class="note"> | + | <admonition type="seealso"> |
| | + | For information on the current functionality of the multilingual design principles and features of AtoM, please see the "Multilingual" section of the AtoM [https://accesstomemory.org/docs User Manual.] |
| | + | </admonition> |
| | | | |
| − | Neither ICA-AtoM or AtoM 2.x automatically generate "translations" from one language to another. It is up to individual translators to do the translations, either in the interface (e.g., application elements and content) or using [https://www.transifex.com/projects/p/atom/ Transifex] to translate the application strings. The translations of content (e.g. archival descriptions) will always be linked to the primary archival description created first in the default language.
| + | __TOC__ |
| | | | |
| − | </div>
| |
| | | | |
| − | ==Current status== | + | ===[[Development/Multilingual/Historical|Historical development documentation]]=== |
| | | | |
| − | Following the release of 2.0, a number of issues related to the search and presentation of multilingual content in AtoM have been reported by our users, and confirmed by AtoM Product Managers. In February 2014, AtoM Product Manager Jessica Bushey began a series of comprehensive tests to better understand and document the current functionality, limits to this implementation, and possible solutions. Below is a list of bugs (either outstanding, which have been tested and confirmed in 2.x, or newly filed), feature requests, and testing workflows produced during this evaluation.
| + | Early development documentation, copied from the now-defunct Qubit-Toolkit wiki, which was originally used to capture development focused resources and documentation for AtoM development. This page primarily deals with the changes introduced when a new search index [https://www.elastic.co/products/elasticsearch Elasticsearch] was introduced to AtoM with the release of [[Releases/Release announcements/Release 2.0.0|AtoM 2.0.0]], and the changes and challenges this introduced. |
| | | | |
| | + | * [[Development/Multilingual/Historical]] |
| | | | |
| − | == Outstanding Bugs ==
| |
| | | | |
| − | * Bug [https://projects.artefactual.com/issues/2912 2912] Adding an unsupported language.
| + | ===[[Development/Multilingual/2.x development|2.x development]]=== |
| − | * Bug [https://projects.artefactual.com/issues/6264 6264] Adding a supported language causes error.
| |
| − | * Bug [https://projects.artefactual.com/issues/3250 3250] Can't export multilingual descriptions (EAD export)
| |
| − | * Bug [https://projects.artefactual.com/issues/3433 3433] Can't translate relationship
| |
| − | * Bug [https://projects.artefactual.com/issues/3479 3479] When creating new user translation languages don't "stick"
| |
| − | * Bug [https://projects.artefactual.com/issues/6265 6265] Subject and place terms cannot be translated
| |
| − | * Bug [https://projects.artefactual.com/issues/3697 3697] Can't select actor name if actor was created in another language.
| |
| − | * Bug [https://projects.artefactual.com/issues/3698 3698] Container names created in one language are not available in drop-down in other languages.
| |
| − | * Bug [https://projects.artefactual.com/issues/3700 3700] When switching language in information object edit screen, screen switches to new record. THIS IS ONLY IN ICA-AtoM 1.x, not AtoM 2.x
| |
| − | * Bug [https://projects.artefactual.com/issues/3844 3844] RAD specific fields don't show when not in source culture. THIS IS ONLY IN ICA-AtoM 1.x, not AtoM 2.x
| |
| − | * Bug [https://projects.artefactual.com/issues/3845 3845] RAD specific fields not available in edit mode if another language is chosen. THIS IS ONLY IN ICA-AtoM 1.x, not AtoM 2.x
| |
| − | * Bug [https://projects.artefactual.com/issues/4090 4090] i18n: isolate "This is a mandatory element" from other strings.
| |
| − | * Bug [https://projects.artefactual.com/issues/4113 4113] Add new term: "Use for" label is not translated.
| |
| − | * Bug [https://projects.artefactual.com/issues/3274 3274] "Add new" label not i18n in dialog.js & multiRow.js.
| |
| − | * Bug [https://projects.artefactual.com/issues/4163 4163] In edit template the "Add New" hyperlink and in rights and donor dialogs the "submit" and "cancel" button labels in English only.
| |
| − | * Bug [https://projects.artefactual.com/issues/6294 6294] Search for terms doesn't work in interface other than English
| |
| − | * Bug [https://projects.artefactual.com/issues/4279 4279] Translator cannot edit published descriptions - permission denied.
| |
| − | * Bug [https://projects.artefactual.com/issues/5582 5582] Archival institutions failure in new language.
| |
| − | * Bug [https://projects.artefactual.com/issues/6316 6316] Setting default language other than English doesn't stick
| |
| − | * Bug [https://projects.artefactual.com/issues/5914 5914] Create a second accession in the same day in a culture different than "en" gives '500 Internal Server Error.
| |
| − | * Bug [https://projects.artefactual.com/issues/6216 6216] Archival description cannot be created from accession by editor when culture is not in English.
| |
| − | * Bug [https://projects.artefactual.com/issues/6314 6314] Languages facet and specific language filter should show related description and authority records in source language.
| |
| − | * Bug [https://projects.artefactual.com/issues/6315 6315] export:bulk doesn't export other cultures
| |
| | | | |
| − | == Feature Requests ==
| + | This page will capture a brief summary of bug fixes and enhancements added to AtoM's multilingual functionality since the AtoM 2.0.0 release |
| | | | |
| − | * Feature [https://projects.artefactual.com/issues/2218 2218] Automate "language of description" in Description control area | + | * [[Development/Multilingual/2.x development]] |
| − | * Feature [https://projects.artefactual.com/issues/3246 3246] Apply culture fallback to information object search results
| |
| − | * Feature [https://projects.artefactual.com/issues/3988 3988] Allow adding a custom language or script from dialog.
| |
| − | * Feature [https://projects.artefactual.com/issues/6313 6313] Language of archival description should be hyperlink.
| |
| | | | |
| − | == Search Scenarios for translated content==
| |
| | | | |
| − | === Scenario One: Searching for title in translated archival description === | + | ===[[Development/Multilingual/Future development|Future development]]=== |
| − | #Default language for site is English. Create an archival description in English and save. Title is: "Englishonly"
| |
| − | #Switch language interface to language other than English (e.g., French) and translate the content of the archival description including the title and save. Title is: "Anglaiseseulment"
| |
| − | #Search for "Anglaiseseulment" in French interface using the main search box, AtoM will prompt and you get accurate result. Notice that the language facet on the left side of the results screen shows (1) hit in Anglaise filter and (1) hit in Francais filter. If you click on either, you will see the french archival description "Anglaiseseulment".
| |
| − | #Search for "Englishonly" in French interface using the main search box and results show: "Anglaiseseulment" archival description. Notice that the language facet on the left side of the results screen shows (1) hit in Anglaise filter and (1) hit in Francais filter. If you click on either, you will see the french archival description "Anglaiseseulment".
| |
| − | #Switch to English language interface and search for "Englishonly", AtoM will prompt and you get accurate result. Notice that the language facet on the left side of the results screen shows (1) hit in English filter and (1) hit in French filter. If you click on either, you will see the english archival description "Englishonly".
| |
| − | #Search for "Anglaiseseulment" in the English interface using the main search box and results show: "Englishonly" archival description. Notice that the language facet on the left side of the results screen shows )1) hit in English filter and (1) hit in French filter. If you click on either, you will see the english archival description "Englishonly". See Bug [https://projects.artefactual.com/issues/6314 6314]
| |
| | | | |
| − | === Scenario Two: Searching for terms in scope and content in translated archival description ===
| + | This page is a place to document feature requests, add wishlist items, consider implementation challenges, add requirements, and other considerations and content related to possible future development of the multilingual functionality in AtoM. Note that considerations posted here '''do not guarantee inclusion in a future release.''' |
| − | #Default language for site is English. Create an archival description in English and save. Term in scope and content is: "rabbits"
| |
| − | #Switch language interface to language other than English (e.g., French) and translate the content of the archival description including the scope and content and save. Term in scope and content is: "lapins".
| |
| − | #Search for "lapins" in French interface using the main search box and get accurate result. Notice that the language facet on the left side of the results screen shows (1) hit in Anglaise filter and (1) hit in Francais filter. If you click on either, you will see the french archival description that includes "lapins" in the scope and content.
| |
| − | #Search for "rabbits" in French interface using the main search box and results show the related french archival description that has "lapins" in the scope and content.
| |
| − | #Switch to English language interface and search for "rabbits", AtoM will give you accurate results. Notice that the language facet on the left side of the results screen shows )1) hit in English filter and (1) hit in French filter. If you click on either, you will see the english archival description.
| |
| − | #Search for "lapins" in the English interface using the main search box and results show the related english archival description that has "rabbits" in the scope and content. See bug [https://projects.artefactual.com/issues/6314 6314]
| |
| | | | |
| − | === Scenario Three: Searching for name and terms in translated authority records ===
| + | * [[Development/Multilingual/Future development]] |
| − | #Default language for site is English. Create an authority record in English and save. Include name and bio/history.
| |
| − | #Switch language interface to language other than English (e.g., French) and translate the authority record name and bio/history etc. and save.
| |
| − | #Search for french name in main search bar, AtoM prompts and provides accurate french authority record in result.
| |
| − | #Search for french terms (included in bio/history) in main search bar, AtoM provides accurate related french archival description in result.
| |
| − | #Go to browse authority records and search for english name in sub-search bar, AtoM provides accurate results and also provides the option of using the language facet to select the french authority record from either anglaise filter or francais filter.
| |
| − | #Search for english terms (included in bio/hisotry) in main search bar, AtoM provides accurate related french archival description in result.
| |
| − | #Switch to English language interface and search for english name in main search bar, AtoM prompts and provides accurate english authority record in result.
| |
| − | #Search for english terms (included in bio/history) in main search bar, AtoM provides accurate related english archival description in result.
| |
| − | #Go to browse authority records and search for french name in sub-search bar, AtoM provides accurate results and also provides the option of using the language facet to select the english authority record from either english filter or french filter.
| |
| − | #Search for french terms (include in bio/history) in main search bar, AtoM provides accurate related english archival description in result.
| |
| | | | |
| − | == Search Scenarios for content created in other languages (not translated) == | + | <admonition type="seealso"> |
| | + | * You can check our [[Releases/Roadmap|Project roadmap]] to see if there is any upcoming multlilingual development! |
| | + | * You can also search for unsponsored feature requests related to multilingual functionality in the [https://projects.artefactual.com/projects/atom-wishlist/issues AtoM Wishlist] issue tracker |
| | + | </admonition> |
| | | | |
| − | === Scenario One: Searching for <i>title</i> of archival descriptions created in other languages (not translated) ===
| + | ----- |
| − | #Default language for site is English. Create an archival description in a language other than English (e.g., Spanish) and save.
| |
| − | #Stay in the Spanish language interface and search for the <b>title</b> of the new archival description using the main search box. AtoM will provide a prompt for the title of the archival description. You receive ACCURATE search result.
| |
| − | #If you switch to English language interface and search for the foreign language title in the main search bar, you will NOT receive any results. See bug issue: [https://projects.artefactual.com/issues/6294 6294].
| |
| | | | |
| − | === Scenario Two: Searching for <i>term in scope and content</i> of archival descriptions created in other languages (not translated)===
| + | * [[Development|Back to the Development page]] |
| − | #Default language for site is English. Create an archival description in a language other than English (e.g., Spanish) and save.
| |
| − | #Stay in the Spanish language interface and search for the <b>terms in scope and content</b> of the new archival description using the main search box. NO RESULTS. See bug issue: [https://projects.artefactual.com/issues/6294 6294].
| |
| | | | |
| − | === Scenario Three: Searching for authority records created in other languages (not translated) ===
| |
| − | #Default language for site is English. Create an authority record in a language other than English (e.g., Spanish) and save. "Flores, Maria"
| |
| − | #Stay in the Spanish language interface and search for the name "Flores, Maria" in the main search bar, AtoM prompts and you get the accurate result.
| |
| − | #Stay in the Spanish language interface and click on the browse authority records. Enter "Flores" into the sub-search bar for authority records only. AtoM provides a result, but YOU MUST CLICK ON THE SPANISH filter in the IDIOMA (language) facet on the left side of the screen to get the accurate result. The default for results is English.
| |
| − | #Switch to English language interface and search for the name "Flores" in the main search bar, AtoM has NO results.
| |
| − | #Stay in English language interface and click on the browse authority records. Enter "Flores" into the sub-search bar for authority records only. AtoM provides a result, but YOU MUST CLICK ON THE SPANISH filter in the language facet on the left side of the screen to get the accurate result. The default for results is English.
| |
| | | | |
| − | === Scenario Four: Searching for terms in the bio/history of authority records created in other languages (not translated)===
| |
| − | #Default language for site is English. Create an authority record in a language other than English (e.g., Spanish) and add terms to bio/history of authority record: "chevaux" and save.
| |
| − | #Stay in the Spanish language interface and search for "chevaux" in the main search bar, AtoM provides a result, but YOU MUST CLICK ON THE SPANISH filter in the IDIOMA (language) facet on the left side of the screen to see the related archival description.
| |
| − | #Stay in the Spanish language interface and click on the browse authority records. Enter "chevaux" into the sub-search bar for authority records only. AtoM provides a result, but YOU MUST CLICK ON THE SPANISH filter in the IDIOMA (language) facet on the left side of the screen to get the accurate result for the authority record.
| |
| − | #Switch to English language interface and search for "chevaux" in the main search bar, AtoM provides a result, but YOU MUST CLICK ON THE SPANISH filter in the language facet on the left side of the screen to see the related spanish archival description.
| |
| − | #Stay in English language interface and click on the browse authority records. Enter "chevaux" into the sub-search bar for authority records only. AtoM provides a result, but YOU MUST CLICK ON THE SPANISH filter in the language facet on the left side of the screen to get the accurate result for the authority record.
| |
| | | | |
| − | == Wish List ==
| |
| − | * Enter archival description using English interface. Search database, but have option for search results to "expand search to all languages".
| |
| | | | |
| | [[Category:Development documentation]] | | [[Category:Development documentation]] |
On this page you'll find historical development documentation about the the multilingual functionality of AtoM, including historical documentation of the functionality in earlier versions of ICA-AtoM and AtoM, information about development enhancements added to 2.x, and discussions about future development considerations for enhancing multilingual functionality and usability.
Early development documentation, copied from the now-defunct Qubit-Toolkit wiki, which was originally used to capture development focused resources and documentation for AtoM development. This page primarily deals with the changes introduced when a new search index Elasticsearch was introduced to AtoM with the release of AtoM 2.0.0, and the changes and challenges this introduced.
This page will capture a brief summary of bug fixes and enhancements added to AtoM's multilingual functionality since the AtoM 2.0.0 release
This page is a place to document feature requests, add wishlist items, consider implementation challenges, add requirements, and other considerations and content related to possible future development of the multilingual functionality in AtoM. Note that considerations posted here do not guarantee inclusion in a future release.
