trunk/guide/index.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
        "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
        <title>Reblog Users' Guide</title>
        <link rel="stylesheet" href="../softwarestyle.css" type="text/css">
</head>
<body>
    <h1>Reblog Users' Guide</h1>
    <p>$Revision: 1.2 $</p>
    <div id="toc">
        <h2>Table of Contents</h2>
        <ul>
            <li>
                <a href="#overview">Overview</a>
            </li>
            <li>
                <a href="#features">Use/Features</a>
                <ul>
                    <li>
                        <a href="#feed-list">View Feeds</a>
                    </li>
                    <li>
                        <a href="#add-feed">Add Feeds</a>
                    </li>
                    <li>
                        <a href="#item-list">View Items</a>
                    </li>
                    <li>
                        <a href="#post-item">Post Item</a>
                    </li>
                    <li>
                        <a href="#published-feed">Published Feed</a>
                    </li>
                    <li>
                        <a href="#keyboard-help">Keyboard Sensitivity</a>
                    </li>
                </ul>
            </li>
            <li>
                <a href="#license">License</a>
            </li>
        </ul>
    </div>
    <div id="contents">
        <h2><a name="overview"></a>Overview</h2>
        <p>
            Reblog is a PHP-based server-side RSS aggregator/reader that
            allows for quick, easy, iterative filtering, editing and
            re-syndicating of posts. Its output is an RSS feed that
            contains numerous metadata necessary to re-publish posts
            with appropriate attribution.
        </p>
        <p>
            Reblog is derived from a project called Feed-on-Feeds by
            Steve Minutillo
            (<a href="http://minutillo.com/steve/feedonfeeds/">minutillo.com/steve/feedonfeeds/</a>).
        </p>
        <h2><a name="features"></a>Use/Features</h2>
        <ul>
            <li>
                <p>
                    The operation of Reblog should be pretty
                    self-explanatory. Like most other news/feed readers,
                    it has a page to view all your feeds, a page to add
                    feeds, a page to view posts for one or more feeds,
                    and a viewing mode that uses frames, for easier
                    switching between feeds. We hope that these
                    functions are self-explanatory.
                </p>
                <ol>
                    <li>
                        <h3><a name="feed-list"></a>View feeds</h3>
                        <p>
                            Default view in Reblog; Accessed from "Feed
                            List" link in header on other pages.
                        </p>
                        <p>
                            <a href="img/feed-list.png" target="_blank"><img src="img/feed-list-thumb.png" width="300" height="255"></a>
                        </p>
                        <p>
                            Update feed items or unsubscribe from a feed by
                            clicking "Subscribe" tab in each feed row:
                        </p>
                        <p>
                            <a href="img/feed-edit-subscribe.png" target="_blank"><img src="img/feed-edit-subscribe-thumb.png" width="300" height="63"></a>
                        </p>
                        <p>
                            Auto-publish all future items in a feed by
                            clicking "Publish" tab:
                        </p>
                        <p>
                            <a href="img/feed-edit-publish.png" target="_blank"><img src="img/feed-edit-publish-thumb.png" width="300" height="56"></a>
                        </p>
                        <p>
                            Add tags to a feed for easier navigation by
                            clicking "Tags" tab:
                        </p>
                        <p>
                            <a href="img/feed-edit-tag.png" target="_blank"><img src="img/feed-edit-tag-thumb.png" width="300" height="72"></a>
                        </p>
                    </li>
                    <li>
                        <h3><a name="add-feed"></a>Add feeds</h3>
                        <p>
                            Accessed from "Add Feeds" link in header.
                            Subscribe to individual new feeds, or enter
                            lists of feeds from OPML listings. "Reblog
                            Subscribe" bookmarklet makes this a
                            two-click operation from most websites that
                            offer feeds.
                        </p>
                        <p>
                            <a href="img/add-feed.png" target="_blank"><img src="img/add-feed-thumb.png" width="300" height="255"></a>
                        </p>
                    </li>
                    <li>
                        <h3><a name="item-list"></a>View items</h3>
                        <p>
                            Accessed from "Item List" link in header, or
                            by clicking on the title of a feed. Items
                            can be chosen from a single feed, or based
                            on other criteria such as tag matches or
                            searches. Simply clicking "Item List"
                            results in a
                            <a href="http://www.reallysimplesyndication.com/riverOfNews" target="_blank">"River
                            of News"-style aggregator.</a>
                        </p>
                        <p>
                            Each item in the list can be archived by
                            clicking the large <strong>"A"</strong>
                            button on the left, or published by clicking
                            the large <strong>"P"</strong> button next
                            to it. Archived items no longer show up in
                            the list and are eventually culled from the
                            database entirely (depending on your
                            configuration settings), while published
                            items appear in your <a
                            href="#published-feed">outgoing published
                            feed</a>.
                        </p>
                        <p>
                            The list of items can be modified by
                            performing searches, selected tagged items,
                            choosing only new or published items, and
                            moving forward and backward through the
                            links under "Current Items".
                        </p>
                        <p>
                            <a href="img/item-list.png" target="_blank"><img src="img/item-list-thumb.png" width="300" height="255"></a>
                        </p>
                        <p>
                            Edit item content by clicking "Edit" tab.
                            Selecting a link for use in the published
                            item can also be accomplished by clicking on
                            the blue stars within the regular item view.
                        </p>
                        <p>
                            <a href="img/item-edit-content.png" target="_blank"><img src="img/item-edit-content-thumb.png" width="300" height="191"></a>
                        </p>
                        <p>
                            Add comments or tags to an item by clicking
                            "Comment/Tag" tab:
                        </p>
                        <p>
                            <a href="img/item-edit-comment.png" target="_blank"><img src="img/item-edit-comment-thumb.png" width="300" height="140"></a>
                        </p>
                    </li>
                    <li>
                        <h3><a name="post-item"></a>Post Item</h3>
                        <p>
                            Accessed from "Post New" link in header.
                            Posted items are automatically published. A
                            list of these items can be accessed from the
                            top-most feed in the <a href="#feed-list">feed
                            list</a>. "Reblog Post" bookmarklet makes it easy
                            to include content from around the web, like
                            popular social bookmarking services.
                        </p>
                        <p>
                            <a href="img/post-item.png" target="_blank"><img src="img/post-item-thumb.png" width="300" height="255"></a>
                        </p>
                    </li>
                    <li>
                        <h3><a name="published-feed"></a>Published Feed</h3>
                        <p>
                            All published items can be accessed via the
                            "Published Feed" link in the header. The URL
                            of this page can be freely-shared - it is
                            not subject to Reblog's own password
                            protection, so that outgoing feeds can be
                            subscribed to by others.
                        </p>
                        <p>
                            <a href="img/published-feed.png" target="_blank"><img src="img/published-feed-thumb.png" width="300" height="255"></a>
                        </p>
                    </li>
                    <li>
                        <h3><a name="keyboard-help"></a>Keyboard sensitivity:</h3>
                        <p>
                            Reblog is now almost entirely controllable
                            using keyboard shortcuts. Type <em>?</em> on
                            any screen to see what keyboard
                            functionality is available. If you hate it,
                            it can be disabled with a configuration flag
                            in the config file (see <a href="../INSTALL.html">INSTALL.html</a>).
                        </p>
                        <p>
                            <a href="img/keyboard-help.png" target="_blank"><img src="img/keyboard-help-thumb.png" width="300" height="255"></a>
                        </p>
                    </li>
                </ol>
            </li>
        </ul>
        <h2><a name="license"></a>License</h2>
        <p>
            Reblog is distributed under the GPL (see the <a href="../LICENSE">LICENSE</a> file), though some of its included libraries (in<code>library/</code>) are not.
        </p>
    </div>
