add mobilizer.md and add folder for each language

This commit is contained in:
zhangshunjie 2017-05-16 13:23:10 +08:00
parent 10af3d0b5e
commit 1d5ae20cd0
26 changed files with 109 additions and 17 deletions

View File

@ -20,3 +20,5 @@ This is the documentation of FeedMe.
- <a href="https://github.com/seazon/FeedMe/blob/master/patches_2.x.md">2.x</a> - <a href="https://github.com/seazon/FeedMe/blob/master/patches_2.x.md">2.x</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/patches_1.x.md">1.x</a> - <a href="https://github.com/seazon/FeedMe/blob/master/patches_1.x.md">1.x</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/patches_0.x.md">0.x</a> - <a href="https://github.com/seazon/FeedMe/blob/master/patches_0.x.md">0.x</a>
# <a href="https://github.com/seazon/FeedMe/blob/master/doc/zh/README.md">中文</a>

View File

@ -1,13 +1,14 @@
从2.5版本开始,你可以自定义`动作条`菜单和`悬浮按钮`菜单。 从2.5版本开始,你可以自定义`动作条`菜单和`悬浮按钮`菜单。
<img src="https://github.com/seazon/FeedMe/blob/master/customize_menus_1.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/customize_menus_1.png" width="25%" height="25%" />
## 进入编辑模式 ## 进入编辑模式
长按动作条标题位置可以进入编辑模式。在打开的编辑对话框中你可以看到4个部分`悬浮按钮``显示``隐藏`和`禁用`。通过拖拽右侧的图标你可以为菜单排序,或者移动菜单到你想要的位置。。 长按动作条标题位置可以进入编辑模式。在打开的编辑对话框中你可以看到4个部分`悬浮按钮``显示``隐藏`和`禁用`。通过拖拽右侧的图标你可以为菜单排序,或者移动菜单到你想要的位置。。
<img src="https://github.com/seazon/FeedMe/blob/master/customize_menus_2.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/customize_menus_2.png" width="25%" height="25%" />
你可以定义一个`悬浮按钮`和多个`显示`的菜单,如果动作条空间不够,会和`隐藏`的菜单一样,显示在`更多`菜单中。如果某些菜单你根本不想用,可以设置为`禁用`。 你可以定义一个`悬浮按钮`和多个`显示`的菜单,如果动作条空间不够,会和`隐藏`的菜单一样,显示在`更多`菜单中。如果某些菜单你根本不想用,可以设置为`禁用`。
## 分动作条 ## 分动作条
如果你启用了`分动作条``悬浮按钮`菜单不再有效,而是成为动作条菜单的第一个菜单。 如果你启用了`分动作条``悬浮按钮`菜单不再有效,而是成为动作条菜单的第一个菜单。

View File

Before

Width:  |  Height:  |  Size: 498 KiB

After

Width:  |  Height:  |  Size: 498 KiB

View File

Before

Width:  |  Height:  |  Size: 224 KiB

After

Width:  |  Height:  |  Size: 224 KiB

View File

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 141 KiB

View File

Before

Width:  |  Height:  |  Size: 139 KiB

After

Width:  |  Height:  |  Size: 139 KiB

View File

Before

Width:  |  Height:  |  Size: 144 KiB

After

Width:  |  Height:  |  Size: 144 KiB

BIN
doc/en/imgs/mobilizer_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 157 KiB

BIN
doc/en/imgs/mobilizer_2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB

View File

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

View File

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

View File

Before

Width:  |  Height:  |  Size: 126 KiB

After

Width:  |  Height:  |  Size: 126 KiB

View File

Before

Width:  |  Height:  |  Size: 124 KiB

After

Width:  |  Height:  |  Size: 124 KiB

View File

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 63 KiB

View File

Before

Width:  |  Height:  |  Size: 202 KiB

After

Width:  |  Height:  |  Size: 202 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

22
doc/zh/README.md Normal file
View File

@ -0,0 +1,22 @@
FeedMe is an unofficial Reader client application for Feedly, InoReader, Bazqux, The Older Reader and Feedbin.
This is the documentation of FeedMe.
# 主题:
- <a href="https://github.com/seazon/FeedMe/blob/master/podcast_tts.md">Podcast & TTS</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/doc/zh/filter.md">过滤器</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/doc/zh/customize_menus_zh.md">自定义菜单</a>
- Feed setting
- <a href="https://github.com/seazon/FeedMe/blob/master/doc/zh/mobilizer.md">Mobilizer</a>
- Sync
- FAB & Action Bar
# <a href="https://github.com/seazon/FeedMe/blob/master/qa.md">QA</a>
# 更新:
- <a href="https://github.com/seazon/FeedMe/blob/master/doc/zh/patches.md">3.x</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/patches_2.x.md">2.x</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/patches_1.x.md">1.x</a>
- <a href="https://github.com/seazon/FeedMe/blob/master/patches_0.x.md">0.x</a>

