ckeditor5/locale:國(guó)際化方案

ckeditor5的locale方案會(huì)往全局變量window.CKEDITOR_TRANSLATIONS上掛載映射用的字典信息:

window.CKEDITOR_TRANSLATIONS = {
    pl: {
    dictionary: {
        'Cancel': 'Anuluj',
        'Add space': [ 'Dodaj spacj?', 'Dodaj %0 spacje', 'Dodaj %0 spacji' ]
    },
    // A function that returns the plural form index.
    getPluralForm: n => n !==1
}

add方法會(huì)更新window.CKEDITOR_TRANSLATIONS中對(duì)應(yīng)語(yǔ)言下dictionarygetPluralForm方法:

  locale = new Locale( {
    uiLanguage: 'pl',
    contentLanguage: 'de'
  } );
  const getPolishPluralForm = n => n == 1 ? 0 : n % 10 >= 2 && n % 10 <= 4 && ( n % 100 < 10 || n % 100 >= 20 ) ? 1 : 2;
  add('pl', {
     'foo': 'foo_pl',
     'bar': [ 'bar_pl_0', '%0 bar_pl_1', '%0 bar_pl_2' ]
  },  getPolishPluralForm);
  addTranslations( 'de', {
    'foo': 'foo_de',
    'bar': [ 'bar_de_0', '%0 bar_de_1', '%0 bar_de_2' ]
  } );
// 測(cè)試用例
const t = locale.t;

expect( t( { string: 'bar', plural: '%0 bars' }, [ 1 ] ), 1 ).to.equal( 'bar_pl_0' );
expect( t( { string: 'bar', plural: '%0 bars' }, [ 2 ] ), 2 ).to.equal( '2 bar_pl_1' );
expect( t( { string: 'bar', plural: '%0 bars' }, [ 5 ] ), 3 ).to.equal( '5 bar_pl_2' );
// 更新示例
add( 'pl', {
    'ADD_SPACE': [ '%1 spacj?', '%1 %0 spacje', '%1 %0 spacji' ],
    'Add': 'Dodaj',
    'Remove': 'Usuń'
} );
const addOrRemoveSpaceMessage = { string: '%1 a space', plural: '%1 %0 spaces', id: 'ADD_SPACE' };
expect( t( addOrRemoveSpaceMessage, [ 1, t( 'Add' ) ] ), 1 ).to.equal( 'Dodaj spacj?' );
expect( t( addOrRemoveSpaceMessage, [ 2, t( 'Remove' ) ] ), 2 ).to.equal( 'Usuń 2 spacje' );
expect( t( addOrRemoveSpaceMessage, [ 5, t( 'Add' ) ] ), 3 ).to.equal( 'Dodaj 5 spacji' );

t(message, values = [])方法

  • 如果message是字符串脆贵,那么將message轉(zhuǎn)換為對(duì)象形式message = { string: message}
    如果values不是數(shù)組狮腿,那么將values轉(zhuǎn)換為數(shù)組形式values = [ values]
  • 如果存在message.plural,則常量quantity取值values[0],否則quantity設(shè)置為1
  • 執(zhí)行translate(language, message, quantity)方法到映射的值,可能直接就是原始的message字符串,也可能是values中某個(gè)選項(xiàng)何什,而這個(gè)選項(xiàng)中可能有類(lèi)似%o%1這樣的插值疙筹,這就需要執(zhí)行下一步的interpolateString方法再次轉(zhuǎn)換富俄。translate(language, message, quantity)執(zhí)行邏輯如下:
    1.如果只有一種語(yǔ)言禁炒,也就是Object.keys( window.CKEDITOR_TRANSLATIONS ).length === 1的話,將用這唯一的語(yǔ)言來(lái)設(shè)置入?yún)?code>language
    2.如果window.CKEDITOR_TRANSLATIONS中沒(méi)有任何設(shè)置或者找不到messageId(即message.id || message.string)對(duì)應(yīng)的翻譯霍比,那么當(dāng)入?yún)?code>quantity為1時(shí)幕袱,直接返回message.string,不為1時(shí)悠瞬,直接返回message.plural
    3.否則们豌,當(dāng)messageId(即message.id || message.string)對(duì)應(yīng)的翻譯是字符串時(shí),直接返回該字符串浅妆,例如上例中t( 'Add' )返回的就是Dodaj望迎;如果對(duì)應(yīng)的翻譯是數(shù)組(用arr臨時(shí)表示),那么就要根據(jù)上例中add方法的第三個(gè)入?yún)⒓春瘮?shù)getPluralFormquantity參數(shù)凌外,來(lái)獲取一個(gè)下標(biāo)辩尊,然后返回arr[下標(biāo)],例如上例中t( addOrRemoveSpaceMessage, [ 2, t( 'Remove' ) ] )其實(shí)就是t({ string: '%1 a space', plural: '%1 %0 spaces', id: 'ADD_SPACE' }, [2, 'Usuń'])康辑,會(huì)根據(jù)id ADD_SPACE找到對(duì)應(yīng)的翻譯選項(xiàng)數(shù)組[ '%1 spacj?', '%1 %0 spacje', '%1 %0 spacji' ]摄欲,然后通過(guò)getPolishPluralForm(2)計(jì)算出下標(biāo)為1,最終返回'%1 %0 spacje'疮薇。
  • 執(zhí)行interpolateString胸墙,如上文(上一節(jié)第3小節(jié))中示例最后返回'%1 %0 spacje',執(zhí)行interpolateString('%1 %0 spacje', [2, 'Usuń'])按咒,結(jié)果為'Usuń 2 spacje'迟隅。
