Best practice to develop a good notes application from the globalization perspective

Best practice to develop a good Notes application from the globalization perspective Xiao Feng Ji: [email_address] Ya Ling Xu: [email_address] IBM Lotus Notes/Domino Globalization Team

Agenda ,[object Object],[object Object],[object Object],[object Object],[object Object]

Difficulties in Notes template globalization ,[object Object],pt-BR de zh-TW fr es ja it zh ko ... xx Language Packs zh-TW Base Product en

Difficulties in Notes template globalization (cont.) ,[object Object],Script Folder View Formula Notes application

Difficulties in Notes template globalization (cont.) ,[object Object],Tag Term Tagged application Glossary (for translation)

Difficulties in Notes template globalization (cont.) ,[object Object],Build Translation Tagged application Translated glossary Language application

Domino Global Workbench ,[object Object]

Process for localizing the design of a source application ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Creating a DGW project for the application to be localized ,[object Object],[object Object],Source application This is the application to be localized. It can be a database (.nsf) or a template (.ntf). It can hold Notes Design elements, as well as user documents (called Help documents) and the Notes Profile document. Glossary database The glossary database (.nsf) will holds the strings which DGW extracts from the Source application. It is created with a specially design template which has been installed during the DGW installation. (It is also possible to use customized DGW glossary templates.) The glossary database will hold the translations. Tagged application The tagged application is the logical link between the translations and the source application. It is automatically created when DGW performs the extraction of strings into the glossary. It also holds information for later updating. Language application This is the localized application, and results from building the source, the tagged applications and the glossary databases

Populating the glossary ,[object Object],[object Object]

Preventing strings from being translated (DNT) ,[object Object],[object Object]

Overview of the building process ,[object Object]

How to avoid the improper design from G10N perspective ,[object Object]

Avoid using concatenation strings in your codes ,[object Object],[object Object],Listing 1. Code piece for using concatenation strings in Formula @If(FirstDayOut = "" | FirstDayBack = ""; ""; "I will be out of the office starting " + @Text(@Date(FirstDayOut)) + " and will not return until " + @Text(@Date(FirstDayBack)) + ".")

Avoid using concatenation strings in your codes ,[object Object],Figure3.

Avoid using concatenation strings in your codes (cont.) Figure4.

Avoid using concatenation strings in your codes (cont.) ,[object Object],[object Object],Listing 2. Resourced out translatable terms Form.(Out_Of_Office_Profile).Str1=I will be out of the office starting Form.(Out_Of_Office_Profile).Str2=and will not return until

Avoid using concatenation strings in your codes (cont.) ,[object Object],Listing 3. The proposed approach to avoid using concatenation strings Listing 1. Code piece for using concatenation strings in Formula @ReplaceSubstring("I will be out of the office starting var_startdate and will not return until var_returndate.";"var_startdate":"var_returndate":@Text(@Date(FirstDayOut)):@Text(@Date(FirstDayBack))) @If(FirstDayOut = "" | FirstDayBack = ""; ""; "I will be out of the office starting " + @Text(@Date(FirstDayOut)) + " and will not return until " + @Text(@Date(FirstDayBack)) + ".")

Avoid using concatenation strings in your codes (cont.) ,[object Object],Listing 4. Resourced out translatable terms(Correct example) Form.(Out_Of_Office_Profile)_|_OutOfOfficeProfile.PostRecalc.Str1 = I will be out of the office starting var_startdate and will not return until var_returndate

Do not use translatable strings as programming conditions Listing 5. Code pieces for using translatable strings as programming conditions 1. REM "Begin Do Not Translate" 2. Const DSPIND = "dspIndividualAccess" 3. REM "End Do Not Translate" 4. REM "Begin Translatable Text” 5. Const CALENDER_NOTICES = "Calendar notices are automatically forwarded to this person" 6. REM "End Translatable Text” 7. Set item = note.getfirstitem(DSPIND) 8. strIndividualAccess = item.Text 9. lposition = Instr( strIndividualAccess, CALENDER_NOTICES) 10. If lposition > 0 And lposition <> 1 Then 11. ' strip off fwd msg 12. strIndividualAccess = Left( strIndividualAccess, lposition-2 ) 13. Elseif lposition = 1 Then 14. strIndividualAccess = "" 15. Else 16. strIndividualAccess = Left( strindividualAccess, Len(strindividualAccess)-1) 17. End If

Do not use translatable strings as programming conditions ,[object Object],Listing6. translation of two variables English Form.(Calendar_Profile).var1=Calendar notices are automatically forward to this person. Form.(Calendar_Profile).var2=Calendar notices are automatically forward to this person when I am a meeting chair. Chinese Form.(Calendar_Profile).var1= 自動發送日曆通知給這個人。 Form.(Calendar_Profile).var2= 當我是會議主持人時自動發送日曆通知給這個人。

Do not use translatable strings as programming conditions Listing 7. These functions in LotusScript and Formula should avoid to be used for translatable strings LotusScript @Formula Covert Cstr, Cint, Cdat, Abstract, StrConv, Lcase, Ucase, @LowerCase, @ProperCase, @LwerCase, @UpperCase, @TextToNumber, @TextToTime, @Explode, @Replace Compare StrToken, StrCompare, Split, like @ReplaceSubstring, @Matches@Like, @Contains Length Mid, Len, LenC @Length Position Left, StrLeft, StrLeftback, Right, StrRight, StrRightback, Instr, Trim, Contains, RightBP, MidBP @Left, @Middle, @Middleback, @Begins, @Ends, @LeftBack, @RightBack, @Right Other Join @Word

