Start Help Book.

This commit is contained in:
Brent Simmons 2019-05-16 21:31:19 -07:00
parent 970b7535dc
commit 95809fc4a0
4 changed files with 40 additions and 0 deletions

View File

@ -0,0 +1,7 @@
# About the NetNewsWire 5 Help Book
The Help book goes here. Text files go at the top level, and images go in the images directory.
Text files are markdown files. A script ([wildcat](https://github.com/brentsimmons/wildcat)) will turn this into a web site that will appear at [https://ranchero.com/netnewswire/help/5.0/en/](https://ranchero.com/netnewswire/help/5.0/en/). (The /en/ directory because we hope to have localized versions.)
If youd like to write or edit the Help book, or help with screenshots, please bring it up on the [NetNewsWire Slack](https://netnewswire.slack.com/join/shared_invite/enQtNjM4MDA1MjQzMDkzLTNlNjBhOWVhYzdhYjA4ZWFhMzQ1MTUxYjU0NTE5ZGY0YzYwZWJhNjYwNTNmNTg2NjIwYWY4YzhlYzk5NmU3ZTc) group. Well coordinate there.

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@ -0,0 +1,4 @@
@title NetNewsWire 5 Help
[What is RSS? What are feeds?](what-is-rss.html)

View File

@ -0,0 +1,29 @@
@title What is RSS? What are feeds?
# What is RSS? What are feeds?
Lots of websites have news or updates of some kind.
They also have a bunch of other things — a header at the top of the page, and maybe links and ads and widgets on the left or right (or both). And then some more stuff at the bottom of the page.
Like this imaginary squished-down web page:
<img src="images/websitediagram.png" width="255" height="256" alt="Website diagram that shows the good part — where RSS comes from" />
The good part is the part in the middle — thats the part with the news. Thats the part that you read. Thats the part youre interested in.
<p>And thats what RSS is — its just that part, minus the rest of the stuff.
#### Details
That “good part” is actually made available as a *feed.* A feed is just a specially-formatted text file that readers like NetNewsWire can read. The files look weird — they kind of look like the source behind web pages, with angle brackets and everything.
The important thing is: its NetNewsWires job to know how to read the feed. And its NetNewsWires job to show you what articles you havent read yet.
By doing this — by running NetNewsWire — you can let NetNewsWire find out when theres something new. You dont have to go to the websites and check to see if theres something new. You can save time, and not have to rely on your memory.
#### Types of feeds
People often talk or write about RSS — but sometimes they mention Atom, too. Atom does the same thing as RSS. Sometimes they mention the JSON Feed format, which does the same thing as RSS too.
If you see RSS or Atom or JSON Feed, just know that NetNewsWire handles all these, no problem.