# 源规则帮助 * [书源帮助文档](https://alanskycn.gitee.io/teachme/Rule/source.html) * [订阅源帮助文档](https://alanskycn.gitee.io/teachme/Rule/rss.html) * 规则标志, {{......}}内使用规则必须有明显的规则标志,没有规则标志当作js执行 * @@ 默认规则,直接写时可以省略@@ * @XPath: xpath规则,直接写时以//开头可省略@XPath * @Json: json规则,直接写时以$.开头可省略@Json * : regex规则,不可省略,只可以用在书籍列表和目录列表 * js 变量和函数 * java 变量-当前类 * baseUrl 变量-当前url,String * result 变量-上一步的结果 * book 变量-书籍类,方法见 io.legado.app.data.entities.Book * cookie 变量-cookie操作类,方法见 io.legado.app.help.http.CookieStore * cache 变量-缓存操作类,方法见 io.legado.app.help.CacheManager * chapter 变量-当前目录类,方法见 io.legado.app.data.entities.BookChapter * title 变量-当前标题,String ## 部分js对象属性说明 上述js变量与函数中,一些js的对象属性用的频率较高,在此列举。方便写源的时候快速翻阅。 ### book对象的可用属性 > 使用方法: 在js中或{{}}中使用book.属性的方式即可获取.如在正文内容后加上 ##{{book.name+"正问卷"+title}} 可以净化 书名+正问卷+章节名称(如 我是大明星正问卷第二章我爸是豪门总裁) 这一类的字符. ``` bookUrl // 详情页Url(本地书源存储完整文件路径) tocUrl // 目录页Url (toc=table of Contents) origin // 书源URL(默认BookType.local) originName //书源名称 or 本地书籍文件名 name // 书籍名称(书源获取) author // 作者名称(书源获取) kind // 分类信息(书源获取) customTag // 分类信息(用户修改) coverUrl // 封面Url(书源获取) customCoverUrl // 封面Url(用户修改) intro // 简介内容(书源获取) customIntro // 简介内容(用户修改) charset // 自定义字符集名称(仅适用于本地书籍) type // 0:text 1:audio group // 自定义分组索引号 latestChapterTitle // 最新章节标题 latestChapterTime // 最新章节标题更新时间 lastCheckTime // 最近一次更新书籍信息的时间 lastCheckCount // 最近一次发现新章节的数量 totalChapterNum // 书籍目录总数 durChapterTitle // 当前章节名称 durChapterIndex // 当前章节索引 durChapterPos // 当前阅读的进度(首行字符的索引位置) durChapterTime // 最近一次阅读书籍的时间(打开正文的时间) canUpdate // 刷新书架时更新书籍信息 order // 手动排序 originOrder //书源排序 variable // 自定义书籍变量信息(用于书源规则检索书籍信息) ``` ### chapter对象的可用属性 > 使用方法: 在js中或{{}}中使用chapter.属性的方式即可获取.如在正文内容后加上 ##{{chapter.title+chapter.index}} 可以净化 章节标题+序号(如 第二章 天仙下凡2) 这一类的字符. ``` url // 章节地址 title // 章节标题 baseUrl //用来拼接相对url bookUrl // 书籍地址 index // 章节序号 resourceUrl // 音频真实URL tag // start // 章节起始位置 end // 章节终止位置 variable //变量 ```