aboutsummaryrefslogtreecommitdiff
path: root/help.html
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2012-03-03 14:25:39 +0100
committerKevin Chabowski <kevin@kch42.de>2012-03-03 14:25:39 +0100
commit6d1ef4d36ddc545acb1d43386194eaa635c0db39 (patch)
treedf66c4015d03bf7901cf435045fd6459510d1652 /help.html
downloadatom_feed-6d1ef4d36ddc545acb1d43386194eaa635c0db39.tar.gz
atom_feed-6d1ef4d36ddc545acb1d43386194eaa635c0db39.tar.bz2
atom_feed-6d1ef4d36ddc545acb1d43386194eaa635c0db39.zip
Initial commit.
Diffstat (limited to 'help.html')
-rw-r--r--help.html20
1 files changed, 20 insertions, 0 deletions
diff --git a/help.html b/help.html
new file mode 100644
index 0000000..636783f
--- /dev/null
+++ b/help.html
@@ -0,0 +1,20 @@
+<h2>Atom Feed</h2>
+
+<p>Power up your website with some Atom Feeds!</p>
+
+<h3>Configuration</h3>
+
+<p>There are some details you can (and should) configure for your feeds.</p>
+
+<p>There is a backend page called "Atom Feed" in the Plugins menu. You can configure...</p>
+<ul>
+ <li>...the title of your feeds (should be your page's name)</li>
+ <li>...the URL path (the virtual directory of your website where the feeds live in, you usually do not have to modify this)</li>
+ <li>...Some informations about the default author (Name must be set, email and uri are optional)</li>
+ <li>...the unique ID of your feeds (you should not modify this, unless you really know what you are doing)</li>
+</ul>
+
+<h3>Embedding feeds in your template</h3>
+
+<p>This plugin will give you a new STE-Tag: <code>&lt;ste:atom_feed /&gt;</code>.</p>
+<p>Put this tag in your <code>&lt;head /&gt;</code> section and it will generate links to your feeds.</p>