major documentation review. changed format to markdown to support scr…

…eenshots and better formatting

.yardopts

@@ -16,15 +16,16 @@ vendor/plugins/resources/**/*.rb
 vendor/plugins/themes/**/*.rb
 -
 readme.md
-vendor/plugins/themes/themes.rdoc
-vendor/plugins/refinery/plugins.rdoc
-vendor/plugins/refinery/crud.rdoc
-vendor/plugins/pages/pages.rdoc
-vendor/plugins/images/images.rdoc
-vendor/plugins/authentication/authentication.rdoc
-vendor/plugins/dashboard/dashboard.rdoc
-vendor/plugins/inquiries/inquiries.rdoc
-vendor/plugins/news/news.rdoc
-vendor/plugins/resources/resources.rdoc
-license.rdoc
-contributors.rdoc
+vendor/plugins/themes/themes.md
+vendor/plugins/refinery/plugins.md
+vendor/plugins/refinery/crud.md
+vendor/plugins/pages/pages.md
+vendor/plugins/images/images.md
+vendor/plugins/authentication/authentication.md
+vendor/plugins/dashboard/dashboard.md
+vendor/plugins/inquiries/inquiries.md
+vendor/plugins/news/news.md
+vendor/plugins/resources/resources.md
+vendor/plugins/resources/settings.md
+license.md
+contributors.md

Rakefile