</body>
</html>
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2	"http://www.w3.org/TR/html4/strict.dtd">
3	<html>
4	<head>
5	<title>Reblog Users' Guide</title>
6	<link rel="stylesheet" href="../softwarestyle.css" type="text/css">
7	</head>
8	<body>
9	<h1>Reblog Users' Guide</h1>
10	<p>$Revision: 1.2 $</p>
11	<div id="toc">
12	<h2>Table of Contents</h2>
13	<ul>
14	<li>
15	<a href="#overview">Overview</a>
16	</li>
17	<li>
18	<a href="#features">Use/Features</a>
19	<ul>
20	<li>
21	<a href="#feed-list">View Feeds</a>
22	</li>
23	<li>
24	<a href="#add-feed">Add Feeds</a>
25	</li>
26	<li>
27	<a href="#item-list">View Items</a>
28	</li>
29	<li>
30	<a href="#post-item">Post Item</a>
31	</li>
32	<li>
33	<a href="#published-feed">Published Feed</a>
34	</li>
35	<li>
36	<a href="#keyboard-help">Keyboard Sensitivity</a>
37	</li>
38	</ul>
39	</li>
40	<li>
41	<a href="#license">License</a>
42	</li>
43	</ul>
44	</div>
45	<div id="contents">
46	<h2><a name="overview"></a>Overview</h2>
47	<p>
48	Reblog is a PHP-based server-side RSS aggregator/reader that
49	allows for quick, easy, iterative filtering, editing and
50	re-syndicating of posts. Its output is an RSS feed that
51	contains numerous metadata necessary to re-publish posts
52	with appropriate attribution.
53	</p>
54	<p>
55	Reblog is derived from a project called Feed-on-Feeds by
56	Steve Minutillo
57	(<a href="http://minutillo.com/steve/feedonfeeds/">minutillo.com/steve/feedonfeeds/</a>).
58	</p>
59	<h2><a name="features"></a>Use/Features</h2>
60	<ul>
61	<li>
62	<p>
63	The operation of Reblog should be pretty
64	self-explanatory. Like most other news/feed readers,
65	it has a page to view all your feeds, a page to add
66	feeds, a page to view posts for one or more feeds,
67	and a viewing mode that uses frames, for easier
68	switching between feeds. We hope that these
69	functions are self-explanatory.
70	</p>
71	<ol>
72	<li>
73	<h3><a name="feed-list"></a>View feeds</h3>
74	<p>
75	Default view in Reblog; Accessed from "Feed
76	List" link in header on other pages.
77	</p>
78	<p>
79	<a href="img/feed-list.png" target="_blank"><img src="img/feed-list-thumb.png" width="300" height="255"></a>
80	</p>
81	<p>
82	Update feed items or unsubscribe from a feed by
83	clicking "Subscribe" tab in each feed row:
84	</p>
85	<p>
86	<a href="img/feed-edit-subscribe.png" target="_blank"><img src="img/feed-edit-subscribe-thumb.png" width="300" height="63"></a>
87	</p>
88	<p>
89	Auto-publish all future items in a feed by
90	clicking "Publish" tab:
91	</p>
92	<p>
93	<a href="img/feed-edit-publish.png" target="_blank"><img src="img/feed-edit-publish-thumb.png" width="300" height="56"></a>
94	</p>
95	<p>
96	Add tags to a feed for easier navigation by
97	clicking "Tags" tab:
98	</p>
99	<p>
100	<a href="img/feed-edit-tag.png" target="_blank"><img src="img/feed-edit-tag-thumb.png" width="300" height="72"></a>
101	</p>
102	</li>
103	<li>
104	<h3><a name="add-feed"></a>Add feeds</h3>
105	<p>
106	Accessed from "Add Feeds" link in header.
107	Subscribe to individual new feeds, or enter
108	lists of feeds from OPML listings. "Reblog
109	Subscribe" bookmarklet makes this a
110	two-click operation from most websites that
111	offer feeds.
112	</p>
113	<p>
114	<a href="img/add-feed.png" target="_blank"><img src="img/add-feed-thumb.png" width="300" height="255"></a>
115	</p>
116	</li>
117	<li>
118	<h3><a name="item-list"></a>View items</h3>
119	<p>
120	Accessed from "Item List" link in header, or
121	by clicking on the title of a feed. Items
122	can be chosen from a single feed, or based
123	on other criteria such as tag matches or
124	searches. Simply clicking "Item List"
125	results in a
126	<a href="http://www.reallysimplesyndication.com/riverOfNews" target="_blank">"River
127	of News"-style aggregator.</a>
128	</p>
129	<p>
130	Each item in the list can be archived by
131	clicking the large <strong>"A"</strong>
132	button on the left, or published by clicking
133	the large <strong>"P"</strong> button next
134	to it. Archived items no longer show up in
135	the list and are eventually culled from the
136	database entirely (depending on your
137	configuration settings), while published
138	items appear in your <a
139	href="#published-feed">outgoing published
140	feed</a>.
141	</p>
142	<p>
143	The list of items can be modified by
144	performing searches, selected tagged items,
145	choosing only new or published items, and
146	moving forward and backward through the
147	links under "Current Items".
148	</p>
149	<p>
150	<a href="img/item-list.png" target="_blank"><img src="img/item-list-thumb.png" width="300" height="255"></a>
151	</p>
152	<p>
153	Edit item content by clicking "Edit" tab.
154	Selecting a link for use in the published
155	item can also be accomplished by clicking on
156	the blue stars within the regular item view.
157	</p>
158	<p>
159	<a href="img/item-edit-content.png" target="_blank"><img src="img/item-edit-content-thumb.png" width="300" height="191"></a>
160	</p>
161	<p>
162	Add comments or tags to an item by clicking
163	"Comment/Tag" tab:
164	</p>
165	<p>
166	<a href="img/item-edit-comment.png" target="_blank"><img src="img/item-edit-comment-thumb.png" width="300" height="140"></a>
167	</p>
168	</li>
169	<li>
170	<h3><a name="post-item"></a>Post Item</h3>
171	<p>
172	Accessed from "Post New" link in header.
173	Posted items are automatically published. A
174	list of these items can be accessed from the
175	top-most feed in the <a href="#feed-list">feed
176	list</a>. "Reblog Post" bookmarklet makes it easy
177	to include content from around the web, like
178	popular social bookmarking services.
179	</p>
180	<p>
181	<a href="img/post-item.png" target="_blank"><img src="img/post-item-thumb.png" width="300" height="255"></a>
182	</p>
183	</li>
184	<li>
185	<h3><a name="published-feed"></a>Published Feed</h3>
186	<p>
187	All published items can be accessed via the
188	"Published Feed" link in the header. The URL
189	of this page can be freely-shared - it is
190	not subject to Reblog's own password
191	protection, so that outgoing feeds can be
192	subscribed to by others.
193	</p>
194	<p>
195	<a href="img/published-feed.png" target="_blank"><img src="img/published-feed-thumb.png" width="300" height="255"></a>
196	</p>
197	</li>
198	<li>
199	<h3><a name="keyboard-help"></a>Keyboard sensitivity:</h3>
200	<p>
201	Reblog is now almost entirely controllable
202	using keyboard shortcuts. Type <em>?</em> on
203	any screen to see what keyboard
204	functionality is available. If you hate it,
205	it can be disabled with a configuration flag
206	in the config file (see <a href="../INSTALL.html">INSTALL.html</a>).
207	</p>
208	<p>
209	<a href="img/keyboard-help.png" target="_blank"><img src="img/keyboard-help-thumb.png" width="300" height="255"></a>
210	</p>
211	</li>
212	</ol>
213	</li>
214	</ul>
215	<h2><a name="license"></a>License</h2>
216	<p>
217	Reblog is distributed under the GPL (see the <a href="../LICENSE">LICENSE</a> file), though some of its included libraries (in<code>library/</code>) are not.
218	</p>
219	</div>
220	</body>
221	</html>