自定义语言

大约 6 分钟...

本教程指引你自定义 Waline 多语言与显示文字。

自定义客户端语言和文字

@waline/client 提供了 locale 选项，你可以通过它自定义多语言与显示文字。

默认情况下，它会使用内置的多语言文字，并在语言不受支持时，回退到 en-US (英语美国)。

你可以传递一个完成的多语言配置给 locale 选项来新增语言支持，或者设置其中的几项对现有的 UI 文字进行覆盖。

locale 选项

等级相关:

level${number}: number 等级的文字

提示

比如你设置了 6 个等级，你可以这样定义它们:

Waline.init({
  locale: {
    level0: '炼体',
    level1: '炼气',
    level2: '筑基',
    level3: '金丹',
    level4: '元婴',
    level5: '化神',
  },
});

反应相关:
- reactionTitle: 反应标题
- reaction0: 反应 1 文字
- reaction1: 反应 2 文字
- reaction2: 反应 3 文字
- reaction3: 反应 4 文字
- reaction4: 反应 5 文字
- reaction5: 反应 6 文字
- reaction6: 反应 7 文字
- reaction7: 反应 8 文字
- reaction8: 反应 9 文字
UI 相关:
- nick: 昵称
- mail: 邮箱
- link: 网址
- placeholder: 评论框默认文字
- sofa: 评论区为空时的显示文字
- submit: 提交按钮文字
- comment: 评论按钮文字
- refresh: 刷新按钮文字
- more: 加载更多按钮文字
- uploading: 上传时显示文字
- login: 登录按钮文字
- admin: 管理员的标签
- sticky: 置顶文字
- word: 字
- anonymous: 匿名用户默认名称
- optional: 标明可选项的文字
- gifSearchPlaceholder: 表情包搜索占位文字
- oldest: 最早的评论
- latest: 最新的评论
- hottest: 最热的评论
相关信息
此分类内的文字会显示在页面上。
提示信息相关:
- nickError: 昵称不满足条件的错误信息
- mailError: 邮箱不满足条件的错误信息
- wordHint: 评论字数的错误提示，其中 $0 $1 $2 会被自动替换为字数允许下限、字数允许上限、当前字数。
评论时间相关:
- seconds: 秒前
- minutes: 分钟前
- hours: 小时前
- days: 天前
- now: 刚刚
管理相关:
- approved: 审核通过
- waiting: 等待审核
- spam: 垃圾评论
- unsticky: 取消置顶
无障碍相关:
- like: 喜欢文字
- cancelLike: 取消喜欢文字
- reply: 回复按钮的标签文字
- cancelReply: 取消回复按钮的标签文字
- preview: 预览按钮的标签文字
- emoji: 表情按钮的标签文字
- gif: 表情包按钮的标签文字
- uploadImage: 上传图片按钮的标签文字
- profile: 档案页标签文字
- logout: 退出登录按钮的标签文字
相关信息
上述文字只用于无障碍服务增强，不会显示在页面中。

例子

// 中文默认
const locale = {
  nick: '昵称',
  nickError: '昵称不能少于3个字符',
  mail: '邮箱',
  mailError: '请填写正确的邮件地址',
  link: '网址',
  optional: '可选',
  placeholder: '欢迎评论',
  sofa: '来发评论吧~',
  submit: '提交',
  like: '喜欢',
  cancelLike: '取消喜欢',
  reply: '回复',
  cancelReply: '取消回复',
  comment: '评论',
  refresh: '刷新',
  more: '加载更多...',
  preview: '预览',
  emoji: '表情',
  uploadImage: '上传图片',
  seconds: '秒前',
  minutes: '分钟前',
  hours: '小时前',
  days: '天前',
  now: '刚刚',
  uploading: '正在上传',
  login: '登录',
  logout: '退出',
  admin: '博主',
  sticky: '置顶',
  word: '字',
  wordHint: '评论字数应在 $0 到 $1 字之间！\n当前字数：$2',
  anonymous: '匿名',
  level0: '潜水',
  level1: '冒泡',
  level2: '吐槽',
  level3: '活跃',
  level4: '话痨',
  level5: '传说',
  gif: '表情包',
  gifSearchPlaceholder: '搜索表情包',
  profile: '个人资料',
  approved: '通过',
  waiting: '待审核',
  spam: '垃圾',
  unsticky: '取消置顶',
  oldest: '按倒序',
  latest: '按正序',
  hottest: '按热度',
  reactionTitle: '你认为这篇文章怎么样？',
};

Waline.init({
  el: '#waline',
  serverURL: 'YOUR_SERVER_URL',
  path: location.pathname,
  // ...
  locale,
});

自定义服务端文字

@waline/vercel 提供了 locales 选项，你可以通过它自定义文字。

