README

Tripal 字段生成器

这是一个 CLI 工具，用于帮助自动化生成用于 Tripal 字段，用于 Tripal 3 开发。我们强烈建议您在使用此工具之前阅读开发者手册。它支持创建 Tripal 和 Chado 字段。

文档

安装

使用 Composer

安装 Tripal Fields Generator 最简单的方法是使用 Composer。

安装命令

composer global require "statonlab/fields_generator:~0.1"

更新命令

composer global update

注意：请确保通过运行以下命令导出 composer 的 bin 目录

# Add this line to your .bashrc or .bash_profile to persist between shell sessions.
export PATH="$PATH:~/.composer/vendor/bin"

手动安装

您可以通过上面的 "克隆或下载" 按钮，或使用 Git 克隆来下载此工具。

git clone https://github.com/statonlab/fields_generator.git

用法

通过运行以下命令并回答几个问题来生成一个新的字段。默认情况下，Tripal Fields Generator 将生成 Chado 字段，但它也可以生成 Tripal 字段。

# If installed globally with composer
makefield [--output|-o=/full/path/to/module]

# If installed manually without composer
./makefield [--output|-o=/full/path/to/module]

生成器将要求您提供 DB 名称和 CV 名称：这些名称对应于 chado.db 和 chado.cv 表。如果您不确定这些值是什么，可以使用 EBI 官方词汇表查询服务 CVterm 条目作为指导：DB 名称是橙色框中的值，CV 名称是青色框中的值。有关完整说明，请参阅 CV 指南。

此外，下表显示了 Tripal 3 中常用本体论的 DB 和 CV 值。

为了使 Drupal 能够识别您的字段，您必须...

• 将此工具生成的文件放置在正确的位置（见下文）
• 指定您的字段将附加到的捆绑包。此工具生成的字段默认附加到 organism 捆绑包。
• 清除缓存（drush cc all）。
• 在结构 -> Tripal 内容中添加字段

选项

输出

Tripal Fields Generator 将创建四个文件来定义您的字段。对于在 local CV 中定义的自定义控制词汇（CV）术语 example，字段定义在三个文件中

• 字段类，local__example.inc
• 字段格式化程序，local__example_formatter.inc
• 字段小部件，local__example_widget.inc

此外，还会生成一个描述在您的模块中声明的字段的字段文件占位符：对于此示例模块，文件可能是 tripal_example_module.fields.inc。请注意，所有 模块中的字段都在这里描述：运行 Tripal Fields Generator 多次需要您将此文件组合为每个字段。您的字段最终结构应类似于下面的示例，其中给定字段 CV__CVTERM 位于 module/includes/TripalFields/CV_CVterm 中，而 module.fields.inc 位于 module/includes 中。有关字段的完整示例，请访问 Tripal Example Module 存储库，由 @laceysanderson 提供。

输出文件结构

默认情况下，模块级别的字段文件（moduleName.fields.inc）将放置在CV__CVterm_output中，而定义您的字段的类将在字段文件夹CV__CVterm_output/CV__CVterm中。请注意，CV的值对应于您为DB输入的值，而不是CV表！

CV__CVterm_output/
├── CV__CVterm/
│   ├── CV__CVterm.inc
│   ├── CV__CVterm_formatter.inc
│   └── CV__CVterm_widget.inc  
└── module.fields.inc

您需要将这些文件移动到上一节中提到的模式。或者，您可以使用输出标志指定不同的输出路径，例如-o="/path/to/module"或--output="/path/to/module"。这将自动在正确的位置定义您的字段。在任何情况下，您的最终模块字段结构应如下所示。

module/
├── includes/
│   ├── TripalFields/
│   │   └── CV__CVterm/
│   │       ├── CV__CVterm.inc
│   │       ├── CV__CVterm_formatter.inc
│   │       └── CV__CVterm_widget.inc
│   └── module.fields.inc
└── rest of my module...

术语

以下术语必须为每个生成的字段提供。

• 字段标签：字段的易读标签。例如，种质摘要
• 字段描述：字段的易读描述
• 模块名称：该字段随附的模块的机器名称。例如，tripal_germplasm_module
• 数据库名称:
• CV名称:
• 受控词汇术语：术语名称。例如，germplasm_summary
• 登记号：此术语在词汇中的登记号，例如30021。这必须与Chado中的dbxref值匹配。生物CV将始终使用数字CV术语。语义CV通常使用字符串。

示例

贡献

贡献非常受欢迎且被推荐。

• 分支仓库。
• 创建一个包含您代码的分支。
• 创建一个带有对您的贡献的明确描述的拉取请求，以便我们进行审查。

许可证

此工具受GNU GPLv2许可。版权所有 2017 田纳西大学。保留所有权利。

Tripal Fields Generator的“标志”是从收藏卡牌游戏炉石传说（Hearthstone）衍生而来，版权©暴雪娱乐，Inc。炉石传说®是暴雪娱乐，Inc.的注册商标。Tripal Fields Generator与炉石传说®或暴雪娱乐，Inc.无关或未获其认可。