14
doc/zh/customize_menus.md Normal file
View File

@ -0,0 +1,14 @@
从2.5版本开始,你可以自定义`动作条`菜单和`悬浮按钮`菜单。
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/customize_menus_1.png" width="25%" height="25%" />
## 进入编辑模式
长按动作条标题位置可以进入编辑模式。在打开的编辑对话框中你可以看到4个部分`悬浮按钮``显示``隐藏`和`禁用`。通过拖拽右侧的图标你可以为菜单排序,或者移动菜单到你想要的位置。。
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/customize_menus_2.png" width="25%" height="25%" />
你可以定义一个`悬浮按钮`和多个`显示`的菜单,如果动作条空间不够,会和`隐藏`的菜单一样,显示在`更多`菜单中。如果某些菜单你根本不想用,可以设置为`禁用`。
## 分动作条
如果你启用了`分动作条``悬浮按钮`菜单不再有效,而是成为动作条菜单的第一个菜单。

26
doc/zh/filter.md Normal file
View File

@ -0,0 +1,26 @@
从2.4版本开始FeedMe支持在同步时对新文章进行过滤把你不想读的文章自动标记为已读来节省你的阅读时间。对每个订阅源你可以添加不同的的过滤。
过滤设置在订阅源的设置界面。你可以看到左侧是一个切换开关,可以以不同的方式来对这歌订阅源进行过滤。下面是填写过滤关键字的文本框。
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/filter_1.png" width="25%" height="25%" />
## 过滤方式
- `保留`:仅保留满足关键字的文章,其它文章标记为已读
- `过滤`:仅将满足关键字的文章标记为已读
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/filter_2.png" width="25%" height="25%" />
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/filter_3.png" width="25%" height="25%" />
当某个源你只关心含有某些关键字的文章时,你可以使用保留方式;当某个源你不关心某些关键字时,你可以使用过滤方式。
## 文本框
- 当你的关键字是2个词的组合可以使用`+`
- 当你需要设置超过1个关键字时可以使用`;`
## 例子
- 如果你想`保留`标题中包含`android`的文章,先把切换开关设置为`保留`。在文本框输入`android`即可
- 如果你想`保留`标题中包含`android`,同时含有`google`的文章,先把切换开关设置为`保留`。在文本框输入`android+google`即可
- 如果你想`保留`标题中包含`android`,同时含有`google`的文章 ,同时也想保留标题中包含`chrome`的文章,先把切换开关设置为`保留`。在文本框输入`android+google;chrome`即可
- 如果你想`过滤`标题中包含`android`的文章,先把切换开关设置为`过滤`。在文本框输入`android`即可
- 如果你想`过滤`标题中包含`android`,同时含有`google`的文章,先把切换开关设置为`过滤`。在文本框输入`android+google`即可
- 如果你想`过滤`标题中包含`android`,同时含有`google`的文章 ,同时也想过滤标题中包含`chrome`的文章,先把切换开关设置为`过滤` 。在文本框输入`android+google;chrome`即可

16
doc/zh/mobilizer.md Normal file
View File

@ -0,0 +1,16 @@
## Mobilizer 和全文下载
有些 RSS 订阅源的文章只提供摘要而不是全文这样的阅读体验并不友好。FeedMe 提供了多种 Mobilizer 来进行全文下载。目前支持 `FeedMe``Mercury` 和 `Google Web Light` 3种。`FeedMe` 为 FeedMe 自带 Mobilizer另外2个是第三方 Mobilizer 服务。
在 FeedMe 中有2种情况需要用到 Mobilizer。
1. 在手动/自动同步时使用 Mobilizer 进行全文下载;
2. 在阅读时使用 Mobilizer 进行全文下载。
你可以在下图中看到这2个设置可以通过侧边栏-订阅-类别/订阅源到达这里):
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/mobilizer_1.png" width="25%" height="25%" />
许多用户询问为什么设置了第三方mobilizer但是文章还是使用feedme mobilizer下载的
因为第三方 Mobilizer 为了保证其服务的可用性,一般都会限制调用频率。如果调用过快或者次数过多,他们就会停止服务。由于 FeedMe 同步时下载频率很高,就可能因此导致第三方 Mobilizer 不可用。所以在同步时,只有自带的 Mobilizer可用。
所以,在订阅源设置中的 Mobilizer只适用于阅读时的下载。见下图。
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/mobilizer_2.png" width="25%" height="25%" />
Mobilizer去除网页上一些不重要的元素头部侧边及底部的导航或者链接并重新排版仅保留正文部分。一般 Mobilizer 得到的文章是由程序算法计算解析得出的所以不能保证百分百的正确。成熟的Mobilizer 在正确性上会做的更好,而自带的会差一些。

