Obsidian 插件:【Readme】Financial Doc

Obsidian 插件:【Readme】Financial Doc

插件名片

  • 插件名称:Financial Doc
  • 插件作者:Studio Webux
  • 插件说明:在 Obsidian 中直接使用 CSV 格式和 Chart.js 进行财务文件和跟踪。
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

在 Obsidian 中直接使用 CSV 格式和 Chart.js 进行财务文件和跟踪。

Obsidian 插件:【Readme】Financial Doc--概述

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 findoc 插件的自述翻译

Findoc Logo

又一个工具 - Fin Doc

Obsidian.md插件,用于读取和编辑CSV文件,然后将其用作数据源生成图表。

欢迎您提出PR和问题,分享您的想法、改进等。

·


目录
  1. </li>
    <li></li>
    <li>
      
    </li>
    <li></li>
    <li></li>
    <li></li>
    <li></li>
    <li></li>
---

关于

  • 在 Obsidian 中打开和编辑 CSV 文件
  • 直接在 Obsidian 中使用 CSV 文件和自定义代码块生成图表
  • 可以通过少量设置进行配置
  • 支持桌面和移动设备(在 Windows、MacOS 和 iPhone 上进行了测试)
  • 使用 Chart.js
  • 适用于 Obsidian.md 的插件

安装

现在它处于 Beta 版本,您可以下载一个发布版本并将其安装在您的本地 obsidian 插件中。

一旦 CSV 方面稳定,我将在 Obsidian 插件注册表中开放一个 PR。

npm install
npm run build

main.jsmanifest.json 移动到名为 findoc 的目录中的插件目录中。

发布和 Github Actions

git tag -a X.Y.Z -m "版本 X.Y.Z"
git push origin tags/X.Y.Z

使用方法

模型

  • expenses
  • expensesMonthly
  • portfolio
  • incomeYearly
  • income
  • all
  • mortgage
  • mortgageRate
  • dividend

创建一个 PR 来创建新的模型。

您可以直接在设置选项卡中进行编辑。

代码块

您可以直接在笔记中定义此代码块。

```findoc
filename: finance.csv
model: portfolio
```

有关所有可用模型,请参见上面的内容。

一旦定义了代码块,钩子将尝试通过读取 csv 文件来生成图表。

CSV 文件

CSV 文件的表头是:

Type,Id,Value,TimeStamp,Extra

其中Type可以是以下之一:

  • Portfolio(投资组合)
  • Income(收入)
  • Mortgage(抵押贷款)
  • Mortgage Rate(抵押贷款利率)
  • Cotisation(社保费)
  • Dividend(股息)
  • House Expenses(房屋费用)
  • Expenses(其他费用)

Id最好是 _ 对于一组来说是唯一的 _,否则会出现奇怪的行为和错误的分组。

Value必须是数字

Timestamp只是一个使用以下格式的 _ 日期 _:'YYYY-MM-DD'

Extra字段未使用。

我可以使用任何软件并导出 CSV 文件吗:可以。

什么是类别?:这是 Id,例如,您可以有一个关于 Tax(<- 类别)的 House Expenses(<- 类型)

截图

Obsidian 插件:【Readme】Financial Doc--截图

Obsidian 插件:【Readme】Financial Doc--截图

Obsidian 插件:【Readme】Financial Doc--截图

Obsidian 插件:【Readme】Financial Doc--截图

Obsidian 插件:【Readme】Financial Doc--截图

更新日志

TODO

  • 使用 Github Actions 并创建一个发布版本,将此 alpha 版本发布到 Obsidian 仓库
  • 修复 CSV 文件的保存系统(使用至少 1000 的防抖)
  • 改进设置选项卡(编辑、添加和删除颜色)
  • 支持移动设备
  • 支持 Windows
  • 设置选项卡中默认下拉值的错误
  • 添加下拉菜单以选择交易类型(而不是查看文档)
  • 添加 CSS 和 CSV 编辑器的设置选项
  • [-] 编辑 CSV 文件时复制粘贴功能失效(无法重现)
  • [] 改进设置选项卡(编辑、添加和删除模型)
  • [] 添加更多处理和分析数据的功能
  • [] 编写更好的文档
  • [] 添加更多图表类型,目前仅支持折线图
  • [] 使用饼图或类似的方式添加报告
  • [] 添加表格视图的报告

