r - R 包中的双语(英语和葡萄牙语)文档

Question

我正在编写一个软件包，以方便导入巴西社会经济微观数据集(人口普查、PNAD 等)。我预见该软件包有两个不同的用户组:

• 巴西的用户可能会对以下文档感到更放心葡萄牙语。他们可能能在某种程度上理解英语，但是外语可能会让包装感觉不那么重要“符合人体工程学”。

• 更广泛的国际用户社区，来自英语文档可能是一个必要条件。

是否可以以“双语”文档(英语和葡萄牙语)的方式编写包，并且向用户显示的语言取决于他们的国家/语言设置？

另外，

这在 roxygen2 文档框架内可行吗？

我意识到，通过双语使包变得更加用户友好与增加复杂性和维护难度之间存在权衡。也欢迎根据以前的经验对这种权衡提出一般性评论。

编辑:根据评论的建议，我交叉发布了 r-package-devel 邮件列表。 HERE ，然后按照底部的答案进行操作。 Duncan Murdoch 发布了一个有趣的答案，涵盖了 @Brandons 答案(如下)的一些内容，但还包括我认为有用的两个额外建议:

• 有一种语言的软件包，但有不同语言的小插图语言。我会遵循这个建议。

• 必须有软件包的版本，比方说 1.1 和 1.2，各一个语言

Answer 1

根据Ropensci ，没有将包文档翻译成非英语语言的标准机制。他们描述了internationalization/localization的典型流程如下:

To create non-English documentation requires manual creation ofsupplemental .Rd files or package vignettes.

Packages supplyingnon-English documentation should include a Language field in theDESCRIPTION file.

有关语言字段的更多信息:

A ‘Language’ field can be used to indicate if the packagedocumentation is not in English: this should be a comma-separated listof standard (not private use or grandfathered) IETF language tags ascurrently defined by RFC 5646 (https://www.rfc-editor.org/rfc/rfc5646,see also https://en.wikipedia.org/wiki/IETF_language_tag), i.e., uselanguage subtags which in essence are 2-letter ISO 639-1(https://en.wikipedia.org/wiki/ISO_639-1) or 3-letter ISO 639-3(https://en.wikipedia.org/wiki/ISO_639-3) language codes.

如果您的包包含非 ASCII 文本，特别是如果它打算在多个语言环境中使用，则需要小心。可以标记描述文件和 .Rd 文件中使用的编码。

关于编码...

First, consider carefully if you really need non-ASCII text. Manyusers of R will only be able to view correctly text in their nativelanguage group (e.g. Western European, Eastern European, SimplifiedChinese) and ASCII.72. Other characters may not be rendered at all,rendered incorrectly, or cause your R code to give an error. For .Rddocumentation, marking the encoding and including ASCIItransliterations is likely to do a reasonable job. The set ofcharacters which is commonly supported is wider than it used to bearound 2000, but non-Latin alphabets (Greek, Russian, Georgian, …) arestill often problematic and those with double-width characters(Chinese, Japanese, Korean) often need specialist fonts to rendercorrectly.

与此相关的是，R 确实提供了对 "errors and warnings" in different languages 的支持。 - “有机制来转换 R 级和 C 级错误和警告消息。仅当 R 是使用 NLS 支持编译时才可用(这是由配置选项 --enable-nls 请求的)默认值)。”