2024-07-27 23:28:14 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "shortcut icon" href = "./favicon.ico" >
< script src = "./assets/v0.63.6/app-dist/share.js" > < / script >
< link href = "./assets/v0.63.6/libraries/normalize.min.css" rel = "stylesheet" >
< link href = "./assets/v0.63.6/stylesheets/share.css" rel = "stylesheet" >
< link href = "./assets/v0.63.6/libraries/ckeditor/ckeditor-content.css" rel = "stylesheet" >
< title > Guidelines< / title >
< / head >
< body data-note-id = "Z9N9OKBXXLFW" data-ancestor-note-id = "4yYHqKbLovVX" >
< div id = "layout" >
< div id = "main" >
< nav id = "parentLink" >
parent: < a href = "hkrBX8KE1HQl.html"
class="type-text">Internationalisation / Translations< / a >
< / nav >
< h1 id = "title" > Guidelines< / h1 >
< div id = "content" class = "type-text ck-content" >
< ul > < li > Use hierarchy whenever appropriate, try to group the messages by:< ul > < li > Modals (e.g. < code > about.foo< / code > , < code > jump_to_note.foo< / code > )< / li > < / ul > < / li > < li > Don't duplicate messages that are very widely used.< ul > < li > One such example is < code > aria-label="Close"< / code > which should go to a single message such as < code > modal.close< / code > instead of being duplicated in every modal.< / li > < / ul > < / li > < li > On the other hand, don't overly generalise messages. A < code > close< / code > message that is used whenever the “Close” word is encountered is not a good approach since it can potentially cause issues due to lack of context.< / li > < li > Use < a href = "https://www.i18next.com/translation-function/interpolation" > variable interpolation< / a > whenever appropriate.< ul > < li > If you see multiple messages joined together only to apply add a variable such as a user-inputted value, try to join those messages together into a single message containing a variable.< / li > < li > So instead of < code > “Number of updates: “ + numUpdates + “.”< / code > use < code > $(t("number_updates", { numUpdates }))< / code > where the message translation would appear as < code > Number of updates: {{numUpdates}}.< / code > < / li > < / ul > < / li > < / ul >
< / div >
< / div >
< button id = "toggleMenuButton" > < / button >
< nav id = "menu" >
< p >
< a class = "type-text" href = "4yYHqKbLovVX.html" > Developer' s Guide< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "VS22Hq5PBFNf.html" > Dependency Management< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "QXCi6Y1SYulw.html" > Adding a new client library< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "C09Dou56ffMe.html" > Having a simpler packaging system< / a >
< / p >
< / li >
< / ul >
< / li >
< li >
< p >
< a class = "type-text" href = "ZlxZh8NH5frM.html" > Building and deployment< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "PHqgH8FCfcod.html" > Documentation< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "btM6L9JtG301.html" > Running a development build< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "UTB518X6X9Uh.html" > Build deliveries locally< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "biDJ9KgbWLgt.html" > Releasing a version< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "rU1hxvgqlA9x.html" > CI< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "BhE2WFknKKHG.html" > Main< / a >
< / p >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< p >
< a class = "type-text" href = "xtBYDVZPb0gr.html" > Project maintenance< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "s5gsYTbPQr6c.html" > Updating dependencies< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "X4N03xLYEWnN.html" > bettersqlite binaries< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "GMta9hBHsXHQ.html" > Node.js, Electron and `better-sqlite3`< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "jvdjFBOCCrOa.html" > Testing compatibility< / a >
< / p >
2024-08-02 00:20:17 +03:00
< / li >
< li >
< p >
< a class = "type-text" href = "WKn3hLGmKmiH.html" > CKEditor< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "MUGBo4n67kBI.html" > Environment setup< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "icQBu8R1ij57.html" > Building & updating< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "zpR91YHYs6lL.html" > Differences from upstream< / a >
< / p >
< / li >
< / ul >
2024-07-27 23:28:14 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< p >
< a class = "type-text" href = "B8hxg4e66cVL.html" > Development and architecture< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "hkrBX8KE1HQl.html" > Internationalisation / Translations< / a >
< / p >
< ul >
< li >
< p >
< strong > Guidelines< / strong >
< / p >
2024-07-27 23:49:56 +03:00
< / li >
< li >
< p >
< a class = "type-text" href = "KRC2O84LekPz.html" > i18n-ally< / a >
< / p >
2024-07-27 23:28:14 +03:00
< / li >
< / ul >
< / li >
< li >
< p >
< a class = "type-text" href = "XxqZW6JjkW2g.html" > Live reload< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "3jc1nUXyteo0.html" > Themes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "U5RtMeGPeZ29.html" > Synchronisation< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "d3dnvVOhur16.html" > Content hashing< / a >
< / p >
< / li >
< / ul >
< / li >
< li >
< p >
< a class = "type-text" href = "mPGbEmYGitWe.html" > Build information< / a >
< / p >
2024-07-27 23:49:56 +03:00
< / li >
< li >
< p >
< a class = "type-text" href = "zCDxk5VFdsqg.html" > Database< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "wCxCJB3hhojs.html" > attachments< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "wxCwZ1P2SGCx.html" > attributes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "6x42mhlfLo0o.html" > blobs< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "Vy1PbjSkUast.html" > branches< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "inGKXCChkVYX.html" > entity_changes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "y2ido6E6tZ0V.html" > etapi_tokens< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "kAfgZERKtVhU.html" > notes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "FSZoX3cJlJE7.html" > options< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "bzQfhyzDo3Xz.html" > recent_notes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "QYMncZf5Bu3D.html" > revisions< / a >
< / p >
< / li >
< / ul >
< / li >
< li >
< p >
< a class = "type-text" href = "KbwD5mDpD4CV.html" > Protected entities< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "IuxV242YGaN5.html" > Deleted notes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "FJ4VR6G2M6VD.html" > Special notes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "1l1f6WZbaBEZ.html" > Branch prefixes< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "QSkfVssHIngA.html" > Revisions< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "cemIoFLfEGPO.html" > Backlinks< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "VbDoDdiHEemi.html" > Note types< / a >
< / p >
< / li >
< li >
< p >
< a class = "type-text" href = "UDBwK5Fhr2CT.html" > Safe mode< / a >
< / p >
2024-07-27 23:28:14 +03:00
< / li >
< / ul >
< / li >
< li >
< p >
2024-07-27 23:49:56 +03:00
< a class = "type-text" href = "3eTu21fjtZkj.html" > Scripting< / a >
2024-07-27 23:28:14 +03:00
< / p >
< ul >
< li >
< p >
2024-07-27 23:49:56 +03:00
< a class = "type-text" href = "1pOWnHdGAuWR.html" > Widgets< / a >
< / p >
< ul >
< li >
< p >
< a class = "type-text" href = "8jWguCtuKsAt.html" > Right pane widget< / a >
2024-07-27 23:28:14 +03:00
< / p >
2024-07-27 23:49:56 +03:00
< / li >
< li >
< p >
< a class = "type-text" href = "4FXLAtcPhZFo.html" > CSS< / a >
< / p >
< / li >
< / ul >
2024-07-27 23:28:14 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / body >
< / html >