diff --git a/README.md b/README.md index 12c6871..49afdc6 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,5 @@ This is the documentation of FeedMe. - 2.x - 1.x - 0.x + +# 中文 diff --git a/customize_menus_zh.md b/customize_menus_zh.md index 83bed79..7cd688d 100644 --- a/customize_menus_zh.md +++ b/customize_menus_zh.md @@ -1,13 +1,14 @@ 从2.5版本开始，你可以自定义`动作条`菜单和`悬浮按钮`菜单。 - + ## 进入编辑模式 长按动作条标题位置可以进入编辑模式。在打开的编辑对话框中，你可以看到4个部分，`悬浮按钮`，`显示`，`隐藏`和`禁用`。通过拖拽右侧的图标你可以为菜单排序，或者移动菜单到你想要的位置。。 - + 你可以定义一个`悬浮按钮`和多个`显示`的菜单，如果动作条空间不够，会和`隐藏`的菜单一样，显示在`更多`菜单中。如果某些菜单你根本不想用，可以设置为`禁用`。 ## 分动作条 如果你启用了`分动作条`，`悬浮按钮`菜单不再有效，而是成为动作条菜单的第一个菜单。 + diff --git a/customize_menus_1.png b/doc/en/imgs/customize_menus_1.png similarity index 100% rename from customize_menus_1.png rename to doc/en/imgs/customize_menus_1.png diff --git a/customize_menus_2.png b/doc/en/imgs/customize_menus_2.png similarity index 100% rename from customize_menus_2.png rename to doc/en/imgs/customize_menus_2.png diff --git a/filter_1.png b/doc/en/imgs/filter_1.png similarity index 100% rename from filter_1.png rename to doc/en/imgs/filter_1.png diff --git a/filter_2.png b/doc/en/imgs/filter_2.png similarity index 100% rename from filter_2.png rename to doc/en/imgs/filter_2.png diff --git a/filter_3.png b/doc/en/imgs/filter_3.png similarity index 100% rename from filter_3.png rename to doc/en/imgs/filter_3.png diff --git a/doc/en/imgs/mobilizer_1.png b/doc/en/imgs/mobilizer_1.png new file mode 100644 index 0000000..60f22b4 Binary files /dev/null and b/doc/en/imgs/mobilizer_1.png differ diff --git a/doc/en/imgs/mobilizer_2.png b/doc/en/imgs/mobilizer_2.png new file mode 100644 index 0000000..dd756cd Binary files /dev/null and b/doc/en/imgs/mobilizer_2.png differ diff --git a/tts_1.png b/doc/en/imgs/tts_1.png similarity index 100% rename from tts_1.png rename to doc/en/imgs/tts_1.png diff --git a/tts_2.png b/doc/en/imgs/tts_2.png similarity index 100% rename from tts_2.png rename to doc/en/imgs/tts_2.png diff --git a/tts_3.png b/doc/en/imgs/tts_3.png similarity index 100% rename from tts_3.png rename to doc/en/imgs/tts_3.png diff --git a/tts_4.png b/doc/en/imgs/tts_4.png similarity index 100% rename from tts_4.png rename to doc/en/imgs/tts_4.png diff --git a/tts_5.png b/doc/en/imgs/tts_5.png similarity index 100% rename from tts_5.png rename to doc/en/imgs/tts_5.png diff --git a/tts_6.png b/doc/en/imgs/tts_6.png similarity index 100% rename from tts_6.png rename to doc/en/imgs/tts_6.png diff --git a/tts_7.png b/doc/en/imgs/tts_7.png similarity index 100% rename from tts_7.png rename to doc/en/imgs/tts_7.png diff --git a/tts_8.png b/doc/en/imgs/tts_8.png similarity index 100% rename from tts_8.png rename to doc/en/imgs/tts_8.png diff --git a/tts_9.png b/doc/en/imgs/tts_9.png similarity index 100% rename from tts_9.png rename to doc/en/imgs/tts_9.png diff --git a/doc/zh/README.md b/doc/zh/README.md new file mode 100644 index 0000000..a165c52 --- /dev/null +++ b/doc/zh/README.md @@ -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. + +# 主题: + +- Podcast & TTS +- 过滤器 +- 自定义菜单 +- Feed setting +- Mobilizer +- Sync +- FAB & Action Bar + +# QA + +# 更新: + +- 3.x +- 2.x +- 1.x +- 0.x diff --git a/doc/zh/customize_menus.md b/doc/zh/customize_menus.md new file mode 100644 index 0000000..7cd688d --- /dev/null +++ b/doc/zh/customize_menus.md @@ -0,0 +1,14 @@ +从2.5版本开始，你可以自定义`动作条`菜单和`悬浮按钮`菜单。 + + + +## 进入编辑模式 +长按动作条标题位置可以进入编辑模式。在打开的编辑对话框中，你可以看到4个部分，`悬浮按钮`，`显示`，`隐藏`和`禁用`。通过拖拽右侧的图标你可以为菜单排序，或者移动菜单到你想要的位置。。 + + + +你可以定义一个`悬浮按钮`和多个`显示`的菜单，如果动作条空间不够，会和`隐藏`的菜单一样，显示在`更多`菜单中。如果某些菜单你根本不想用，可以设置为`禁用`。 + +## 分动作条 +如果你启用了`分动作条`，`悬浮按钮`菜单不再有效，而是成为动作条菜单的第一个菜单。 + diff --git a/doc/zh/filter.md b/doc/zh/filter.md new file mode 100644 index 0000000..92f0bb3 --- /dev/null +++ b/doc/zh/filter.md @@ -0,0 +1,26 @@ +从2.4版本开始，FeedMe支持在同步时对新文章进行过滤，把你不想读的文章自动标记为已读，来节省你的阅读时间。对每个订阅源，你可以添加不同的的过滤。 + +过滤设置在订阅源的设置界面。你可以看到左侧是一个切换开关，可以以不同的方式来对这歌订阅源进行过滤。下面是填写过滤关键字的文本框。 + + + +## 过滤方式 +- `保留`：仅保留满足关键字的文章，其它文章标记为已读 +- `过滤`：仅将满足关键字的文章标记为已读 + + + + +当某个源你只关心含有某些关键字的文章时，你可以使用保留方式；当某个源你不关心某些关键字时，你可以使用过滤方式。 + +## 文本框 +- 当你的关键字是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`即可 diff --git a/doc/zh/mobilizer.md b/doc/zh/mobilizer.md new file mode 100644 index 0000000..15a612d --- /dev/null +++ b/doc/zh/mobilizer.md @@ -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个设置（可以通过侧边栏-订阅-类别/订阅源到达这里）： + + +许多用户询问为什么设置了第三方mobilizer，但是文章还是使用feedme mobilizer下载的？ +因为第三方 Mobilizer 为了保证其服务的可用性，一般都会限制调用频率。如果调用过快或者次数过多，他们就会停止服务。由于 FeedMe 同步时下载频率很高，就可能因此导致第三方 Mobilizer 不可用。所以在同步时，只有自带的 Mobilizer可用。 + +所以，在订阅源设置中的 Mobilizer，只适用于阅读时的下载。见下图。 + + +注：Mobilizer：去除网页上一些不重要的元素（头部，侧边及底部的导航或者链接）并重新排版，仅保留正文部分。一般 Mobilizer 得到的文章是由程序算法计算解析得出的，所以不能保证百分百的正确。成熟的Mobilizer 在正确性上会做的更好，而自带的会差一些。 \ No newline at end of file diff --git a/patches_zh.md b/doc/zh/patches.md similarity index 100% rename from patches_zh.md rename to doc/zh/patches.md diff --git a/filter_zh.md b/filter_zh.md index 1a219a5..92f0bb3 100644 --- a/filter_zh.md +++ b/filter_zh.md @@ -2,14 +2,14 @@ 过滤设置在订阅源的设置界面。你可以看到左侧是一个切换开关，可以以不同的方式来对这歌订阅源进行过滤。下面是填写过滤关键字的文本框。 - + ## 过滤方式 - `保留`：仅保留满足关键字的文章，其它文章标记为已读 - `过滤`：仅将满足关键字的文章标记为已读 - - + + 当某个源你只关心含有某些关键字的文章时，你可以使用保留方式；当某个源你不关心某些关键字时，你可以使用过滤方式。 diff --git a/mobilizer.md b/mobilizer.md index 8173da0..780a97c 100644 --- a/mobilizer.md +++ b/mobilizer.md @@ -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 FeedMe，the 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): + -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. + + +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/podcast_tts.md b/podcast_tts.md index 033077d..0453674 100644 --- a/podcast_tts.md +++ b/podcast_tts.md @@ -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. - + 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: @@ -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. - + # Playlist - 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. - + # Playing page There are 3 pages in playing page. You can find a sross 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. - +