diff --git a/README.md b/README.md index 961f1e5..74009b7 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ FeedMe is an reader client application for RSS service: This is the documentation of FeedMe. ## Version: -- release: 4.3.7 +- release: 4.3.9 - beta: 4.3.9 (join beta test: https://play.google.com/apps/testing/com.seazon.feedme) ## Download: @@ -25,42 +25,42 @@ This is the documentation of FeedMe. ## Topics: -- Podcast & TTS -- Filter -- Customize Menus +- Podcast & TTS +- Filter +- Customize Menus - Feed setting -- Mobilizer and Full Text Download -- Sync -- Storage and Cache -- Blocking Images -- E-Ink -- Highlighter -- Shortcut key -- RSS Services +- Mobilizer and Full Text Download +- Sync +- Storage and Cache +- Blocking Images +- E-Ink +- Highlighter +- Shortcut key +- RSS Services -## QA +## QA ## Patches: -- 4.x -- 3.x -- 2.x -- 1.x -- 0.x +- 4.x +- 3.x +- 2.x +- 1.x +- 0.x -## Credits +## Credits -## Licenses +## Licenses -## Privacy and Security +## Privacy and Security ## Translation -FeedMe manager translation at https://crowdin.com/project/feedme, if you like FeedMe and want to localize it, please join the project and leave a comment at https://github.com/seazon/FeedMe/issues/639. +FeedMe manager translation at https://crowdin.com/project/feedme, if you like FeedMe and want to localize it, please join the project and leave a comment at https://github.com/seazon/FeedMe/issues/2. ## Sponsor - Sponsor does not gain anything, it is just to encourage the author to continue development. - If possible, it is recommended to support the author through the in-app `Settings`-`About`-`In-app Billing` and obtain some special features. - https://paypal.me/dataegg -## 中文 +## 中文 diff --git a/doc/en/customize_menus.md b/doc/en/customize_menus.md index eb31a36..b6234b4 100644 --- a/doc/en/customize_menus.md +++ b/doc/en/customize_menus.md @@ -1,11 +1,11 @@ You can customize your actionbar menus and FAB menu from v2.5. - + ## Edit Mode Long press the actionbar title to enter edit mode. You can find 4 parts, `FAB`, `Show`, `Hide` and `Disable` in dialog. Drag the right icon to move and reorder it. - + You can set ONE `FAB` menu and some `Show` menus. If the space is not enough, the `Show` menus will show in `More`, just like the `Hide` menus. If you don't need some menus any more, move them to `Disable`. diff --git a/doc/en/eink.md b/doc/en/eink.md index e0a34a6..91a7dc7 100644 --- a/doc/en/eink.md +++ b/doc/en/eink.md @@ -4,7 +4,7 @@ - 3. Enter the article list page - Long press the title bar at the top - Pop up the `Edit Menu` - Move the default disabled `Back`, `Up`, `Down` to the top, save **Tap menu instead swipe gesture** - 4. Enter the article detail page - Long press the title bar at the top - Pop up the `Edit Menu` - Move the default disabled `Back`, `Up`, `Down` to the top, save **Tap menu instead swipe gesture** -For more about custom `Action Bar`, see [here](https://github.com/seazon/FeedMe/blob/master/doc/en/customize_menus.md) +For more about custom `Action Bar`, see [here](https://github.com/seazon/FeedMe/blob/main/doc/en/customize_menus.md) # Others In `Settings` - `Lab`, there is an `E-Ink Screen Optimization`, which can reduce the screen flicker of the article page after it is turned on, but the menu is not available. \ No newline at end of file diff --git a/doc/en/filter.md b/doc/en/filter.md index a9542f8..6713a73 100644 --- a/doc/en/filter.md +++ b/doc/en/filter.md @@ -2,13 +2,13 @@ From version 2.4, FeedMe supports filter new articles when syncing, mark the art You can find filter in `feed setting` dialog. There is a switch on left for filter with different way. The edit text below is for writing keywords. - + ## Filter Type - `Reserved`：Only reserved the articles which contain keywords, others mark read. - `Mute`：Mark the articles which contains keywords as read. - + If you just want to keep articles which contains some keywords, use `Reserved`. If you don't want to see some keywords, use `Mute`. diff --git a/doc/en/highlighter.md b/doc/en/highlighter.md index 8f426fc..9e3530a 100644 --- a/doc/en/highlighter.md +++ b/doc/en/highlighter.md @@ -3,27 +3,27 @@ Since version 3.17, FeedMe supports highlighter label similar to Inoreader. High ### Set - Added `Highlighter` above `All Items` on the nav side - + - Click `Highlighter` to enter the Highlighter interface - Click the Add button to add tags you are interested in - Click the newly added label to change the color - + - Click the checkbox to display it in the nav side (because the sidebar display requires additional calculations, due to performance considerations, up to *5* can be displayed) - + - Click the delete button to delete this table - + ### Use highlighter label - After returning to the nav side, click the arrow on the left of `Highlighter` to expand, and you can see the label which checkbox is checked - + - Browse lists and articles, all highlighter labels will be highlighted - + diff --git a/doc/en/mobilizer.md b/doc/en/mobilizer.md index c54867f..15b3394 100644 --- a/doc/en/mobilizer.md +++ b/doc/en/mobilizer.md @@ -7,14 +7,14 @@ In FeedMe, there are two cases where mobilizer is required. You can find these 2 settings below (NAV side - Subscription - category/feed): - + # Why the third party mobilizer was set, but the article was still downloaded using FeedMe mobilizer? Because the third party mobilizer in order to ensure the availability of its services, generally limit the frequency of calls. If the call is too fast or too many times, they will stop the service. Due to the high download frequency when FeedMe is synchronized, it may result in third party mobilizer being unavailable. So at the time of synchronization, only the built-in mobilizer is available. So, the mobilizer in the `feed settings` dialog is only use for download when reading. - + Note : Mobilizer is removing some unimportant elements on the page (head, side and bottom of the navigation or link) and re-layout, leaving only the text part. General mobilizer get the article is calculated by algorithm, so can not guarantee 100% correct. Mature mobilizer resolution is more accurate, and built-in is worse. diff --git a/doc/en/patches_3.x.md b/doc/en/patches_3.x.md index a0ecc3e..ce69e2d 100644 --- a/doc/en/patches_3.x.md +++ b/doc/en/patches_3.x.md @@ -152,7 +152,7 @@ # 3.17 ###### 2020-9-20 -- [new]Highlighter https://github.com/seazon/FeedMe/blob/master/doc/en/highlighter.md +- [new]Highlighter https://github.com/seazon/FeedMe/blob/main/doc/en/highlighter.md - [new]support jump/seek via time in show notes. - [optimize]Reduce the space between paragraphs of article page. - [optimize]The images in the `New List` layout have more display space. @@ -227,8 +227,8 @@ com.seazon.feedme.action.STAR_ACTION # 3.13 ###### 2020-2-4 -- [optimize] Compatible with Android 10 storage mechanism, please see Storage and Cache -- [optimize] Optimize the function of blocking images, please see Blocking Images +- [optimize] Compatible with Android 10 storage mechanism, please see Storage and Cache +- [optimize] Optimize the function of blocking images, please see Blocking Images - [optimize] Enable `Decode HTML` by default. - [fix] Fix the problem of opening wrong image in the article screen. - [other] The minimum supported version is increased to Android 5. @@ -345,7 +345,7 @@ com.seazon.feedme.action.STAR_ACTION ### 3.8.5 ###### 2018-8-8 -- [new] Support BlackBerry key series quick actions through keyboard. Link: https://github.com/seazon/FeedMe/blob/master/doc/en/shortcut_key.md +- [new] Support BlackBerry key series quick actions through keyboard. Link: https://github.com/seazon/FeedMe/blob/main/doc/en/shortcut_key.md - [optimize] Add a text description to the upper right sidebar and back button to make it easier for people with poor eyesight. - [fix] Fixed an issue where FeedMe mobilizer could not parse pure audio pages correctly. - [fix] Fixed an issue where images could not be downloaded under WIFI in some cases. @@ -647,7 +647,7 @@ public static int SYNC_DOWNLOAD_PODCAST = 256; # 3.0 ###### 2017-3-19 -- Support podcast (not support `Feedbin`) and TTS. Please read Podcast & TTS for the detail. +- Support podcast (not support `Feedbin`) and TTS. Please read Podcast & TTS for the detail. - Provide reading time. - Add `Podcast` layout, which show play or download progress. - Add `Lab` in `Settings`, including `Hardware Acceleration`. diff --git a/doc/en/podcast_tts.md b/doc/en/podcast_tts.md index f775a41..5556675 100644 --- a/doc/en/podcast_tts.md +++ b/doc/en/podcast_tts.md @@ -7,11 +7,11 @@ FeedMe integrates these two different forms, and you can listen all items like l FeedMe provides play section into the playlist in the left navigation bar. To simplify the logic, FeedMe has only one playlist. - + There is a new layout in article list: podcast. This layout contains a progress button, you can play a item or download the audio file if it is a podcast item. - + # Play control There are 4 play menus in article list long-tap dialog: @@ -22,7 +22,7 @@ There are 4 play menus in article list long-tap dialog: `Stop tag`: When played a item with `Stop tag`, stop play and clear it. - + # Playlist - The played item will be automatically removed from playlist, including podcast audio files. So no need to remove item by yourself. @@ -35,19 +35,19 @@ There are 4 play menus in article list long-tap dialog: When an item is playing, a notification adds in notification bar. And you can enter playing page via tap it. - + # Playing page There are 3 pages in playing page. You can find a cross icon in playlist page, that is `Stop tag`. - + # TTS setting There is an `Audio` tab in `Settings`, you can goto TTS setting page from here. - + # Tips ### Play feed view or web view ##### Q: Sometimes feed does not provide full text, and when we switch to web view and play, it still play the feed view text. How can I play the web view text? -A: You can read this section to know how it works. \ No newline at end of file +A: You can read this section to know how it works. \ No newline at end of file diff --git a/doc/en/qa.md b/doc/en/qa.md index cc53cf8..5352568 100644 --- a/doc/en/qa.md +++ b/doc/en/qa.md @@ -45,8 +45,6 @@ Another tip, if images downloaded when aotu sync, the thumbnail can show without ### Q:TTS player stop after screen lock or FeedMe is not at foreground. A:Please try to search "Battery Optimization" in system settings and set both FeedMe and the using TTS engine as "Unoptimized". More tips -If this can't help you, get more help in this ticket: https://github.com/seazon/FeedMe/issues/287 - # Others ### Q:More tips about keep FeedMe alive. A:[https://dontkillmyapp.com/](https://dontkillmyapp.com/) diff --git a/doc/zh/README.md b/doc/zh/README.md index 984e06c..fbe50a1 100644 --- a/doc/zh/README.md +++ b/doc/zh/README.md @@ -11,7 +11,7 @@ FeedMe是一个RSS阅读器，支持以下RSS服务： 这是FeedMe的使用文档。 ## 版本: -- 正式: 4.3.7 +- 正式: 4.3.9 - 测试: 4.3.9 (加入beta测试: https://play.google.com/apps/testing/com.seazon.feedme) ## 下载: @@ -25,20 +25,20 @@ FeedMe是一个RSS阅读器，支持以下RSS服务： ## 主题: -- 播客和TTS -- 过滤器 -- 自定义菜单 +- 播客和TTS +- 过滤器 +- 自定义菜单 - 订阅源设置 -- Mobilizer和全文下载 -- 同步 -- 存储及缓存 -- 拦截图片 -- 电子墨水屏 -- 荧光标签 -- 快捷键 -- RSS服务 +- Mobilizer和全文下载 +- 同步 +- 存储及缓存 +- 拦截图片 +- 电子墨水屏 +- 荧光标签 +- 快捷键 +- RSS服务 -## QA +## QA ## 中国模式 #### 目的 @@ -49,20 +49,20 @@ FeedMe是一个RSS阅读器，支持以下RSS服务： #### 缺点 - `同步模式`设置不再起作用，强制以`所有`的方式运行。所以不能自定义某些源不更新。 -## 致谢 +## 致谢 -## 许可证 +## 许可证 -## 隐私及安全说明 +## 隐私及安全说明 ## 更新: -- 4.x -- 3.x -- 2.x -- 1.x -- 0.x +- 4.x +- 3.x +- 2.x +- 1.x +- 0.x ## 打赏 - 打赏作者不能获得什么，只是为了鼓励作者继续开发。 - 如果有条件，推荐通过应用内`设置`-`关于`-`应用内支付`来支持作者，同时获得一些特色功能。 - + diff --git a/doc/zh/customize_menus.md b/doc/zh/customize_menus.md index 240720c..affd021 100644 --- a/doc/zh/customize_menus.md +++ b/doc/zh/customize_menus.md @@ -1,11 +1,11 @@ 从2.5版本开始，你可以自定义`动作条`菜单和`悬浮按钮`菜单。 - + ## 进入编辑模式 长按动作条标题位置可以进入编辑模式。在打开的编辑对话框中，你可以看到4个部分，`悬浮按钮`，`显示`，`隐藏`和`禁用`。通过拖拽右侧的图标你可以为移动菜单，为它们重新排序。 - + 你可以定义一个`悬浮按钮`和多个`显示`的菜单，如果动作条空间不够，会和`隐藏`的菜单一样，显示在`更多`菜单中。如果某些菜单你根本不想用，可以设置为`禁用`。 diff --git a/doc/zh/eink.md b/doc/zh/eink.md index 912a691..28cc636 100644 --- a/doc/zh/eink.md +++ b/doc/zh/eink.md @@ -4,7 +4,7 @@ - 3. 进入列表页 - 长按顶部标题栏 - 弹出`编辑菜单` - 将默认禁用的`返回`、`向上`、`向下`上移至顶部，保存 **使用点按菜单方式来代替划动手势** - 4. 进入文章页 - 长按顶部标题栏 - 弹出`编辑菜单` - 将默认禁用的`返回`、`向上`、`向下`上移至顶部，保存 **使用点按菜单方式来代替划动手势** -更多关于自定义`动作条`，查看[这里](https://github.com/seazon/FeedMe/blob/master/doc/zh/customize_menus.md) +更多关于自定义`动作条`，查看[这里](https://github.com/seazon/FeedMe/blob/main/doc/zh/customize_menus.md) # 其他 在`设置` - `实验室`中有一个`电子墨水屏优化`，开启后可以减少文章页的屏闪，但是菜单不可用。 \ No newline at end of file diff --git a/doc/zh/filter.md b/doc/zh/filter.md index 43d636c..05d10be 100644 --- a/doc/zh/filter.md +++ b/doc/zh/filter.md @@ -2,13 +2,13 @@ 过滤设置在订阅源的设置界面。你可以看到左侧是一个切换开关，可以以不同的方式来对这个订阅源进行过滤。下面是填写过滤关键字的文本框。 - + ## 过滤方式 - `保留`：仅保留满足关键字的文章，其它文章标记为已读 - `过滤`：仅将满足关键字的文章标记为已读 - + 当某个源你只关心含有某些关键字的文章时，你可以使用`保留`方式；当某个源你不想看某些关键字时，你可以使用`过滤`方式。 diff --git a/doc/zh/highlighter.md b/doc/zh/highlighter.md index c490e86..f5964d9 100644 --- a/doc/zh/highlighter.md +++ b/doc/zh/highlighter.md @@ -3,26 +3,26 @@ ### 设置荧光标签 - 侧栏`所有条目`上面新增了`Highlighter` - + - 点击`Highlighter`进入Highlighter界面 - 点击添加按钮添加你感兴趣的标签 - 点击新添加的标签更改颜色 - + - 点击checkbox使其在侧栏显示（因为侧栏显示需要额外计算，处于性能考虑，最多可以显示5个） - + - 点击删除按钮删除此标签 - + ### 使用荧光标签 - 返回侧栏后，点击`Highlighter`左侧的箭头展开，可以看到checkbox选中的标签 - + - 浏览列表和文章，所有荧光标签都会以相应的颜色高亮显示 - + diff --git a/doc/zh/mobilizer.md b/doc/zh/mobilizer.md index 4220885..6877991 100644 --- a/doc/zh/mobilizer.md +++ b/doc/zh/mobilizer.md @@ -6,14 +6,14 @@ 2. 在阅读时使用 Mobilizer 进行全文下载。 你可以在下图中看到这2个设置（可以通过侧边栏-订阅-类别/订阅源到达这里）： - + # 为什么设置了第三方mobilizer，但是文章还是使用FeedMe mobilizer下载的？ 因为第三方 Mobilizer 为了保证其服务的可用性，一般都会限制调用频率。如果调用过快或者次数过多，他们就会停止服务。由于 FeedMe 同步时下载频率很高，就可能因此导致第三方 Mobilizer 不可用。所以在同步时，只有自带的 Mobilizer可用。 所以，在`订阅源设置`对话框中的 Mobilizer，只适用于阅读时的下载。见下图。 - + 注：Mobilizer：去除网页上一些不重要的元素（头部，侧边及底部的导航或者链接）并重新排版，仅保留正文部分。一般 Mobilizer 得到的文章是由程序算法计算解析得出的，所以不能保证百分百的正确。成熟的 Mobilizer 在正确性上会做的更好，而自带的会差一些。 diff --git a/doc/zh/patches_3.x.md b/doc/zh/patches_3.x.md index 366b5b1..4279424 100644 --- a/doc/zh/patches_3.x.md +++ b/doc/zh/patches_3.x.md @@ -148,7 +148,7 @@ # 3.17 ###### 2020-9-20 -- [新增]荧光标 https://github.com/seazon/FeedMe/blob/master/doc/zh/highlighter.md +- [新增]荧光标 https://github.com/seazon/FeedMe/blob/main/doc/zh/highlighter.md - [新增]支持音频播放界面show notes内时间戳跳转。 - [优化]减小文章页段落间的空格。 - [优化]`New List`布局的图片现在有更多的显示空间。 @@ -221,8 +221,8 @@ com.seazon.feedme.action.STAR_ACTION # 3.13 ###### 2020-2-4 -- [优化]兼容 Android 10 的存储机制，具体请查看 存储及缓存 -- [优化]优化拦截图片功能，具体请查看 拦截图片 +- [优化]兼容 Android 10 的存储机制，具体请查看 存储及缓存 +- [优化]优化拦截图片功能，具体请查看 拦截图片 - [优化]修改 `Decode HTML` 默认为开启。 - [修复]修复文章界面打开图片不一致问题。 - [其他]最低支持版本提高到 Android 5。 @@ -335,7 +335,7 @@ com.seazon.feedme.action.STAR_ACTION ### 3.8.5 ###### 2018-8-8 -- [新增] 支持黑莓key系列手机进行快捷操作。详见：https://github.com/seazon/FeedMe/blob/master/doc/zh/shortcut_key.md +- [新增] 支持黑莓key系列手机进行快捷操作。详见：https://github.com/seazon/FeedMe/blob/main/doc/zh/shortcut_key.md - [优化] 右上角侧栏及返回按钮添加文字描述，方便视力不佳者。 - [修复] 修复FeedMe mobilizer不能正确解析纯音频页面的错误。 - [修复] 修复某些情况下在WIFI下图片不能下载的问题。 @@ -632,7 +632,7 @@ public static int SYNC_DOWNLOAD_PODCAST = 256; # 3.0 ###### 2017-3-19 -- Support podcast (not support `Feedbin`) and TTS. Please read Podcast & TTS for the detail. +- Support podcast (not support `Feedbin`) and TTS. Please read Podcast & TTS for the detail. - Provide reading time. - Add `Podcast` layout, which show play or download progress. - Add `Lab` in `Settings`, including `Hardware Acceleration`. diff --git a/doc/zh/podcast_tts.md b/doc/zh/podcast_tts.md index 0565ca4..4abbfc7 100644 --- a/doc/zh/podcast_tts.md +++ b/doc/zh/podcast_tts.md @@ -9,11 +9,11 @@ FeedMe整合了这2种不同形式，你可以像听音乐一样收听所有订 在左侧导航栏提供play栏目进入播放列表。为简化逻辑，feedme全局只有一个播放列表。右侧数字为列表内节目的数量。 - + 为了方便播放，新增`播客`布局。它提供一个带有进度条的播放按钮，你可以用它来播放节目，或者下载播客源的节目。 - + # 播放控制 在文章列表页长按节目，提供多种播放菜单： @@ -24,7 +24,7 @@ FeedMe整合了这2种不同形式，你可以像听音乐一样收听所有订 `停止标记`: 当播放完带有`停止标记`的节目后，就停止播放。播放列表中只有一个`停止标记`，并且播放完带有`停止标记`的节目后会清除`停止标记`。 - + # 播放列表 - 播放完的节目会在一定时间后自动删除音频文件，并从播放列表中移除。所以你不需要手动维护播放列表。如果你喜欢某个节目，将其加星就不会被删除，但这个节目会从播放列表移除。 @@ -37,19 +37,19 @@ FeedMe整合了这2种不同形式，你可以像听音乐一样收听所有订 当一个节目播放时，通知栏会显示相应信息。你可以点击它来进入播放界面。 - + # 播放界面 播放界面有3个子页面。你可以看到在播放列表界面有一个`停止标记`。 - + # TTS设置 `设置`中增加了`音频`标签，你可以在此进行相关设置。 - + # 提示 ### 播放feed页面还是web页面 ##### Q: 有时订阅源没有输出全文，此时如果将页面切换到web页面后播放，它仍会播放feed页面的内容。那么应该如何播放web页面的内容呢？ -A: 你可以阅读这个部分。 +A: 你可以阅读这个部分。 diff --git a/doc/zh/subscription.md b/doc/zh/subscription.md index 7da4a69..c003939 100644 --- a/doc/zh/subscription.md +++ b/doc/zh/subscription.md @@ -3,7 +3,7 @@ 如下图所示，一共有四种类型。 - + 图标左半边代表是否下载图片，右半边代表是否下载全文。所以四个图标依次代表： - 1：下载图片，不下载全文 diff --git a/privacy_and_security.md b/privacy_and_security.md index 0504162..9431284 100644 --- a/privacy_and_security.md +++ b/privacy_and_security.md @@ -19,4 +19,4 @@ A: Yes. - FeedMe won't use your other information in your storage. ##### Q:Is any third party library used that tracks? -A: I have listed the third party libraries ( https://github.com/seazon/FeedMe/blob/master/doc/en/licenses.md ). You can check their documents and source codes. \ No newline at end of file +A: I have listed the third party libraries ( https://github.com/seazon/FeedMe/blob/main/doc/en/licenses.md ). You can check their documents and source codes. \ No newline at end of file