`、`
`、``、``这几个 inline 元素\n* `` 的 `- ` 以 `*␣` 打头（注意有空格）\n* `
` 的 `- ` 以 `1.␣`、`2.␣`...打头（注意有空格）\n* 用作例子的部分，以 `
` 包裹\n\n### 关于 key 的「类型约定」建议\n\n> 我发现很多人对「类型」一点都不感冒，什么是「属性」，什么是「操作」一点都没有概念，导致写出来的文案虽然在用户看来没有问题，但定义的却一塌糊涂。\n\n一般我会用 **一个** 单词来表示文案的类型，每种类型在含义、书写上都会有一定的特点，在一个项目下，不可能有太多的类型，以下是我在项目中常用的类型：\n\n| 单词 | 简写 | 含义 | 场景 | 文案规范 |\n|-----------|-----|-----|------------------------------------|------------------------------|\n| `attr` | `a` | 属性 | 标题 | 名词，英文遵循首每个单词（除介词、冠词等）字母大写 |\n| `op` | `o` | 属性 | 按钮 | 动词，英文遵循首每个单词（除介词、冠词等）字母大写 |\n| `type` | `t` | 类型 | 字段展示 | 名词，英文遵循首每个单词（除介词、冠词等）字母大写 |\n| `status` | `s` | 状态 | 字段展示 | 形容词，英文遵循首每个单词（除介词、冠词等）字母大写 |\n| `title` | - | 标题 | 标题 | 名词，英文遵循首每个单词（除介词、冠词等）字母大写 |\n| `label` | `l` | 标题 | 按钮、字段展示 | 名词/动词，英文遵循首每个单词（除介词、冠词等）字母大写 |\n| `message` | `m` | 长句子 | 标题 | 必须有结束标点，不可断句，不可断章 |\n| `phrase` | `p` | 短句子 | 标题 | 没有结束标点的句子（不建议） |\n\n以上，我们可以将在特定对象的 `attr`、`op`、`type`、`status` 进行聚合，比如：\n\n```typescript\nexport default {\n 'user:attr:id': '用户 ID',\n 'user:attr:name': '用户名',\n 'user:op:create': '创建用户',\n 'user:op:edit': '编辑用户',\n 'user:op:delete': '删除用户',\n 'user:type:normal': '普通',\n 'user:type:vip': 'VIP',\n 'user:type:svip': '超级 VIP',\n 'user:status:new': '未认证',\n 'user:status:verified': '已认证',\n 'user:status:unregstered': '已注销',\n};\n```\n\n聚合后，可以是这样：\n\n```typescript\nexport default {\n 'user?attr': `{attr, select,\nID {用户 ID}\nNAME {用户名}\nother {{attr}}}`,\n 'user?op': `{op, select,\nCREATE {创建用户}\nEDIT {编辑用户}\nDELETE {删除用户}\nother {{op}}}`,\n 'user?type': `{type, select,\nNORMAL {普通}\nVIP {VIP}\nSVIP {超级 VIP}\nother {{type}}}`,\n 'user?status': `{status, select,\nNEW {未认证}\nVERIFIED {已认证}\nUNREGSTERED {已注销}\nother {{status}}}`\n};\n```\n\n我更推荐这种聚合的定义方式，它有以下好处：\n\n1. 更内聚，相关的内容一定会定义在一个地方\n2. 可以用 `intlChoices` 搭配常量枚举快速生成选项列表\n3. 可以用 `intlConst` 搭配常量枚举快速转化常量为文案\n\n## FAQ\n\n### 可以直接用 `@alicloud/console-components-intl` 么？\n\n可以，但一万个不推荐。你可以在你的 `intl/index.ts` 的最末把 `@alicloud/console-components-intl` export 出去再用，但千万不要直接用 `@alicloud/console-components-intl`，\n原因是你在别人 import 的 `@alicloud/console-components-intl` 有可能是没有初始化完毕的——这就是那个臭烘烘的 `initializer.js` 的来由。\n\n### 文案中可否有 HTML？\n\n可以，首先你的 key 在末尾要带上 HTML 指令 `!html`（你可以自定义）。\n\n其次，不要有 block 级别的元素，可以用 `strong`、`em`、`code`、`kbd`、`a`，这些元素会有一定的样式。\n\n### 如何转义花括号？\n\n`This '{isn''t}' obvious` → `This {isn't} obvious`\n\n参考 \n\n### 文案如何不断章？\n\n不断句和不断章，这个在国际化的场景下非常重要。不断句可以利用插值，那么不断章（即一个文案中可能有多个段落）怎么处理呢？\n\n你的 key 需要有 `!lines` 指令（同样可以自定义），你写文案的时候，该文案是带换行（`\\n`）的。\n\n文案中的每一行，会被解析成 `p`，`ul > li`（该行以 `1.␣`、`2.␣` 等打头）或 `ol > li`（该行以 `*␣` 打头）。\n\n`!html` 和 `!lines` 是可以合起来用的，比如 `!html!lines` 或 `!lines!html`（建议选择一种风格，不要都用）。\n\n### 文案中的链接怎么跟渠道链接配置结合？\n\n你只需要在调用工厂方法的时候，第三个 `options` 参数中传入 `extraValues` 即可：\n\n```typescript\nwindXIntl(messages, LOCALE, { // LOCALE 视你应用的具体情况而定，你也可以通过 options 做一些定制\n extraValues: LINKS\n});\n```\n\n以上，`LINKS` 是你的应用在 viper 配置的渠道链接的输出。\n\n而你在定义你的文案时，这么定义：\n\n```json\n{\n \"x:message:about_xx_with_some_link!html\": \"...，详情可以查看 帮助文档\"\n}\n```\n\n注意 `help:xxx` 不可定义成 `help.xxx`，会报错（至少我当时用的时候是这样）。\n\n于是，当你 `intl('x:message:about_xx_with_some_link!html')` 的时候，其中的链接自然而然地被替换成了渠道链接中对应的配置。\n\n但是，如果渠道链接是需要参数的，就无法这么做了。\n\n### 文案中有 HTML 和换行，但 key 末尾没有指令，如何正常展示？\n\n首先，强烈推荐 key 末尾带上 `!html` 和 `!lines` 指令，它的好处在于看到 key 就知到它长什么样，而且你不需要额外的编码就可以自动展示成你期望的样式。\n\n但如果你一定不加，你可以用 `intl` 的第三个参数，`html` 和 `lines` 可以同时存在，也可以只有一个为 `true`：\n\n```typescript\nintl('x:message:with_html_but_no_indicators', undefined, {\n html: true,\n lines: true\n})\n```\n\n### 如何避免传错 key？\n\n你必须本地有一份「完整」的兜底文案，这很重要，一是保证代码的完整性，二是，在使用 TS 的场景下，可以帮你避免输错 key 的场景。\n","readmeFilename":"README.md"}