Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
saturnflyer committed Nov 17, 2009
1 parent 0cf4fb1 commit cbd5641
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 3 deletions.
20 changes: 20 additions & 0 deletions HELP.md
@@ -0,0 +1,20 @@
This provides some simple tags to output content related to the pages authors and the pages siblings (other pages with
the same parent page).

## Extras

You will have the ability to edit a user's bio for display on your site. This is a block of text (which you may
filter with Textile, Markdown, or any filter you have installed) which will be output by the <r:author:bio /> tag.

## Radius Tags

The default <r:author /> tag in Radiant displays the current page's creator's name. This extension overrides it
to allow you to output more details such as <r:author:email /> or "<r:author> Email <r:name /> at <r:email />"
Tags are provided for looping through authors (<r:authors:each />)

You'll also be able to list the pages created by the current author with `<r:pages:each><r:title /></r:pages:each>`.

You'll have tags to output links to other pages near the current page in the page hierarchy. For example, this will
link to the previous page:

<r:siblings:previous><r:link /></r:siblings:previous>
11 changes: 11 additions & 0 deletions HELP_admin.md
@@ -0,0 +1,11 @@
If you have [Dashboard](http://ext.radiantcms.org/extensions/40-dashboard) installed you'll have links to
create a new blog post there. This is a convenience link in the case that the Radiant link to add a child
page to your blog is buried somewhere in your page tree. This means that you can go to the Dashboard instead
of hunting through your page tree to add a new blog post.

You may set a default location for your blog posts with `Radiant::Config['blog.location.default'] = '/company/blog'`
(the appropriate location on your website).

You may also configure a blog location for each user with `Radiant::Config['blog.location.configurable?'] = 'true'`.
This will allow you to edit a user's details with a blog location such as "/blog/jim", "/blog/amy", "/blog/tech",
"/writing/things", or whatever may be appropriate for your site.
9 changes: 6 additions & 3 deletions README
@@ -1,10 +1,13 @@
= Blog

The Blog extension has been built to provide support for commonly used features of
web logs. It is a conglomeration of multiple extensions and new features.
web logs.

Some features from:
Some features were pulled from and added to the Siblings Tags extension:
git://github.com/nelstrom/radiant-sibling-tags-extension.git

Built by Saturn Flyer http://www.saturnflyer.com and many others
Supported by Ignite Social Media http://www.ignitesocialmedia.com
Supported by Ignite Social Media http://www.ignitesocialmedia.com

TODO:
- create an AuthorIndexPage and an AuthorPage to easily list authors and their related details

0 comments on commit cbd5641

Please sign in to comment.