// Fills the `%0, %1, ...` string placeholders with values.
function interpolateString( string, values ) {
    return string.replace( /%(\d+)/g, ( match, index ) => {
        return ( index < values.length ) ? values[ index ] : match;
    } );
}

Setting the UI language

  • 支持rtl語(yǔ)言,如阿拉伯語(yǔ)励七;
  • 富文本UI語(yǔ)言默認(rèn)是英語(yǔ)智袭,支持npm、cdn和zip三種方式加載其他語(yǔ)言包呀伙;
  • 也可以借助ckeditor5-dev-webpack-plugin插件补履,引用其他語(yǔ)言包添坊,其原理大概是加載po文件剿另,將po文件中的翻譯納入ckeditor中。大致步驟如下:
    1.在po文件中設(shè)置翻譯用的映射信息
    zh-ch.po文件中是一些翻譯用的映射信息贬蛙,截圖如下:
    圖1:修改段落為段落123

    圖2:效果圖

2.加載po文件

loadPackage( pathToPackage ) {
    if ( this._handledPackages.has( pathToPackage ) ) {
        return;
    }
    this._handledPackages.add( pathToPackage );
    const pathToTranslationDirectory = this._getPathToTranslationDirectory( pathToPackage, this._language );
// pathToPoFile即為po文件路徑雨女,如node_modules\_@ckeditor_ckeditor5-heading@16.0.0@@ckeditor\ckeditor5-heading\lang\translations\zh-cn.po
    const pathToPoFile = pathToTranslationDirectory + path.sep + this._language + '.po';
    this._loadPoFile( pathToPoFile );
}

如上代碼,會(huì)輸出各ckeditor包中指定目錄下指定語(yǔ)言的po文件阳准,如node_modules\_@ckeditor_ckeditor5-heading@16.0.0@@ckeditor\ckeditor5-heading\lang\translations\zh-cn.po

