From 232fde720c2b9d8b62c8484183b2c758749f6709 Mon Sep 17 00:00:00 2001
From: HughWan <977741432@qq.com>
Date: Wed, 27 Dec 2023 09:36:47 +0800
Subject: [PATCH] update readme add example
---
README.md | 67 +++++++++++-----------
doc/Obsidian-Douban-BlueTopaz.md | 96 +++++++++++++++++---------------
doc/README.en.md | 7 +++
3 files changed, 92 insertions(+), 78 deletions(-)
diff --git a/README.md b/README.md
index 5ee783e..d68c467 100644
--- a/README.md
+++ b/README.md
@@ -39,9 +39,10 @@
## 效果
1. 结合Timeline插件 __构建个人观影时间线__，请参照[结合timeline插件实现时间线效果](./doc/Obsidian-Douban-TimeLine.md)
+
2. 结合主题 __构建类豆瓣网页效果__，请参照[结合Blue Topaz实现网页效果](./doc/Obsidian-Douban-BlueTopaz.md)
-
+
## 如何使用
### 搜索
@@ -62,38 +63,38 @@
## 支持的字段
(若有缺少想导入的字段, 欢迎提issues反馈)
-| 字段 | 电影 | 电视剧 | 书籍 | 音乐 | 日记 | 游戏 | 人物 |
-|------------------|-------------------|-------------------|-------------------|----------------|----------------|---------------|-------|
-| id | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | id |
-| title | 电影名称 | 电视剧名称 | 书名 | 音乐名 | 日记标题 | 游戏名称 | 姓名 |
-| type | 类型 | 类型 | 类型 | 类型 | 类型 | 类型 | 类型 |
-| score | 评分 | 评分 | 评分 | 评分 | 评分 | 评分 | |
-| image | 封面 | 封面 | 封面 | 封面 | 图片 | 封面 | 照片 |
-| imageData.url | 封面url | 封面url | 封面url | 封面url | 封面url | 封面url | 照片url |
-| url | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 |
-| desc | 简介 | 简介 | 内容简介 | 简介 | 简介 | 简介 | 简介 |
-| publisher | - | - | 出版社 | 出版者 | 发布者 | 发行商 | - |
-| datePublished | 上映日期 | 上映日期 | 出版年 | 发行时间 | 发布时间 | 发行日期 | - |
-| yearPublished | 上映年份 | 上映年份 | 出版年份 | 发行年份 | 发布年份 | 发行年份 | - |
-| genre | 类型 | 类型 | - | 流派 | - | 类型 | - |
-| currentDate | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | |
-| currentTime | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | |
-| myTags | 我标记的标签 | 我标记的标签 | 我标记的标签 | 我标记的标签 | - | 我标记的标签 | |
-| myRating | 我的评分 | 我的评分 | 我的评分 | 我的评分 | - | 我的评分 |
-| myState | 状态:想看/在看/看过 | 状态:想看/在看/看过 | 状态:想看/在看/看过 | 状态:想听/在听/听过 | - | 状态:想玩/在玩/玩过 | |
-| myComment | 我的评语 | 我的评语 | 我的评语 | 我的评语 | - | 我的评语 | |
-| myCollectionDate | 我标记的时间 | 我标记的时间 | 我标记的时间 | 我标记的时间 | - | 我标记的时间 | |
-| 扩展1 | director:导演 | director:导演 | author:原作者 | actor: 表演者 | author:作者 | aliases:别名 | |
-| 扩展2 | author:编剧 | author:编剧 | translator:译者 | albumType:专辑类型 | authorUrl:作者网址 | developer:开发商 | |
-| 扩展3 | actor:主演 | actor:主演 | isbn:isbn | medium:介质 | content:日记内容 | platform:平台 | |
-| 扩展4 | originalTitle:原作名 | originalTitle:原作名 | originalTitle:原作名 | records:唱片数 | | | |
-| 扩展5 | country:国家 | country:国家 | subTitle:副标题 | barcode:条形码 | | | |
-| 扩展6 | language:语言 | language:语言 | totalPage:页数 | | | | |
-| 扩展7 | time:片长 | time:片长 | series:丛书 | | | | |
-| 扩展8 | aliases:又名 | aliases:又名 | menu:目录 | | | | |
-| 扩展9 | IMDb | IMDb | price:定价 | | | | |
-| 扩展7 | | episode:集数 | binding:装帧 | | | | |
-| 扩展8 | | | producer: 出品方 | | | | |
+| 字段 | 电影 | 电视剧 | 书籍 | 音乐 | 日记 | 游戏 | 人物 |
+|------------------|-------------------|-------------------|-------------------|---------------|----------------|---------------|-------|
+| id | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | id |
+| title | 电影名称 | 电视剧名称 | 书名 | 音乐名 | 日记标题 | 游戏名称 | 姓名 |
+| type | 类型 | 类型 | 类型 | 类型 | 类型 | 类型 | 类型 |
+| score | 评分 | 评分 | 评分 | 评分 | 评分 | 评分 | |
+| image | 封面 | 封面 | 封面 | 封面 | 图片 | 封面 | 照片 |
+| imageData.url | 封面url | 封面url | 封面url | 封面url | 封面url | 封面url | 照片url |
+| url | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 |
+| desc | 简介 | 简介 | 内容简介 | 简介 | 简介 | 简介 | 简介 |
+| publisher | - | - | 出版社 | 出版者 | 发布者 | 发行商 | - |
+| datePublished | 上映日期 | 上映日期 | 出版年 | 发行时间 | 发布时间 | 发行日期 | - |
+| yearPublished | 上映年份 | 上映年份 | 出版年份 | 发行年份 | 发布年份 | 发行年份 | - |
+| genre | 类型 | 类型 | - | 流派 | - | 类型 | - |
+| currentDate | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | |
+| currentTime | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | |
+| myTags | 我标记的标签 | 我标记的标签 | 我标记的标签 | 我标记的标签 | - | 我标记的标签 | |
+| myRating | 我的评分 | 我的评分 | 我的评分 | 我的评分 | - | 我的评分 |
+| myState | 状态:想看/在看/看过 | 状态:想看/在看/看过 | 状态:想看/在看/看过 | 状态:想听/在听/听过 | - | 状态:想玩/在玩/玩过 | |
+| myComment | 我的评语 | 我的评语 | 我的评语 | 我的评语 | - | 我的评语 | |
+| myCollectionDate | 我标记的时间 | 我标记的时间 | 我标记的时间 | 我标记的时间 | - | 我标记的时间 | |
+| 扩展1 | director:导演* | director:导演* | author:原作者 | actor: 表演者 | author:作者 | aliases:别名 | |
+| 扩展2 | author:编剧* | author:编剧* | translator:译者 | albumType:专辑类型 | authorUrl:作者网址 | developer:开发商 | |
+| 扩展3 | actor:主演* | actor:主演* | isbn:isbn | medium:介质 | content:日记内容 | platform:平台 | |
+| 扩展4 | originalTitle:原作名 | originalTitle:原作名 | originalTitle:原作名 | records:唱片数 | | | |
+| 扩展5 | country:国家 | country:国家 | subTitle:副标题 | barcode:条形码 | | | |
+| 扩展6 | language:语言 | language:语言 | totalPage:页数 | | | | |
+| 扩展7 | time:片长 | time:片长 | series:丛书 | | | | |
+| 扩展8 | aliases:又名* | aliases:又名* | menu:目录 | | | | |
+| 扩展9 | IMDb | IMDb | price:定价 | | | | |
+| 扩展7 | | episode:集数 | binding:装帧 | | | | |
+| 扩展8 | | | producer: 出品方 | | | | |
- 注: myTags, myRating, myState, myComment, myCollectionDate 参数均为在插件中登录后可用
diff --git a/doc/Obsidian-Douban-BlueTopaz.md b/doc/Obsidian-Douban-BlueTopaz.md
index e27c95c..b27cfe2 100644
--- a/doc/Obsidian-Douban-BlueTopaz.md
+++ b/doc/Obsidian-Douban-BlueTopaz.md
@@ -7,12 +7,12 @@
1. 安装[Blue Topaz](https://github.com/PKM-er/Blue-Topaz_Obsidian-css)插件， 可在Obsidian主题搜索中找到 `Blue Topaz`
2. 安装[Obsidian-Douban](https://github.com/Wanxp/obsidian-douban)插件(本插件)
3. 在Obsidian-Douban插件配置中登录Douban
-4. 配置需要的模板, 在模板最后增加以下内容，如下所示
-
+4. 配置需要的模板文件, 在模板中 ==增加== 以下内容，如下所示
````markdown
---
+
# {{title}}
- {{originalTitle}}
+ {{originalTitle}}
⭐⭐⭐⭐⭐
---
@@ -20,81 +20,87 @@
> [!bookinfo|noicon]+ 🗒️ **简介**
> 
>
-
| 属性 | 内容 |
|:-------- |:------------------------ |
| 笔记 | [[摘录：{{title}}]] |
-| 作者 | [[{{author}}]] |
-| 译者 | [[{{translator(ArrayType1)}}]] |
+| 作者 | {{author(ArrayType1)}} |
+| 译者 | {{translator(ArrayType1)}} |
| 来源 | [ {{title}} ]( {{url}} ) |
| 网站评分 | {{score}} |
| 出版发行 | {{publisher}} |
| 原作名 | {{originalTitle}} |
-| 出版年份 | {{yearPublished}} |
+| 出版年份 | {{yearPublished}} |
> [!note]- 书籍简介\
> {{desc}}
---
-
### 评论
{{myComment}}
````
-5. 同时，在电影/书籍... 模板中的 **最后增加** timeline插件需要的html标签如下:
+5. 设置模板为上面的模板
-```html
-{{myComment}} |简介: {{desc}}
-
-```
-6. 选择上述模板导入 电影/书籍...，操作方式是打开obsidian命令窗口，输入豆瓣，找到导入功能，在导入界面配置 选择模板进行导入
-7. 导入需要一定时间，每条内容导入需要15-30s左右，所有有导入完成后会有导入汇总
-8. 导入完成后，新建一个笔记，笔记内容加入timeline的代码块，代码块的内容就是你上面指定的tags的内容，如`我看过的电影`，代码块如下：
-````markdown
-```timeline
-我看过的电影
-```
-````
-9. 预览这个笔记就能看出已经出现了时间线
## 模板参考
-### 电影
+### 书籍
````markdown
---
doubanId: {{id}}
title: {{title}}
-type: {{type}}
-score: {{score}}
-myRate: {{myRate}}
+subTitle: {{subTitle}}
originalTitle: {{originalTitle}}
-genre: {{genre}}
-datePublished: {{datePublished}}
-director: {{director}}
-actor: {{actor}}
+series: {{series}}
+type: {{type}}
author: {{author}}
-tags: {{type}}, 我看过的电影, {{myTags}}
-state: {{myState}}
+score: {{score}}
+myRating: {{myRating}}
+datePublished: {{datePublished}}
+translator: {{translator}}
+publisher: {{publisher}}
+producer: {{producer}}
+isbn: {{isbn}}
url: {{url}}
-coverUrl: {{imageData.url}}
+totalPage: {{totalPage}}
+price: {{price}}
+tags: {{myTags}}
+state: {{myState}}
+binding: {{binding}}
createTime: {{currentDate}} {{currentTime}}
collectionDate: {{myCollectionDate}}
desc: {{desc}}
---
-
+# {{title}}
+ {{originalTitle}}
+⭐⭐⭐⭐⭐
-Comment:
---
+
+> [!bookinfo|noicon]+ 🗒️ **简介**
+> 
+>
+| 属性 | 内容 |
+|:-------- |:------------------------ |
+| 笔记 | [[摘录：{{title}}]] |
+| 作者 | {{author(ArrayType1)}} |
+| 译者 | {{translator(ArrayType1)}} |
+| 来源 | [ {{title}} ]( {{url}} ) |
+| 网站评分 | {{score}} |
+| 出版发行 | {{publisher}} |
+| 原作名 | {{originalTitle}} |
+| 出版年份 | {{yearPublished}} |
+
+> [!note]- 书籍简介\
+> {{desc}}
+
+---
+### 评论
+
{{myComment}}
+### 目录
-{{myComment}} |简介: {{desc}}
-
+{{menu}}
````
-### 书籍、电视剧、音乐、游戏
-请参照电影模板
-## 更多
-参照讨论 [结合timeline插件的妙用](https://github.com/Wanxp/obsidian-douban/issues/19#issuecomment-1428307130)
+### 电影、电视剧、音乐、游戏
+请参照书籍模板
diff --git a/doc/README.en.md b/doc/README.en.md
index fb63cb7..ac981ff 100644
--- a/doc/README.en.md
+++ b/doc/README.en.md
@@ -35,6 +35,13 @@ If you want some features or have any questions about this plugin, create issues
- [x] Personal Comment/State/Rate
- [x] Custom Variables
+## 效果
+1. 结合Timeline插件 __构建个人观影时间线__，请参照[结合timeline插件实现时间线效果](./Obsidian-Douban-TimeLine.md)
+ 
+
+2. 结合主题 __构建类豆瓣网页效果__，请参照[结合Blue Topaz实现网页效果](./Obsidian-Douban-BlueTopaz.md)
+ 
+
## How to use
### Sync
- Sync Data From Douban