├── README.md
└── docs
├── categories.md
├── extras.md
├── feedinfopage.md
├── gettingstarted.md
├── goingdeeper.md
├── newsproducts.md
├── readingnews.md
├── readme.md
├── settings.md
├── yourfeed.md
└── yourfeedlist.md
/README.md:
--------------------------------------------------------------------------------
1 | # FeedLand Support
2 |
3 | FeedLand an application that runs in your web browser for managing lists of feeds, sharing them with others, and reading and sharing news.
4 |
5 | If you have a support issue, something that isn't working properly, or you have a question about how the product works, post an issue here. You can also use the Slack group for the same purpose.
6 |
7 | If you're using FeedLand seriously, you might want to Watch this repo, to be in the flow of support questions and product updates.
8 |
9 | When reporting a problem, be sure it is reproducible, say what you did, expected to happen and what actually happened. Screen shots can be helpful. Please look in the JavaScript console in the browser to see if there are any error messages. That's how the software helps us find what went wrong. Remember also that all the the people helping you are volunteers. Everyone gets respect here, and if someone helps you, be sure to thank them. :smile:
10 |
11 | ### Docs
12 |
13 | Here's a list of the docs we have for FeedLand.
14 |
15 | * Starting up -- how to find feeds to subscribe to, how to read the news, finding other users.
16 |
17 | * Going Deeper -- the Feed List and Feed Info pages. Reading feeds. Settings.
18 |
19 | * Categories -- the key to customization of news and presenting news to non-FeedLand users.
20 |
21 | * News products -- how to make single-page public websites with news generated by FeedLand.
22 |
23 | ### Related projects
24 |
25 | FeedLand is written in Node.js JavaScript on the server, and as an app running in the browser, also in JavaScript.
26 |
27 | A list of open source projects that FeedLand builds on.
28 |
29 | * appserver -- the server framework we use.
30 |
31 | * reallySimple -- parses RSS, Atom and RDF feeds into a standard struction, in JSON.
32 |
33 | * OPML -- read and write OPML files.
34 |
35 | * rssCloud -- feed update notification, part of RSS 2.0.
36 |
37 | FeedLand itself is not at this time open source.
38 |
39 | ### Utilities
40 |
41 | Utilities for people who work with feeds.
42 |
43 | * subscriptionListCleanup-- a Node app that reads an OPML subscription list, and loops over the feeds and only passes on the ones that are reachable and parseable.
44 |
45 |
--------------------------------------------------------------------------------
/docs/categories.md:
--------------------------------------------------------------------------------
1 | # Categories in FeedLand
2 |
3 | Categories allow you to customize the news in FeedLand.
4 |
5 | ### How it works
6 |
7 | You can assign each feed you're subscribed to to one or more categories. You decide on the categories, and whether or not to display them as tabs on your main news page in FeedLand.
8 |
9 | ### Deciding on your categories
10 |
11 | First think about what categories you want to use initially. I recommend just using two or three, to get used to the concepts. You can change your mind later. Here's a suggestion of a list of categories to start with.
12 |
13 | ``All, Tech, Politics, NYT, Bloggers``
14 |
15 | You would then assign feeds that are largely about tech to the Tech category.
16 |
17 | If you were following a tech blogger, you would assign them to both Tech and Bloggers.
18 |
19 | I recommend having an All category, and unless you feel strongly that a feed should not be in it, that all feeds are.
20 |
21 | ### Setting the categories
22 |
23 | When you've decided on a list of categories, open the Settings dialog. Click on the Categories tab. Enter the category names, separated by commas, in the first box. Leave the other boxes empty for now. When you're done click the OK button to save the categories.
24 |
25 |
26 |
27 | ### Assigning feeds to categories
28 |
29 | Choose My feed list in the first menu. These are all the feeds you're subscribed to.
30 |
31 | To the right of each name you'll see an icon that looks like a tag. If the tag is dark that means the feed has categories already set, if it's light, only All is checked. Here's what that looks like:
32 |
33 |
34 |
35 | When you click it a list of checkboxes for each of your categories appears. Only the All checkbox is checked.
36 |
37 | Click the categories that apply to this feed. The checkboxes are hot, they change in the database immediately when you click on them.
38 |
39 | The title of the feed appears at the top of the dialog. If you hover the mouse over the title you'll see a tooltip with the description of the feed, as provided in the feed itself. Not all feeds have descriptions, and some of them aren't informative.
40 |
41 | The arrows at the bottom of the dialog allow you to move between feeds in the Feed List without having to close and re-open the dialog.
42 |
43 |
44 |
45 | ### Adding tabs to your news page
46 |
47 | After assigning categories to some of your feeds, go back to the Settings dialog, and fill in the second box with a few categories:
48 |
49 | ``All, Tech, Politics``
50 |
51 | Click the OK button to save the new settings, then choose My news from the first menu. You should now see your news organized into three tabs.
52 |
53 |
54 |
55 | ### Getting an OPML subscription list for a category
56 |
57 | Suppose you want an OPML subscription list for my politics category.
58 |
59 | http://feedland.org/opml?screenname=davewiner&catname=politics
60 |
61 | You can create a link like that for any user's category.
62 |
63 | Or you can click the orange XML icon in the upper right corner of any page, where you see it.
64 |
65 | ### Facts about categories
66 |
67 | The names of categories are not case-sensitive.
68 |
69 | You can specify the categories for your news page in any order, they don't have to be in the same order as they appear in the main category list.
70 |
71 | ### What does "All" mean?
72 |
73 | When you create a new subscription, it is in no categories.
74 |
75 | If you have no categories defined, ie you're a new user, if you open the Categories dialog for any feed you will have one choice, All. It will not be checked. It's just a suggestion.
76 |
77 | Basically All is a default category for every user. If you don't include it in your list, however, it will not be one of the checkboxes.
78 |
79 | Categories are low-tech, if you delete a category from your list, all subscriptions that you've categorized with that label will remain labeled. The values you put in that dialog control what's in the checkboxes and what's in the tabs on your News page.
80 |
81 |
--------------------------------------------------------------------------------
/docs/extras.md:
--------------------------------------------------------------------------------
1 | # Extras
2 |
3 | Features that don't yet deserve their own pages.
4 |
5 | ### Bookmarks in FeedLand
6 |
7 | This feature goes back a long way, to the beginnings of Frontier and Menu Sharing and through Drummer, whose Bookmarks menu is imho a truly revolutionary thing. Here's a screen shot of my current Bookmarks menu in Drummer. You can see I use it a lot. I expect your bookmarks menu will look something like that before too long.
8 |
9 | There are two ways to create a bookmark.
10 |
11 | When you're looking at a news item in a _river_ timeline, there's a new icon at the bottom, that looks like a bookmark. Click it. A dialog confirms that you want to add the bookmark. Then the Bookmarks editor window opens with the new bookmark added at the top. You can edit the text, and use the outliner reorganizing commands to move it where you want. When you're finished, click OK and the menu outline is saved on the server, and the menu is automatically rebuilt with the new bookmark where you put it.
12 |
13 | If you're at a page in FeedLand that you want to get back to easily, say an interesting person's feed list, choose Add Bookmark at the top of the Bookmarks menu. A dialog confirms you want to add this page to the menu. And the process of editing and placing the bookmark works exactly as it does for when creating a bookmark from a timeline.
14 |
15 | The outliner is the same one as in Drummer. For an idea of how to use it see the Outliner howto document.
16 |
17 | ### Feeds of Likes
18 |
19 | Each user can have a feed of all the items they liked in FeedLand.
20 |
21 | You must be logged in to be able to Like something.
22 |
23 |
24 |
25 | Click the thumb icon to like an item.
26 |
27 | When you like something it is added to your feed of likes, which you can then subscribe to in FeedLand or any other app that can read an RSS 2.0 feed.
28 |
29 | You have to like something before you actually have the feed. FeedLand won't create it until you like something.
30 |
31 | Here's the address for my feed of likes: http://data.feedland.org/likes/davewiner.xml.
32 |
33 | And here's the Feed Info page for that feed.
34 |
35 | Like icons appear in news pages. To see one of these pages, choose My news from the first menu.
36 |
37 | Here's my news page. If you're logged in you can like items on that page.
38 |
39 |
--------------------------------------------------------------------------------
/docs/feedinfopage.md:
--------------------------------------------------------------------------------
1 | # Feed Info page
2 |
3 | Each feed that FeedLand follows has a Feed Info page.
4 |
5 | It's linked to from the Feed List, and from the (feed) link in a River timeline.
6 |
7 |
8 |
9 | ### The title links to the feed home page
10 |
11 | When you click on the Title, you're taken to the home page of the site the feed is associated with, via the top-level <link> element in the feed.
12 |
13 | ### The description comes from the feed
14 |
15 | Description comes from the top-level <description> element in the feed.
16 |
17 | ### Viewing the actual feed
18 |
19 | Sometimes when troubleshooting a feed, you need to actually see the source of the feed itself, not a friendly rendering of the feed, as many browsers try to provide.
20 |
21 | The link to the Feed displays the contents of the feed on xmlviewer.scripting.com. If you need the actual URL of the feed, you can copy it from the text at the top of the xmlviewer page.
22 |
23 | ### View and edit categories
24 |
25 | The Categories row lists the categories you have assigned to the feed. If you click the (Edit) button you can change the category assignments in the dialog.
26 |
27 | ### View as
28 |
29 | You can view the contents of a feed either as a timeline (or river) or using a traditional mailbox view.
30 |
31 | These links are also available in the Views menu at the top of each page.
32 |
33 | ### When added
34 |
35 | When added says when the feed was first added to the FeedLand database, and by whom.
36 |
37 | ### When updated
38 |
39 | When updated says the last time we found a new item in the feed. We do recognize other changes in the feed, for example if the text of an item changes, but for us to flag a feed as updated there has to be a wholly new item.
40 |
41 | ### Number of items and checks
42 |
43 | Items / Checks says how many items we have from this feed in the database, and how many times it has been checked for new stuff. There's a button next to this item that tells the server to check the feed right now.
44 |
45 | ### Is it a fast-updating feed?
46 |
47 | Last renew says when the feed's associated rssCloud server has been last notified that FeedLand wants to be pinged when the feed updates. This protocol is part of the RSS 2.0 standard, and is widely supported on the web. However not all feeds support it. So if there is no date or time there, it means the feed doesn't have this support. In either case we check the feed manually periodically for new stuff. Feeds that support rssCloud should update instantly when they change. For feeds that support the protocol, we must renew within 25 hours or the subscription will be cancelled, but we try to do it within 23, because in this case it's better to be a little early.
48 |
49 | ### How fast is the server?
50 |
51 | Secs to read says how long it took the FeedLand server to read the feed. It's usually pretty quick, well under a second, but if the number is higher, that could indicate a problem with the feed, or possibly with the FeedLand server.
52 |
53 | ### Who is subscribed
54 |
55 | Subscribers tells you who is subscribed to this feed. If you click on a name you are taken to their Feed List, where you may get ideas for feeds you want to subscribe to.
56 |
57 | ### Subscribing
58 |
59 | The big blue button at the bottom of the page says either Unsubscribe, if you're subscribed to the feed, or Subscribe if you're not.
60 |
61 |
--------------------------------------------------------------------------------
/docs/gettingstarted.md:
--------------------------------------------------------------------------------
1 | # Getting started with FeedLand
2 |
3 | The instructions on this page help you get started in FeedLand, and let you know the limits and features of the system.
4 |
5 | ### What is FeedLand?
6 |
7 | FeedLand is an application that runs in your web browser for managing lists of feeds, sharing them with other users (both in and outside of FeedLand), and reading and sharing news.
8 |
9 | The goal of FeedLand is to make news a social thing, following the pattern of Twitter and other social media apps, but using open formats and protocols like RSS, OPML and the web.
10 |
11 | So FeedLand is feeds, news and people and software that connects it all together.
12 |
13 | ### Community
14 |
15 | People subscribe to feeds, we squeeze news out of feeds, and shape it into products.
16 |
17 | People can add new feeds. There's a limit of 250 new feeds for each user.
18 |
19 | You can also subscribe to feeds other people have added. No limit there. Subscribe to as many as you like.
20 |
21 | Everyone can see everything. Our lists and categories are there for everyone to use.
22 |
23 | A FeedLand community works together shaping news flows.
24 |
25 | ### How to sign up
26 |
27 | If this is your first time using FeedLand, you'll need to create a new account.
28 |
29 | 1. Go to feedland.org.
30 |
31 | 2. You should see a dialog, with two choices: Sign on, for people who already have an account, and Sign up for new users.
32 |
33 | 3. Click the Sign up button. A new dialog appears, asking you to choose a name and enter an email address. Both must be unique. Messages below each will tell you whether what you have entered can be used. When you're ready, click the Send button.
34 |
35 | 4. Check your email for a confirmation message. Click the link in the email to take you back to FeedLand. If all goes well, you should see your name in the upper right corner of the screen.
36 |
37 | After logging in, you're offered a chance to add some feeds to your empty feed list. It's easier to learn the product with a few feeds you're subscribed to. After they're added you will be taken to your Feed List page.
38 |
39 | You might want to bookmark that page. While you're starting out with FeedLand, it'll be your home page.
40 |
41 | ### Subscribe to some feeds
42 |
43 | Choose Recent users from the first menu. Click on a name to see what they're subscribed to.
44 |
45 | If you see a feed you want to subscribe to, click the checkbox. That's all you have to do.
46 |
47 | Another way to find feeds is to look in the Hotlist or the Subscription log, accessible from the first menu. When you see something you like, click the checkbox next to it.
48 |
49 | To get back to your feed list, choose My feed list from the first menu.
50 |
51 | ### Reading the new stuff
52 |
53 | A quick way to see stories in a feed is to click the wedge next to its name in the feed list. You'll see the titles of the most recent five stories, with links to the full text. If you hover over the link to the story, the description of the story pops up. Screen shot.
54 |
55 | To see the news from all feeds you subscribe to, choose My news from the first menu.
56 |
57 | ### The 250-feed limit
58 |
59 | You can import a feed list from other services, in the Subscribe sub-menu of the first menu, but it's important that you know there's a limit of 250 new feeds per user.
60 |
61 | A new feed is one that no one else is subscribed to. So if you're clicking a checkbox in someone else's feed list, that won't count against your 250 feed limit.
62 |
63 | And at some point we will provide a way to purchase more subscriptions if you run up against the limit.
64 |
65 | ### Nothing is hidden
66 |
67 | Something important about FeedLand. Almost everything is open to everyone. I can see your feed list and you can see mine. I can read the news as you see it and vice versa.
68 |
69 | Obviously only you can sign in as you, that much is secret. But everythiung else is open.
70 |
71 | BTW, you can browse the feeds other users subscribe to, and read the news from those feeds.
72 |
73 | You can only subscribe to feeds if you're signed in.
74 |
75 | ### Exploring, getting help
76 |
77 | Check out the other docs pages to explore the product in more depth. (Links to be added.)
78 |
79 | If you have questions about how to use the product, post an issue in this group.
80 |
81 | asdf
82 |
83 |
--------------------------------------------------------------------------------
/docs/goingdeeper.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | Getting started
4 |
5 | I am running a FeedLand server at feedland.org. There's a small group of people that formed the start of the community. There's room for more, but over time I expect we'll encourage people to start their own communities. I expect the server software will ultimately be available with an open source license.
6 |
7 | How do I use it?
8 |
9 | To get started, log in at feedland.org with your Twitter account. We're just using it for identity, so we have a name for you that's different from everyone else's name.
10 |
11 | Add some feeds to your list by browsing the hotlist, my subscription list, or choose the Add a few feeds command in the Tools menu.
12 |
13 | Once you've done that, let's focus on the heart of the app, your Feed List page.
14 |
15 | Reading feeds
16 |
17 | FeedLand has two basic ways to read the content of feeds -- the river and mailbox views.
18 |
19 | Here's a simple way to compare them. First go to the Feed Info page for Scripting News, my blog.
20 |
21 | When you're viewing a Feed Info page a new menu appears, the View menu, with two choices enabled -- View as river and View as mailbox.
22 |
23 | I've included screen shots below to give an idea. There are benefits to each of the views. At this writing (October 2022) the mailbox view still could use a lot of features, I have focused on the river view. I hope to get some time to add the features soon.
24 |
25 |
http://products.scripting.com/?template=http://urloftemplatefile/
66 |
67 | ### Demo
68 |
69 | The best way to understand is to look at an example of a news product in an outline.
70 |
71 | Here's an OPML file that specifies a news product. Open it in an outliner that understands OPML to use it as a starting point for your news product.
72 |
73 | Here's a link to product.scripting.com that previews this news product.
74 |
75 | And here's the product as deployed on scripting.com.
76 |
77 | And a screen shot of what the demo should look like.
78 |
79 | ### Specifying tabs
80 |
81 | A tab displays the news from a collection of feeds in reverse-chronogic order. They're kind of like blogs but with news from RSS feeds. We also call them rivers of news or just rivers.
82 |
83 | There are three ways to specify the feeds whose items are displayed in the tab.
84 |
85 | As a category.
86 |
87 | As a list of feeds in the outline.
88 |
89 | As an outline include of an OPML subscription list.
90 |
91 | We use all three approaches in the demo setup.
92 |
93 | ### The html section
94 |
95 | In this section of the outline, you can completely re-design the part of the HTML file that products.scripting.com generates that contains the information on the page. You might want to do this if you are including the news product in a site, and have it look like it's part of that site.
96 |
97 | Here's an example of an outline file that has an html section.
98 |
99 | If you completely expand the html section, this is what you'll see.
100 |
101 | You can completely change the HTML here as long as the top element is of class divNewsProduct.
102 |
103 | There are macros pre-defined that allow you to pick up values set elsewhere in the template.
104 |
105 | The news river will be inserted underneath the object whose id is idRiverContent.
106 |
107 | ### Notes
108 |
109 | You should be subscribed to a feed in FeedLand for it to be referenced in a tab. If no one is subscribed to the feed, then no news items will appear for it, because FeedLand won't check it if no one is subscribed.
110 |
111 | You can create a header at the top of the page of your news product by setting the title, description, and image head-level attributes in the outline. Screen shot.
112 |
113 | You can use includes in your outline.
114 |
115 | ### Questions?
116 |
117 | Here's a thread specifically for help with News Products.
118 |
119 |
--------------------------------------------------------------------------------
/docs/readingnews.md:
--------------------------------------------------------------------------------
1 | # Reading news in FeedLand
2 |
3 | From reading earlier docs, you know how to manage feeds, subscribe and unsubscribe, and find a few recent items in the feed list. Now we get into reading news.
4 |
5 | In FeedLand we have timelines, which are also called rivers, that show you the latest from feeds you've subscribed to, in reverse-chronologic order, ie newest first.
6 |
7 | These timesline work like the ones in social media apps. Each item has links that allow you to Like an item, or pass a link on to other readers through a feed, or directly to social media apps like Bluesky and Mastodon, view an item on its own page for easier reading, bookmark it, get technical info about an item, or if it has an enclosure, listen to it as a podcast.
8 |
9 | As with other pages in FeedLand, there are lots of useful tool tips and mouse clicks.
10 |
11 |