圖3:lang/translations/*.po

3.translateSource方法(類(lèi)似babel)通過(guò)acorn修改源碼氛堕,將調(diào)用t()方法的地方,全部替換成翻譯后的文本

function translateSource( source, sourceFile, translateString ) {
    const comments = [];
    const tokens = [];
    const errors = [];

    const ast = acorn.parse( source, {
        sourceType: 'module',
        ranges: true,
        onComment: comments,
        onToken: tokens,
        ecmaVersion: 9
    } );

    let changesInCode = false;

    walk.simple( ast, {
        CallExpression: node => {
            if ( node.callee.name !== 't' ) {
                return;
            }

            if ( node.arguments[ 0 ].type !== 'Literal' ) {
                errors.push( `First t() call argument should be a string literal in ${ sourceFile }.` );

                return;
            }

            changesInCode = true;
            node.arguments[ 0 ].value = translateString( node.arguments[ 0 ].value );
        }
    } );

    // Optimization for files without t() calls.
    if ( !changesInCode ) {
        return { output: source, errors };
    }

    escodegen.attachComments( ast, comments, tokens );
    const output = escodegen.generate( ast, {
        comment: true
    } );

    return { output, errors };
};

效果舉例:例如“圖2:效果圖”中標(biāo)題下拉框野蝇,對(duì)應(yīng)heading插件讼稚,其依賴一個(gè)插件叫HeadingUI括儒,它的init方法片段如下:

init() {
    const dropdownTooltip = t( 'Heading' );
}

經(jīng)過(guò)translateSource代碼轉(zhuǎn)換后,代碼轉(zhuǎn)為:

init() {
    const dropdownTooltip = t( '段落123' );
}

再例如锐想,ckeditor5/src/utils中:

const localizedTitles = {
    Paragraph: t( 'Paragraph' ),
    'Heading 1': t( 'Heading 1' ),
    'Heading 2': t( 'Heading 2' ),
    'Heading 3': t( 'Heading 3' ),
    'Heading 4': t( 'Heading 4' ),
    'Heading 5': t( 'Heading 5' ),
    'Heading 6': t( 'Heading 6' )
};

會(huì)轉(zhuǎn)換為:

const localizedTitles = {
    Paragraph: t('段落123'),
    'Heading 1': t('標(biāo)題 1'),
    'Heading 2': t('標(biāo)題 2'),
    'Heading 3': t('標(biāo)題 3'),
    'Heading 4': t('標(biāo)題 4'),
    'Heading 5': t('標(biāo)題 5'),
    'Heading 6': t('標(biāo)題 6')
};

通過(guò)上述方法帮寻,實(shí)現(xiàn)了“圖2:效果圖”中標(biāo)題下拉框中的“段落123”的效果。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末赠摇,一起剝皮案震驚了整個(gè)濱河市固逗,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌藕帜,老刑警劉巖烫罩,帶你破解...
    沈念sama閱讀 211,743評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異洽故,居然都是意外死亡贝攒,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,296評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門(mén)时甚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)饿这,“玉大人,你說(shuō)我怎么就攤上這事撞秋〕づ酰” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 157,285評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵吻贿,是天一觀的道長(zhǎng)串结。 經(jīng)常有香客問(wèn)我,道長(zhǎng)舅列,這世上最難降的妖魔是什么肌割? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,485評(píng)論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮帐要,結(jié)果婚禮上把敞,老公的妹妹穿的比我還像新娘。我一直安慰自己榨惠,他們只是感情好奋早,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,581評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著赠橙,像睡著了一般耽装。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上期揪,一...
    開(kāi)封第一講書(shū)人閱讀 49,821評(píng)論 1 290
  • 那天掉奄,我揣著相機(jī)與錄音,去河邊找鬼凤薛。 笑死姓建,一個(gè)胖子當(dāng)著我的面吹牛诞仓,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播速兔,決...
    沈念sama閱讀 38,960評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼狂芋,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了憨栽?” 一聲冷哼從身側(cè)響起帜矾,我...
    開(kāi)封第一講書(shū)人閱讀 37,719評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎屑柔,沒(méi)想到半個(gè)月后屡萤,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,186評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡掸宛,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,516評(píng)論 2 327
  • 正文 我和宋清朗相戀三年死陆,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片唧瘾。...
    茶點(diǎn)故事閱讀 38,650評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡措译,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出饰序,到底是詐尸還是另有隱情领虹,我是刑警寧澤,帶...
    沈念sama閱讀 34,329評(píng)論 4 330
  • 正文 年R本政府宣布求豫,位于F島的核電站塌衰,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏蝠嘉。R本人自食惡果不足惜最疆,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,936評(píng)論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望蚤告。 院中可真熱鬧努酸,春花似錦、人聲如沸杜恰。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,757評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)箫章。三九已至烙荷,卻和暖如春镜会,著一層夾襖步出監(jiān)牢的瞬間檬寂,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,991評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工戳表, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留桶至,地道東北人昼伴。 一個(gè)月前我還...
    沈念sama閱讀 46,370評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像镣屹,于是被迫代替她去往敵國(guó)和親圃郊。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,527評(píng)論 2 349