newsblur_help.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <html>
  2. <head>
  3. <title>NewsBlur Help</title>
  4. <style type="text/css">
  5. body {
  6. font-family: Nokia Pure Text Light;
  7. background-color: #E0E1E2;
  8. }
  9. h1 {
  10. font-size: 24px;
  11. }
  12. p {
  13. font-size: 24px;
  14. }
  15. li {
  16. font-size: 24px;
  17. }
  18. img.floatLeft {
  19. float: left;
  20. margin-right: 16px;
  21. margin-bottom: 16px;
  22. }
  23. img.floatRight {
  24. float: right;
  25. margin-left: 16px;
  26. margin-bottom: 16px;
  27. clear: true
  28. }
  29. .positive {
  30. color: #008000
  31. }
  32. .negative {
  33. color: #ff0000
  34. }
  35. .neutral {
  36. color: #ff8c00
  37. }
  38. </style>
  39. </head>
  40. <body>
  41. <img src="newsblur_help_files/logo_newsblur.png"/ >
  42. <p>NewsBlur, created by Samuel Clay, is an open-source RSS feed reader,
  43. offering an intelligent way to find stories you like and those you do not. NewsBlur automatically classifies
  44. every story based on the state of user editable intelligence classifiers. There are three types of possible classifications:
  45. <ul>
  46. <li>negative classification - highlighted with <span class="negative">red</span></li>
  47. <li>neutral classification - highlighted with <span class="neutral">orange</span></li>
  48. <li>positive classification - highlighted with <span class="positive">green</span></li>
  49. </ul>
  50. </p>
  51. <h1>Feeds and folders</h1>
  52. <img src="newsblur_help_files/special_feeds_small.png" class="floatRight"/ >
  53. <p>After a successful account creation the list of subscribed feeds is empty, however there
  54. are two special feeds that will be instantly visible. The <em>Everything</em> feed, unlike the regular feeds, contains stories
  55. from multiple feeds which are not read yet. If there are no unread stories at all, this feed is empty. The <em>Saved stories</em> feed
  56. contains the stories which are marked as saved. It's a useful feature in cases when you find an interesting story
  57. but you don't want or can't read it instantly. The <em>Saved stories</em> feed allows you to find these stories easily at a later time.</p>
  58. <p>Feeds can be either added directly to the list of subscriptions or they can be organized hierarchically into folders.
  59. To add a new feed or to add a new folder press the '+' icon on the toolbar. New feeds and folders are always added to
  60. the folder that is currently visible in the view. A new feed can be added by either entering the full address of the feed,
  61. or by entering just search terms describing the feed. In the later case you'll get a list of suggestions from NewsBlur, select the
  62. one that you think is the best match and press the <em>Add</em> button. To add a new folder, just enter the new folder's name and press the
  63. <em>Add</em> button.</p>
  64. <img src="newsblur_help_files/menu_small.png" class="floatLeft"/ >
  65. <p>Existing feeds and folders can be modified and reorganized in a number of ways. These operations can be reached from the main menu
  66. or from the context menu of feed and folder items. An item's name can be modified by selecting the <em>Rename</em> item from the menu. Enter a new name for the item and press the <em>Rename</em> button.
  67. To delete an item, just select the <em>Delete</em> menu item. To modify the position of a feed or a folder item in the folder hierarchy select
  68. the <em>Move to</em> menu item, and a folder from the list of the available options. An item can be moved to any folder, except to it's current
  69. parent folder and to any of it's child folders.</p>
  70. <h1>Stories</h1>
  71. <img src="newsblur_help_files/countbubble.png" class="floatLeft"/ >
  72. <p>The number of unread stories for every feed in the current folder or for the current feed in the view is displayed in the top left corner
  73. of the page header, and also separately for every item in the list. If there are no unread stories, no unread count is displayed. The number of unread
  74. stories are displayed separately for every classification. The number of neutrally classified stories are marked with <span class="neutral">orange</span> color, the number of
  75. negatively classified or disliked stories is marked with <span class="negative">red</span> and the number of positively classified stories or the stories you might like
  76. is marked with <span class="positive">green</span> color.</p>
  77. <p>The stories of a particular feed can be viewed by entering the feed. If you enter a feed the list of stories is initially empty until the
  78. first batch of stories is loaded. Whenever the app loads a new batch of stories, a wait indicator is displayed in the page header. Whenever new
  79. stories for the given feed appear, they are automatically loaded and prepended to the list of stories. The contents of the stories are cached to
  80. speed up the browsing of feeds. The number of stories that are allowed to be cached can be adjusted in the settings of WebFeeds. The <em>Everything</em>
  81. feed is an exception. Due to the way NewsBlur updates feeds, stories in the <em>Everything</em> feed can't be reliably cached. The stories in
  82. this feed are just partially updated, new stories are loaded whenever they appear, but unread stories can also appear with older dates. So
  83. whenever you want to make a complete update of the list of unread stories, press the refresh button in the toolbar.</p>
  84. <img src="newsblur_help_files/classification_small.png" class="floatRight"/ >
  85. <p>The classification of stories in a feed is indicated with horizontal lines on the left side of the story items with the same colors as the number
  86. of unread stories are marked. Unread stories are marked with brighter colors, the stories that are already read are marked with dimmer colors.
  87. If a story is saved, the story item is marked with a star.</p>
  88. <img src="newsblur_help_files/filter_options_small.png" class="floatLeft"/ >
  89. <p>In the feed view stories can be filtered by their classification. The current filter in use is indicated by the colors of the count
  90. bubble in the page header. The classification of hidden stories are highlighted with gray color instead of their original highlight color
  91. like red or orange. The filtering method can be changed by pressing the page header and selecting a different filter.</p>
  92. <p>To view the contents of a story press the story item in the list. To view the next or previous story in the feed swipe right or left.
  93. Stories can be saved or unsaved by pressing the star icon in the toolbar. Stories can be shared with any of your accounts which allows
  94. sharing of links, by pressing the share button on the toolbar. Read stories can also be marked as unread from the menu.</p>
  95. <p>To mark every story of a single or multiple feeds as read, press the check mark button in the toolbar. When it's pressed inside a feed
  96. every story of the current feed will be marked as read, pressing it inside a folder will mark every story of the current folder's child
  97. feeds as read, pressing it in the root folder of NewsBlur or in the <em>Everything</em> feed will mark every story in every feed as read.</p>
  98. <h1>Intelligence trainer</h1>
  99. <p>The classifications of existing and future stories are determined by the state of intelligence classifiers of their feeds. Intelligence classifiers
  100. can be modified by opening the <em>Intelligence trainer</em> from the menu. When opened inside a feed every classifier of the current feed is displayed,
  101. when opened inside a story only the classifiers related to the current story are displayed. Three types of classifiers are available:
  102. <ul>
  103. <li>Title classifiers - affect the classification of stories which title contains the text of the classifier.</li>
  104. <li>Author classifiers - affect the classification of stories with the given author.</li>
  105. <li>Tag classifiers - affect the classification of stories marked with the given tag.</li>
  106. <li>Feed classifiers - affect every story related to the given feed.</li>
  107. </ul>
  108. </p>
  109. <img src="newsblur_help_files/classifier_small.png" class="floatRight"/ >
  110. <p>As mentioned earlier, classifiers can take three values, <span class="negative">negative</span>, <span class="neutral">neutral</span>
  111. and <span class="positive">positive</span>. To change the value of a classifier press the dislike button on it's left to give it a
  112. <span class="negative">negative</span>, press it in the center to give it a <span class="neutral">neutral</span> or press the like button
  113. on it's right to give it a <span class="positive">positive</span> value.
  114. The actual classification of a story is determined by the following rules:
  115. <ol>
  116. <li>if there is at least one title, author or tag classifier with a <span class="positive">positive</span> value related to
  117. the given story, it's classification is <span class="positive">positive</span></li>
  118. <li>if there is at least one title, author or tag classifier with a <span class="negative">negative</span> value related to
  119. the given story, it's classification is <span class="negative">negative</span></li>
  120. <li>if there are no title, author or tag classifiers with a <span class="positive">positive</span> or <span class="negative">negative</span> value related to
  121. the given story, it's classification is equal to the value of the feed classifier.</li>
  122. </ol>
  123. </p>
  124. </body>
  125. </html>