默认情况下，它会使用内置的多语言文字，并在语言不受支持时，回退到 en-US (英语美国)对应的文字。

你可以传递一个完成的多语言配置给 locales 选项来新增语言支持，或者设置其中的几项对现有的文字进行覆盖。

提示

所有的自定义文字最终都会使用 nunjucks 模板引擎进行渲染，支持写一些比较复杂的逻辑表达式。例如：

注册确认邮件发送失败，请{%- if isAdmin -%}检查一下网站的邮件相关配置{% else %}确认你的邮箱输入无误并联系管理员{%- endif -%}。

locale 选项

提示信息相关：
- import data format not support!：文件格式不支持
- USER_EXIST：用户已存在
- USER_NOT_EXIST：用户不存在
- USER_REGISTERED：用户已注册
- TOKEN_EXPIRED：密钥已过期
- TWO_FACTOR_AUTH_ERROR_DETAIL：二步验证失败
- Duplicate Content：发送的内容之前已经发过
- Comment too fast：评论太快啦，请慢点！
登录邮件通知相关：
- [{{name | safe}}] Registration Confirm Mail：【{{name | safe}}】注册确认邮件
- Please click <a href=\"{{url}}\">{{url}}<a/> to confirm registration, the link is valid for 1 hour. If you are not registering, please ignore this email.：请点击 <a href=\"{{url}}\">{{url}}</a> 确认注册，链接有效时间为 1 个小时。如果不是你在注册，请忽略这封邮件。
- [{{name | safe}}] Reset Password：【{{name | safe}}】重置密码
- Please click <a href=\"{{url}}\">{{url}}</a> to login and change your password as soon as possible!：请尽快点击链接 <a href=\"{{url}}\">{{url}}</a> 登录并修改你的密码！
- Registration confirm mail send failed, please {%- if isAdmin -%}check your mail configuration{%- else -%}check your email address and contact administrator{%- endif -%}.：注册确认邮件发送失败，请{%- if isAdmin -%}检查一下网站的邮件相关配置{% else %}确认你的邮箱输入无误并联系管理员{%- endif -%}。
邮件通知相关：
- MAIL_SUBJECT：{{parent.nick | safe}}，『{{site.name | safe}}』上的评论收到了回复
- MAIL_TEMPLATE：<div style='border-top:2px solid #12ADDB;box-shadow:0 1px 3px #AAAAAA;line-height:180%;padding:0 15px 12px;margin:50px auto;font-size:12px;'> <h2 style='border-bottom:1px solid #DDD;font-size:14px;font-weight:normal;padding:13px 0 10px 8px;'> 您在<a style='text-decoration:none;color: #12ADDB;' href='{{site.url}}' target='_blank'>{{site.name}}</a>上的评论有了新的回复 </h2>{{parent.nick}}同学，您曾发表评论： <div style='padding:0 12px 0 12px;margin-top:18px'> <div style='background-color: #f5f5f5;padding: 10px 15px;margin:18px 0;word-wrap:break-word;'>{{parent.comment | safe}}</div><p><strong>{{self.nick}}</strong>回复说：</p><div style='background-color: #f5f5f5;padding: 10px 15px;margin:18px 0;word-wrap:break-word;'>{{self.comment | safe}}</div><p>您可以点击<a style='text-decoration:none; color:#12addb' href='{{site.postUrl}}' target='_blank'>查看回复的完整內容</a>，欢迎再次光临<a style='text-decoration:none; color:#12addb' href='{{site.url}}' target='_blank'>{{site.name}}</a>。</p><br/> </div></div>
- MAIL_SUBJECT_ADMIN：{{site.name | safe}} 上有新评论了
- MAIL_TEMPLATE_ADMIN：<div style='border-top:2px solid #12ADDB;box-shadow:0 1px 3px #AAAAAA;line-height:180%;padding:0 15px 12px;margin:50px auto;font-size:12px;'> <h2 style='border-bottom:1px solid #DDD;font-size:14px;font-weight:normal;padding:13px 0 10px 8px;'> 您在<a style='text-decoration:none;color: #12ADDB;' href='{{site.url}}' target='_blank'>{{site.name}}</a>上的文章有了新的评论 </h2> <p><strong>{{self.nick}}</strong>回复说：</p><div style='background-color: #f5f5f5;padding: 10px 15px;margin:18px 0;word-wrap:break-word;'>{{self.comment | safe}}</div><p>您可以点击<a style='text-decoration:none; color:#12addb' href='{{site.postUrl}}' target='_blank'>查看回复的完整內容</a></p><br/> </div>

例子

// index.js
const Waline = require('@waline/vercel');

module.exports = Waline({
  locales: {
    'zh-CN': {
      USER_EXIST: '用户已存在',
    },
    'en-US': {
      USER_EXIST: 'user exist!',
    },
  },
});