Permalink
Browse files

documentation updates

  • Loading branch information...
1 parent 007475b commit 1106163051ce873195e6a0b61289f71a656fb9f9 @jomz committed Oct 26, 2008
Showing with 24 additions and 5 deletions.
  1. +1 −0 HELP.md
  2. +2 −1 HELP_admin.md
  3. +21 −4 README
View
@@ -42,6 +42,7 @@ You can grab a collection of pages with a certain tag like so;
Which would iterate over all the resulting pages, like you do with children:each.
When you define scope, only this page and any of it's (grand)children will be used.
+Using scope="current_page" will use the page that is currently being rendered as scope.
You can also set limit, offset etc like with children:each.
Using r:tagged in it's default setting searches for pages that have all of the given tags.
View
@@ -26,4 +26,5 @@ after creating your tags.
== Tag Clouds
Some styles are provided in tags.css for the <r:tag_cloud>. To use it, add this to your layout:
- <link rel="stylesheet" type="text/css" href="/stylesheets/tags.css" />
+
+ <link rel="stylesheet" type="text/css" href="/stylesheets/tags.css" />
View
25 README
@@ -4,18 +4,35 @@ Created by: Keith Bingman - keithbingman.com
Revived by: Benny Degezelle - gorilla-webdesign.be
New features by: Jim Gay - saturnflyer.com
Version: 0.2
-Contact: benny AT gorilla-webdesign DOT be
This extension enhances the page model with tagging capabilities, tagging as in "2.0" and tagclouds.
== Requirements
-This extension depends on the shards extension and the has_many_polymorphs plugin (included in the extension)
-Shards should be installed and loaded first; you can change the load order of extensions in config/environment.rb (see http://wiki.radiantcms.org/Using_the_Shards_Extension).
+This extension depends on the has_many_polymorphs plugin (included in vendor/plugins)
+If you're still on Radiant pre-0.6.7, then the shards_extension should be installed and loaded first.
+You can change the load order of extensions in config/environment.rb (see http://wiki.radiantcms.org/Using_the_Shards_Extension).
== Installation
1. Copy the extension to your vendor/extensions directory as you would any other extension.
2. Run 'rake radiant:extensions:tags:install'
3. Make a page to sit in /search/by-tag, and give it the "Tag Search" pagetype.
- If you want to change this location, it's in Radiant::Config['tags.results_page_url'].
+ If you want to change this location, it's in Radiant::Config['tags.results_page_url'].
+
+Done!
+Here's a sample results page to get you started;
+
+ <r:search:empty>
+ <h2>I couldn't find anything tagged with "<r:search:query/>".</h2>
+ </r:search:empty>
+
+ <r:search:results>
+ <h2>Found the following pages that are tagged with "<em><r:search:query/></em>".</h2>
+
+ <ul>
+ <r:search:results:each>
+ <li><r:link/> - <r:author/> - <r:date/></li>
+ </r:search:results:each>
+ </ul>
+ </r:search:results>

0 comments on commit 1106163

Please sign in to comment.