@@ -36,7 +36,7 @@ begin
     s.email = %q{[email protected]}
     s.homepage = %q{http://refinerycms.com}
     s.authors = ["Resolve Digital", "David Jones", "Philip Arndt"]
-    s.extra_rdoc_files = %w(readme.md contributors.rdoc license.rdoc VERSION)
+    s.extra_rdoc_files = %w(readme.md contributors.md license.md VERSION)
     s.rdoc_options << "--inline-source"
     s.has_rdoc = true
   end

bin/refinery

@@ -18,7 +18,7 @@ unless (app_path = ARGV.shift).nil? or app_path.length == 0
     FileUtils::makedirs RAILS_ROOT
 
     # copy in all of the relevant directories and root files.
-    to_copy = %w(app config db lib public script themes contributors.rdoc license.rdoc Rakefile readme.md VERSION).map do |dir|
+    to_copy = %w(app config db lib public script themes contributors.md license.md Rakefile readme.md VERSION).map do |dir|
       File.join REFINERY_ROOT, dir
     end
     FileUtils::cp_r to_copy, RAILS_ROOT, :verbose => false

contributors.md

@@ -0,0 +1,18 @@
+# Contributors
+
+## Major
+
+* parndt - Philip Arndt, [Resolve Digital](http://www.resolvedigital.co.nz)
+* djones - [David Jones](http://www.d-jones.com), [Resolve Digital](http://www.resolvedigital.co.nz)
+
+## Minor
+
+* ryanwood - [Ryan Wood](http://www.ryanwood.com)
+* hernan - Hernan Fernandez
+* btucker - [Ben Tucker](http://btucker.net)
+* avit - [Andrew Vit](http://avit.ca)
+* stevenheidel - [Steven Heidel](http://www.livingskywebdesign.com)
+* moretea - Maarten Hoogendoorn
+* csessions - [Chris Sessions](http://www.flying-saucer.net)
+
+Want your name here? Help us out in anyway you can. And don't be so scared, we don't expect your code to be perfect the first time round.

license.rdoc → license.md

@@ -1,6 +1,6 @@
-== MIT License
+# MIT License
 
-Copyright (c) 2005-2009 Resolve Digital Ltd. www.resolvedigital.co.nz
+Copyright (c) 2005-2010 [Resolve Digital Ltd.](http://www.resolvedigital.co.nz)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

readme.md

@@ -22,6 +22,7 @@ Refinery makes it easy to:
 * Get a small business site up and running __ridiculously quickly__
 * __Theme and customise__ the look to suit the business
 * __Extend with custom plugins__ to do anything Refinery doesn't do out of the box
+* Tries to stick to __"the Rails way"__ as much as possible
 
 ## Requirements
 
@@ -83,6 +84,7 @@ You will be prompted to setup your first user.
 * [Google Group Discussion](http://groups.google.com/group/refinery-cms)
 * [Developer/API documentation](http://api.refinerycms.org)
 * [Developer video - 26 mins](http://refinerycms.com/pages/for-developers)
+* [IRC Channel](irc://irc.freenode.net/refinerycms)
 
 ## Setting Up on Heroku
 

vendor/plugins/authentication/authentication.md

@@ -0,0 +1,7 @@
+# Authentication
+
+## About
+
+At the heart of Refinery's user management is the authentication plugin located in ``vendor/plugins/authentication``
+
+What this really is is just a standard [RESTFul authentication](http://github.com/technoweenie/restful-authentication) install extended with a few extra features like "I forgot my password" and hooked directly into the heart of Refinery's plugin system.

vendor/plugins/dashboard/dashboard.rdoc → vendor/plugins/dashboard/dashboard.md

@@ -1,19 +1,21 @@
-= Dashboard
+# Dashboard
 
-== About
+![Refinery Dashboard](http://refinerycms.com/system/images/0000/0576/dashboard.png)
+
+## About
 
 Refinery's dashboard is a plugin that does two simple things
 
 * Reports recent activity on all the core plugins
 * Provides convenient links to common tasks.
 
-== How do I hook my custom plugin into the recent activity log?
+## How do I hook my custom plugin into the recent activity log?
 
 Read in plugins.rdoc the section titled "Getting your plugin to report activity in the dashboard"
 
-== Related Settings
+## Related Settings
 
-=== "Activity Show Limit"
+### "Activity Show Limit"
 
 This allows you to specify how many items should show up in your recent activity list.
 

vendor/plugins/images/images.md

@@ -0,0 +1,46 @@
+# Images
+
+![Refinery Images](http://refinerycms.com/system/images/0000/0616/images.png)
+
+## About
+
+All Refinery's images are stored in one place, the images plugin. This plugin: 
+
+* Reports recent activity on all the core plugins
+* Provides convenient links to common tasks.
+
+## Generating Thumbnails
+
+Refinery lets you generate a range of thumbnails when an image is uploaded so you can output this on a page in an appropriate size.
+
+To specify the sizes of your thumbnails edit the "Image Thumbnails" setting.
+
+This setting is stored as a serialize hash and is directly passed to attachment_fu
+
+Here's what the default looks like
+
+    --- 
+    :grid: c135x135
+    :lightbox: 500x500>
+    :dialog_thumb: c106x106
+    :medium: 225x255
+    :preview: c96x96
+    :thumb: 50x50
+    :side_body: 300x500
+
+Refinery requires some of these so you won't want to delete any, but add new ones to meet your design needs. Each thumbnail is not just a size guide but a RMagick geometry string that allows you to define min and max size too.
+
+Refinery also extends the geometry string support to allow cropping. Here's some examples
+
+    :grid: c135x135
+
+This will crop (_that's what the "c" stands for_) the image down to ``135x135`` exactly without stretching the image.
+
+_Note: you will have to restart your web server after changing this setting for the changes to take effect._
+
+## Related Settings
+
+### "Preferred Image View"
+
+Set to ``"grid"`` to get your images to display as a grid of thumbnails
+Set to ``"list"`` to get your images to display as a list with image titles.

vendor/plugins/inquiries/inquiries.rdoc → vendor/plugins/inquiries/inquiries.md

@@ -1,14 +1,16 @@
-= Inquiries
+# Inquiries
 
-== About
+![Refinery Inquiries](http://refinerycms.com/system/images/0000/0626/inquiries.png)
+
+## About
 
 Refinery gives you a simple contact form that notifies you and the customer when an inquiry is made.
 
-In summary you can
+In summary you can:
 
 * Collect and manage inquiries
 * Specify who is notified when a new inquiry comes in
-* Customise auto responder email that is sent to the person making the inquiry
+* Customise an auto responder email that is sent to the person making the inquiry
 
 When inquiries come in, you and the customer are notified. The inquiry will now show up as an "open" inquiry. The idea is to deal with the inquiry and then "close" it so you know it's been sorted.
 
@@ -24,6 +26,6 @@ Go into your inquiries section and click on "Edit confirmation email"
 
 Your contact form loads because you have a page in your site that is told to not just render a normal page, but load the contact form instead.
 
-By default this page is called "Contact Us". Go to your "Pages" tab and click the edit icon on "Contact Us". Now  click on "Hide/Show Advanced Options" and you'll see that a "custom URL" is set to "/inquiries/new". Simply change this to nothing, or delete the contact us page.
+By default this page is called "Contact Us". Go to your "Pages" tab and click the edit icon on "Contact Us". Now  click on "Hide/Show Advanced Options" and you'll see that a "custom URL" is set to ``/inquiries/new``. Simply change this to nothing, or delete the contact us page.
 
 You might also want to remove the Inquiries plugin from your backend view. To do that, you go to the "Users" tab edit your user, uncheck "Inquiries" from the list of plugins you can access.

vendor/plugins/news/news.rdoc → vendor/plugins/news/news.md

@@ -1,18 +1,20 @@
-= News
+# News
 
-== About
+![Refinery News](http://refinerycms.com/system/images/0000/0646/news.png)
+
+## About
 
 Refinery's news plugin allows you to post updates to the news section of your website.
 
-Key features
+Key features:
 
 * Default news page shows a summary of recent news posts
-* A detail view shows the full post and also linked to recent news on the "side bar"
+* Detail view shows the full post and also linked to recent news on the "side bar"
 
-== But I don't want a news section, how do I kill it?
+## But I don't want a news section, how do I kill it?
 
 Your news section loads because you have a page in your site that is told to not just render a normal page, but load the news section instead.
 
-By default this page is called "News". Go to your "Pages" tab and click the edit icon on "News". Now  click on "Hide/Show Advanced Options" and you'll see that a "custom URL" is set to "/news". Simply change this to nothing, or delete the "News" page.
+By default this page is called "News". Go to your "Pages" tab and click the edit icon on "News". Now  click on "Hide/Show Advanced Options" and you'll see that a "custom URL" is set to ``/news``. Simply change this to nothing, or delete the "News" page.
 
 You might also want to remove the News plugin from your backend view. To do that, you go to the "Users" tab edit your user, uncheck "News" from the list of plugins you can access.