View File

@ -2,14 +2,14 @@
过滤设置在订阅源的设置界面。你可以看到左侧是一个切换开关,可以以不同的方式来对这歌订阅源进行过滤。下面是填写过滤关键字的文本框。 过滤设置在订阅源的设置界面。你可以看到左侧是一个切换开关,可以以不同的方式来对这歌订阅源进行过滤。下面是填写过滤关键字的文本框。
<img src="https://github.com/seazon/FeedMe/blob/master/filter_1.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/filter_1.png" width="25%" height="25%" />
## 过滤方式 ## 过滤方式
- `保留`:仅保留满足关键字的文章,其它文章标记为已读 - `保留`:仅保留满足关键字的文章,其它文章标记为已读
- `过滤`:仅将满足关键字的文章标记为已读 - `过滤`:仅将满足关键字的文章标记为已读
<img src="https://github.com/seazon/FeedMe/blob/master/filter_2.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/filter_2.png" width="25%" height="25%" />
<img src="https://github.com/seazon/FeedMe/blob/master/filter_3.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/filter_3.png" width="25%" height="25%" />
当某个源你只关心含有某些关键字的文章时,你可以使用保留方式;当某个源你不关心某些关键字时,你可以使用过滤方式。 当某个源你只关心含有某些关键字的文章时,你可以使用保留方式;当某个源你不关心某些关键字时,你可以使用过滤方式。

View File

@ -1,5 +1,16 @@
Mobilizer and full text download ## Mobilizer and full text download
Some RSS feed article just provides summary, not full text. This reading experience is not friendly. FeedMe offers some mobilizers for full download. Now support `FeedMe``Mercury` and `Google Web Light`. `FeedMe` is built-in mobilizer of FeedMethe other two are third party Mobilizer services.
There are two mobilizer. One for sync time, one for reading time. And the setting of Mobilizer in feed setting dialog is for reading. In FeedMe, there are two cases where mobilizer is required.
1. download when sync
2. downlaod when reading
You can find these 2 settings below (NAV side - Subscription - category/feed):
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/mobilizer_1.png" width="25%" height="25%" />
You can set the reading mobilizer by your self, but you CAN'T change sync mobilizer, FeedMe is the only option for this, so you can't find the setting of sync mobilizer. Many users asked 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 is only use for download when reading.
<img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/mobilizer_2.png" width="25%" height="25%" />
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.

View File

@ -7,12 +7,12 @@ 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. FeedMe provides play section into the playlist in the left navigation bar. To simplify the logic, FeedMe has only one playlist.
<img src="https://github.com/seazon/FeedMe/blob/master/tts_2.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_2.png" width="25%" height="25%" />
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. 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.
<img src="https://github.com/seazon/FeedMe/blob/master/tts_8.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_8.png" width="25%" height="25%" />
<img src="https://github.com/seazon/FeedMe/blob/master/tts_9.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_9.png" width="25%" height="25%" />
# Play control # Play control
There are 4 play menus in article list long-tap dialog: There are 4 play menus in article list long-tap dialog:
@ -23,7 +23,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. `Stop tag`: When played a item with `Stop tag`, stop play and clear it.
<img src="https://github.com/seazon/FeedMe/blob/master/tts_1.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_1.png" width="25%" height="25%" />
# Playlist # Playlist
- The played item will be automatically removed from playlist, including podcast audio files. So no need to remove item by yourself. - The played item will be automatically removed from playlist, including podcast audio files. So no need to remove item by yourself.
@ -36,16 +36,16 @@ 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. When an item is playing, a notification adds in notification bar. And you can enter playing page via tap it.
<img src="https://github.com/seazon/FeedMe/blob/master/tts_6.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_6.png" width="25%" height="25%" />
# Playing page # Playing page
There are 3 pages in playing page. You can find a sross icon in playlist page, that is `Stop tag`. There are 3 pages in playing page. You can find a sross icon in playlist page, that is `Stop tag`.
<img src="https://github.com/seazon/FeedMe/blob/master/tts_3.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_3.png" width="25%" height="25%" />
<img src="https://github.com/seazon/FeedMe/blob/master/tts_4.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_4.png" width="25%" height="25%" />
<img src="https://github.com/seazon/FeedMe/blob/master/tts_5.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_5.png" width="25%" height="25%" />
# TTS setting # TTS setting
There is an `Audio` tab in `Settings`, you can goto TTS setting page from here. There is an `Audio` tab in `Settings`, you can goto TTS setting page from here.
<img src="https://github.com/seazon/FeedMe/blob/master/tts_7.png" width="25%" height="25%" /> <img src="https://github.com/seazon/FeedMe/blob/master/doc/en/imgs/tts_7.png" width="25%" height="25%" />