章节小插件
概述
章节小插件是 Labii ELN 和 LIMS 中用于在单条记录内创建内容丰富、结构清晰的文档的基本构件。列小插件用于采集表格列中的离散数据点,仪表板小插件用于提供工作空间级分析;与它们不同,章节小插件可以为记录添加灵活且内容丰富的章节,用于记录实验、方案、分析和流程。每条记录都可以包含多个由不同小插件支持的章节,例如用于编写操作步骤的简单富文本、质粒编辑器和微孔板设计器等复杂科学工具、数据可视化与计算器,以及评论和任务等协作功能。章节小插件让记录不再只是简单的数据容器,而是成为完整的文档环境。科研人员可以在一条可追溯的记录中记录实验背景、嵌入科学图表、整合分析结果、显示相关数据、管理工作流程并满足监管合规要求。
了解章节小插件
什么是章节小插件?
章节小插件是一种模块化内容单元,可添加到任何记录中,用于记录特定类型的信息或提供特定功能。查看或编辑记录时,每个章节会根据其小插件类型显示相应的内容或工具。例如:
- Rich Text 章节提供文字处理器,用于编写实验步骤
- Table 章节提供电子表格功能,用于记录测量结果
- Plasmid Editor 章节显示交互式质粒图谱,用于分子生物学工作
- Chart 章节可视化数据趋势或分布
- Comments 章节支持团队围绕记录进行沟通
章节小插件与其他类型小插件的区别
了解不同类型小插件之间的区别非常重要:
- 章节小插件(此类别):在单条记录内运行,提供文档和内容工具,处理非结构化及半结构化数据;一条记录可包含多个章节
- 列小插件:在表格列中运行,采集结构化数据点;每个记录与列的交叉位置存储一个值,主要用于数据录入和验证
- 仪表板小插件:在工作空间级运行,分析多条记录,并显示在仪表板中而非记录内
主要特性
- 记录范围:章节小插件在单条记录的上下文中运行,但也可以显示相关记录中的数据
- 灵活内容:列小插件使用严格的数据类型,而章节小插件可以处理文档、图表和复杂布局等内容丰富的非结构化数据
- 多个实例:一条记录可以包含多个使用相同小插件类型的章节,例如使用多个 Rich Text 章节分别记录文档的不同部分
- 可配置:大多数章节小插件都提供配置选项,可自定义其行为、外观或数据源
- 上下文感知:章节小插件可以访问并显示当前记录各列及相关记录中的数据
- 版本跟踪:章节的更改会记录在该记录的审计追踪中,以满足监管合规要求
章节小插件的工作方式
创建或编辑记录时:
- 添加章节:单击 "Add Section",然后选择适合文档需求的小插件类型
- 配置:部分小插件需要进行初始配置,例如选择数据源或定义参数
- 输入内容:使用小插件界面添加内容,例如编写文本、绘制图表、输入数据或选择选项
- 查看和编辑:在只读视图(用于查看)与编辑视图(用于修改内容)之间切换
- 版本控制:系统会自动记录所有更改,并保存时间戳和用户归属信息
小插件类别
章节小插件根据主要用途分为以下功能类别:
办公
用于在章节内创建文档、电子表格和管理文件的生产力工具。
- 办公 - Google 文档、表格和幻灯片,Microsoft Office 集成、Google Drive 和类似 Excel 的表格
数据显示
显示相关记录、列数据以及其他记录中的章节内容,以便更好地理解上下文和浏览信息。
- 数据显示 - 记录列表、列显示小插件和章节嵌入工具
生物学
面向生命科学工作流程的科学工具,包括序列分析、微孔板设计和测定跟踪。
- 生物学 - 测定分析、生物信息学、微孔板、分子生物学套件(质粒/序列编辑器)、蛋白质可视化和样品分装
化学
用于化学结构绘制、光谱分析和化学专业文档记录的工具。
- 化学 - 化学结构编辑器和化学相关的可视化工具
报告
用于创建图表、图形和统计摘要的数据可视化与分析工具。
- 报告 - 自定义输入图表、数据驱动的可视化和记录摘要分析
数据分析
用于配方设计、优化计算和物料规划的专业工具。
- 数据分析 - 用于试剂配制的配方计算器和优化算法
图表
用于流程图、概念图、流程可视化和关系映射的可视化绘图工具。
- 图表 - Mermaid 图表、阶段流程图、关系流程图和可视化工作流程工具
流程管理
通过分步执行和操作触发器实现工作流程自动化和流程跟踪。
- 流程管理 - 流程图、步骤跟踪和自动化工作流程执行
生产力
用于提升效率的工具,包括评论、任务、条形码、反向链接和元数据显示。
- 生产力 - 评论(标准和 GLP)、任务列表、二维码、条形码、章节引用和沟通工具
监管
面向电子签名、审计追踪和监管文档要求的合规工具。
- 监管 - 用于满足 GLP 和 FDA 21 CFR Part 11 合规要求的电子签名工作流程
参考文献管理
用于将已发表研究整合到实验文档中的文献管理工具。
- 参考文献管理 - 用于摘要、引文和元数据检索的 PubMed 集成
组合
同时整合列功能和章节功能的专业小插件,用于高级应用场景。
- 组合 - 需要协调使用列功能和章节功能的小插件
入门指南
用户指南
- 添加章节:查看记录时,单击 "Add Section" 查看可用的小插件类型。选择符合文档记录需求的小插件。
- 基本文档记录:首先使用 Rich Text 章节记录操作步骤和观察结果,再根据具体内容类型添加其他小插件。
- 编辑章节:单击任意章节上的 Edit 图标以修改内容。完成后单击 Save。
- 整理章节:拖放章节,使其在记录中按合理顺序排列。
- 了解视图:大多数章节都有只读视图(默认)和编辑视图。部分章节还提供配置设置,可通过 Configure 按钮访问。
- 使用科学工具:探索生物学和化学小插件,使用序列编辑或结构绘制等专业功能。
管理员指南
- 表格模板:配置表格模板,使新记录自动包含默认章节。
- 选择小插件:根据公司的需求启用特定章节小插件。无需向所有用户提供所有小插件。
- 培训用户:指导用户针对不同的文档记录场景选择合适的小插件。创建示例记录以展示最佳实践。
- 设计工作流程:使用流程管理小插件标准化并自动执行复杂流程。
- 合规设置:根据合规要求配置监管小插件,例如签名和 GLP 评论。
- 性能注意事项:注意章节的复杂程度;包含许多大型章节的记录可能加载较慢。
常见用例
实验记录
组合使用 Rich Text 记录操作步骤、Table 记录测量结果、Chart 可视化结果,并使用 Image 保存仪器照片。添加 Comments 供团队讨论,并用 Tasks 跟踪后续操作。
方案制定
使用 Rich Text 编写分步说明,使用 Section Citations 引用相关方案,使用 Diagram 展示工作流程,并使用流程管理小插件创建可执行的工作流程。
样品表征
添加 Microplate 小插件设计板布局,使用 Data Driven Charts 绘制分析曲线,使用 Column Display 小插件显示关键样品属性,并用 File Upload 章节保存光谱或图像。
分子生物学工作
使用 Plasmid Editor 显示构建体,使用 Sequence Analysis 处理 DNA 或蛋白质,使用 Rich Text 记录克隆策略,并用 Table 保存引物序列。
监管文档
组合使用 GLP Comments 进行受控沟通、Signature 小插件执行审批工作流程、Rich Text 编写合规文档,并使用 Audit 小插件验证数据完整性。
最佳实践
- 选择合适的小插件:根据内容需求选择小插件类型。如果简单的 Rich Text 已经足够,请勿使用 Table 小插件。
- 合理组织:按合理的流程排列章节,完整呈现实验或方案的脉络。
- 使用描述性标题:为每个章节指定清晰说明用途的标题,该标题与小插件类型相互独立。
- 减少重复:使用 Data Display 小插件显示相关数据,避免在多条记录中重复信息。
- 利用模板:创建包含常用章节结构的表格模板,确保一致性并节省时间。
- 考虑受众:以读者为出发点记录文档,思考他们需要哪些背景信息才能理解您的工作。
- 保持重点:将非常长的文档拆分为多条相关记录,避免创建难以管理的单条记录。
- 记录重要更改的版本:对关键文档进行重大更新时,请创建新版本,而不是直接覆盖原内容。
文档标准
章节小插件文档采用以下标准结构:
- 概述:小插件的用途和功能
- 用例:适合使用该小插件的常见场景
- 配置:设置选项和要求
- 界面:如何在只读视图和编辑视图中使用小插件
- 其他功能:特殊功能或操作按钮
- 最佳实践:有效使用小插件的建议
- 相关小插件:适合搭配使用的互补小插件
技术说明
- 数据存储:章节内容以结构化数据形式存储在 Labii 数据库中,并保留版本历史记录以满足合规要求。
- 权限:章节的可见性和可编辑性遵循 Labii 在项目及团队级别的权限系统。
- 性能:复杂小插件(例如处理大型序列的质粒编辑器)的加载速度可能比简单文本章节慢。
- 浏览器兼容性:大多数章节小插件可在现代浏览器中运行,但部分高级功能可能需要 Chrome 或 Edge。
- 移动端支持:章节小插件针对桌面端使用进行了优化。支持在移动端查看,但小屏幕上的编辑功能可能受限。