V0.5.1 - Beta - 2023-05-05

  • 移除了 nodejs 路径依赖(在 Windows、macOS 和 Iphone 上进行了测试)
  • 移除了自定义的防抖函数,在设置中验证防抖输入,无效的默认值。
  • 将所有内联样式移动到 styles.css 中
  • 重新设计了颜色分配,注入颜色,替换了将参数传递给函数的方式。
### V0.5.0 - Beta - 2023-05-03
  • 修复了错误并进行了重构
  • 可编辑内容更直观,不会有破坏一切的风险
  • 您可以使用 Tab 键导航表格
  • 添加了删除行按钮
  • 添加、编辑和删除颜色
  • 改进了设置选项卡中的类别选择
  • UI 和信息添加

Obsidian 插件:【Readme】Financial Doc--V0.5.1 - Beta - 2023-05-05

Obsidian 插件:【Readme】Financial Doc--V0.5.1 - Beta - 2023-05-05

Obsidian 插件:【Readme】Financial Doc--V0.5.1 - Beta - 2023-05-05

### V0.4.1 - Beta - 2023-05-02
  • 修复了错误
  • 下拉菜单选择交易类型

Obsidian 插件:【Readme】Financial Doc--V0.5.1 - Beta - 2023-05-05

### V0.4.0 - Beta - 2023-05-02
  • 改进了编辑 CSV 文件时的 UI,将表格包装在具有可编辑内容的 div 中。我认为这是两种解决方案中最好的。
  • 保存系统应该更好,因为不再处理 csv 分隔符

Obsidian 插件:【Readme】Financial Doc--V0.5.1 - Beta - 2023-05-05

Obsidian 插件:【Readme】Financial Doc--V0.5.1 - Beta - 2023-05-05

### V0.3.4 - Alpha - 2023-04-20
  • 修复了移动设备上的 CSV 编辑问题,添加了边距以显示所有文本(仅在 Iphone 上进行了测试)
  • 改进了错误处理和用户交互
  • 更新了准备数据的方法名称
  • 在页脚中添加了图表详细信息
### V0.3.3 - Alpha - 2023-04-20
  • 修复了移动设备支持
  • 修复了下拉菜单当前值的选择
### V0.3.2 - Alpha - 2023-04-19
  • 添加了准备图表的新方法
  • 按类型筛选而不是按类别
  • 发现问题:未修复。在复制粘贴 CSV 文件中的行时出现保存问题
### V0.3.1 - Alpha - 2023-04-13
  • 添加了 Windows 支持
### V0.3.0 - Alpha - 2023-04-13
  • 添加了移动设备支持
### V0.2.0 - Alpha - 2023-04-13
  • 添加了新类型:Expenses
  • 开始将 typescript 的 any 切换为正确的类型
  • 将代码移动到较小的文件中
  • 添加了 Github Action Pipeline
  • 使用此实现似乎防抖更好(仍然经常备份文件)
  • 处理数据类型以显示正确的符号
  • 修复了错误
  • 处理无效的 CSV 行
  • 处理空行
### V0.1.0 - Alpha - 2023-04-11
  • 重构代码
  • 使用 Obsidian 设置添加配置
  • 添加了截图
  • 修复了一些错误
  • 指定默认值并进行测试
  • 修复了内联 CSV 文件的一些问题(经常备份文件!)
  • 保存系统仍然存在一个错误,我不得不找到一个不太好的解决方法。
### V0.0.0 - Alpha - 2023-04-09
  • 在 Obsidian 中打开和编辑 CSV 文件
  • 在 Obsidian 中生成图表
  • 提供了一些模型以查看财务进展

贡献

  1. 创建一个功能分支
  2. 提交您的更改
  3. 推送您的更改
  4. 创建一个 PR
使用本地分支

切换分支:

git checkout -b <feature|fix|release|chore|hotfix>/prefix-name

您的分支名称必须以 [feature|fix|release|chore|hotfix] 开头,并在名称之前使用/;
使用连字符作为分隔符;
前缀对应于您的看板工具 ID(例如 abc-123)

同步您的分支:

git fetch origin
git rebase origin/master

提交您的更改:

git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"

遵循此约定 commitlint 以获取您的提交消息结构

推送您的更改:

git push origin <feature|fix|release|chore|hotfix>/prefix-name

示例:

git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix
git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"

本地开发

npm install
npm run build

许可证

根据 MIT 许可证进行分发。有关更多信息,请参阅 LICENSE。

联系方式

| Buy Me A Coffee | Webux Logo Webux Lab |


反馈交流

其他渠道

版权声明