Avoid using combination of text and fields on UI ,[object Object],Listing 8. translation of two variables Figure5. A bad UI example Form.Response.Str1=The response is for Form.Response.Str2=and was send by

Avoid using combination of text and fields on UI (cont.) ,[object Object],Listing 9. Translate the whole sentence into Simplified Chinese English This response is for dPrincipal and was sent by dForm_1 . Chinese 這封回信是給 dPrincipal 而且是由 dForm_1 所寄送的。

Add comments for DNT variables and Hidden variables ,[object Object],Listing 10. Add comments for DNT variables and Hidden variables 1. DNT Variables in the Formula REM "Begin Do Not Translate" <Formula Code> REM "End Do Not Translate" 2. DNT Variables in the LotusScript 'Begin Do Not Translate REM {Begin Do Not Translate}; <LotusScript Code> 'End Do Not Translate REM {End Do Not Translate}; 3. Always hidden variables 'Begin Always Hidden variables <Hidden variables> 'End Always Hidden variables

Add comments for translatable variables ,[object Object],Listing 11. Add comments for translatable variables { REM The text of the next string determines the order of display of the following strings "FamilyName" and "GivenName" } OrderOfStings := "FamilyNameFirst"; Field1 := "FamilyName"; Field2 := "GivenName"; { REM Begin DNT } FIELD Display:=@If(OrderOfStrings = "FamilyNameFirst " ;Field1+Field2; Field2+Field1) { REM End DNT } DGW will produce property file values that will look like this.# The text of the next string determines the order of display of the following strings "FamilyName" and "GivenName" Form.Memo.Action_Label_Formula.FamilyNameFirst = FamilyNameFirst Form.Memo.Action_Label_Formula.FamilyName = FamilyName Form.Memo.Action_Label_Formula.GivenName = GivenName

Tips: Naming the DNT variable ,[object Object],Listing 12. Naming the DNT variables with a combination of uppercase and lowercase REM {Begin Do Not Translate}; update = "upDatE"; updateInformation = "inForMation upDatE"; requestInformation = "reQuesT InforMation"; requestupDate= "reQuesT upDate"; REM {End Do Not Translate};

Never “hard code” strings in your code ,[object Object],Listing 13. Hard coded strings in LotusScript should be avoid, below is a bad example Function GetString(nIndex As Integer, vData As Variant) As String Select Case nIndex Case RECALL_STRING_MSGTO GetString = "Message to: " Case RECALL_STRING_MSGSTATUS GetString = " Message status: " Case RECALL_STRING_FAILREASON GetString = " Recall failure reason: " Case RECALL_STRING_NORESPONSES GetString = "Your recall request has been initiated. For more information, open the Recall Status report for this message when you receive it." Case RECALL_STRING_OTHERREPORT GetString = "Other delivery reports. (No recall information is available) " End Select End Function

Never “hard code” strings in your code (cont.) Listing 14. A good example to define the variables instead of hard code the strings in codes Function GetString(nIndex As Integer, vData As Variant) As String REM "Begin Translatable Text” Const xxMessage = "Message to: " Const xxMessageStatus = " Message status: " Const xxMessageFailReason = " Recall failure reason: " Const xxMessageInitia= "Your recall request has been initiated. For more information, open the Recall Status report for this message when you receive it." Const xxMessageOtherReport = "Other delivery reports. (No recall information is available) " REM "End Translatable Text” Select Case nIndex Case RECALL_STRING_MSGTO GetString = xxMessage Case RECALL_STRING_MSGSTATUS GetString = xxMessageStatus Case RECALL_STRING_FAILREASON GetString = xxMessageFailReason Case RECALL_STRING_NORESPONSES GetString = xxMessageInitia Case RECALL_STRING_OTHERREPORT GetString = xxMessageOtherReport End Select End Function

Define and assign your variables ONLY at the beginning of your script ,[object Object]

Do not use normal legible words when naming internal variables. ,[object Object],Listing 16. Don’t use normal legible words when naming your internal variables @if(xxdocname = "Interest Profile";"Interest Profile";"Standard Document") @if(xxdocname = "InterestProfile";"Interest Profile";"Standard Document")

Create the alias for the keyword of option field (e.g. Listbox, Checkbox, etc) Figure7. Listbox choices list

At least assign one alias name for the forms and views. ,[object Object],[object Object]

Use table instead of “tab” key to separate the static text from the field. ,[object Object],Figure8. Using tab key for layout control(English) Figure9. Using tab key for layout control(Korea)

Decode and encode the variable which will show on web ,[object Object],Figure10. Garbage code on window title Listing 18. Decode the variable PartialName := @Right(@URLDecode("Domino";Query_String);"&Title=")

International Considerations ,[object Object],[object Object],[object Object]

International considerations (Cont’d) ,[object Object],Number of characters Additional space required 1 - 10 100% - 200% 11 - 20 80% - 100% 21 - 30 60% - 80% 31 - 50 40% - 60% 51 - 70 31% - 40% Over 70 30%

International considerations (Cont’d) ,[object Object],[object Object],[object Object]

Conclusion ,[object Object],[object Object]

References ,[object Object],[object Object]

Best practice to develop a good notes application from the globalization perspective

Best practice to develop a good notes application from the globalization perspective

Recomendados

Recomendados

Más contenido relacionado

Último

Último (20)

Destacado

Destacado (20)

Best practice to develop a good notes application from the globalization perspective