Obsidian YAML Database 插件技术文档

Obsidian YAML Database 插件技术文档

1. 安装指南

手动安装

1. 从Releases页面下载main.js、style.css、manifest.json这三个文件。
2. 将这三个文件放在你的库路径/.obsidian/plugins/obsidian-yaml-database路径下。
3. 关闭第三方插件的安全模式，启用本插件。

使用BRAT插件安装

1. 在Obsidian中使用插件obsidian42-brat: BRAT。
2. 输入1657744680/obsidian-yaml-database进行安装。

2. 项目使用说明

代码块：表格编辑YAML

表格的创建与简介

• 创建表格的语法：

  ```yamledit
  输入一个id值
  

• 一个独一无二的id对应一个数据表格的配置信息。

操作区域

• 新建：在选定文件夹下新建未命名文档，支持模板文档。
• 搜索：对文件路径及文件的所有YAML属性值进行搜索。
• 编辑列：支持重命名显示名称、选择属性、编辑属性、重命名属性、隐藏属性、添加属性。
• 表格设置：控制属性显隐、分页条目数量、选择文件夹、模板文件配置。
• 刷新：重新读取缓存刷新表格。

行操作与编辑

• 支持双击单元格编辑、右键删除文档、多选批量编辑属性值、文档命名。

过滤和排序

• 点击表头进行排序和过滤操作，支持多条件排序。

列宽与拖动

• 支持直接拖动列排序，拖拽设置列的宽度。

支持的属性类型

• 文本、数字、日期、时间、复选框、图片、链接、标签、文本框、内部链接、单选、多选、公式、创建时间、修改时间。

命令：还原上一步操作

• 当误操作修改属性数据时，使用该命令回到上一步。

设置面板：管理渲染过的数据表格

• 可以选择将数据表格的配置信息存储在插件文件夹或者库的某个文件夹中。
• 支持删除某个id数据表格的配置信息。

3. 项目API使用文档

Formula属性（高级）

• 使用prop(属性名)获取该属性的值。
• 获取的属性值均为字符串。
• 编写JavaScript对属性值进行操作，使用return返回显示的值。

数据表格配置信息存储（高级）

• 所有id对应的数据表格的配置信息存储在插件所在文件夹中的data.json中。
• 包含参数：id、paginationSize、folder、templatePath、colDef、filterModal。

4. 项目安装方式

手动安装

1. 下载main.js、style.css、manifest.json。
2. 放置在你的库路径/.obsidian/plugins/obsidian-yaml-database路径下。
3. 关闭安全模式，启用插件。

使用BRAT插件安装

1. 使用插件obsidian42-brat: BRAT。
2. 输入1657744680/obsidian-yaml-database进行安装。