从定义目录树中合并和查找首字母缩略词。
foal的Python项目详细描述
小马驹
FOAL（来自组织缩写查找）是一个从集合中查找首字母缩略词的工具 YAML文件。在
给定多个定义缩略词和缩写的YAML文件，合并 按上下文敏感顺序排列的词典和查找首字母缩略词。在
什么
在上下文感知文件中定义首字母缩略词和缩写，然后 合并和查找定义，能够区分上下文的优先级。在
例如，给定这些文件：
# technology.yamlacronyms:cpu:shortform:CPUlongform:Central Processing Uniteps:shortform:EPSlongform:Encapsulated Postscript^{pr2}$
获取一个首选技术上下文的词典：
$ foal -p technology.yaml [WARNING] prefer context: ['technology.yaml'] --- acronyms: cogs: shortform: COGS longform: Cost of Goods Sold source: finance.yaml cpu: shortform: CPU longform: Central Processing Unit source: technology.yaml eps: shortform: EPS longform: Encapsulated Postscript source: technology.yaml
找一本更喜欢金融背景的词典：
$ foal -p finance.yaml [WARNING] prefer context: ['finance.yaml'] --- acronyms: cogs: shortform: COGS longform: Cost of Goods Sold source: finance.yaml cpu: shortform: CPU longform: Cost per Unit source: finance.yaml eps: shortform: EPS longform: Earnings per Share source: finance.yaml
查找特定于技术上下文的首字母缩略词：
$ foal -p technology.yaml -a cpu [WARNING] prefer context: ['technology.yaml'] --- acronyms: cpu: shortform: CPU longform: Cost per Unit source: technology.yaml
为什么
有时需要从规范列表中查找首字母缩略词以在中使用 文档。首字母缩略词（或缩写词）可以在automated中使用 文档工具 pandoc-acronyms。在
缩略词是人们在自己的参照系中使用的词汇。 缩略词的普遍接受取决于多种因素，例如 政治格局、技术专长、地区差异、背景和 母语。在
例如，世界上大多数人都承认美利坚合众国 作为美国，英国是英国，德国是BRD （德国联邦共和国）。说英语的人更容易认出 当它用于奥运会比赛或国际比赛时 新闻广播比当BRD随机出现在文档中时。在
再举一个例子，CPU。在
- 在
信息技术人员 立即想到Central Processing Unit。在
在 - 在
金融界人士可能会想到每单位成本为Cost， 尤其是当CPU用于金融领域时。在
在
断章取义，缩略语很难解释，并可能导致 重要文件中的误解。在
关于数据结构
- 在
目录树中的
在global.yaml是权威的。
{cd1>中的缩略语 其他文件。这应该是一个全局上下文 在整个组织中具有普遍意义。产品名称， 总线和团队都是global.yaml的好选择。在 - 在
此格式不会not指定其他文件中首字母缩略词的层次结构 在git回购中。只有
在global.yaml具有特殊优先级。工具开发人员 作者可以选择将其他文件按优先顺序合并 在特定的背景下是有意义的。在 - 在
目录树中文件的“上下文”定义保留在上面 个人贡献者（而不是
在global.yaml）。包容一切。 TimTowtdi。在
安装
从PyPI
pip install --user foal
来源
pip install --user .
发展
运行：
sdlc/bootstrap sdlc/build sdlc/test
请参见^{
- 项目
标签：
欢迎加入QQ群-->： 979659372
