adding some docs for us

Oleg committed Aug 19, 2010

commit 6f8e4f665257a7d7b0083d4381bffb183dc73094

Showing 3 changed files with 160 additions and 5 deletions

Gemfile +3 -3

@@	@@ -26,6 +26,6 @@ gem 'haml'
	# Bundle gems for the local environment. Make sure to
	# put test-only gems in this group so their generators
	# and rake tasks are available in development mode:
-	group :test do
-	gem 'shoulda'
-	end
+	# group :test do
+	# gem 'shoulda'
+	# end

Gemfile.lock +75 -0

@@	@@ -0,0 +1,75 @@
+	GEM
+	remote: http://rubygems.org/
+	specs:
+	abstract (1.0.0)
+	actionmailer (3.0.0.rc)
+	actionpack (= 3.0.0.rc)
+	mail (~> 2.2.5)
+	actionpack (3.0.0.rc)
+	activemodel (= 3.0.0.rc)
+	activesupport (= 3.0.0.rc)
+	builder (~> 2.1.2)
+	erubis (~> 2.6.6)
+	i18n (~> 0.4.1)
+	rack (~> 1.2.1)
+	rack-mount (~> 0.6.9)
+	rack-test (~> 0.5.4)
+	tzinfo (~> 0.3.22)
+	activemodel (3.0.0.rc)
+	activesupport (= 3.0.0.rc)
+	builder (~> 2.1.2)
+	i18n (~> 0.4.1)
+	activerecord (3.0.0.rc)
+	activemodel (= 3.0.0.rc)
+	activesupport (= 3.0.0.rc)
+	arel (~> 0.4.0)
+	tzinfo (~> 0.3.22)
+	activeresource (3.0.0.rc)
+	activemodel (= 3.0.0.rc)
+	activesupport (= 3.0.0.rc)
+	activesupport (3.0.0.rc)
+	arel (0.4.0)
+	activesupport (>= 3.0.0.beta)
+	builder (2.1.2)
+	erubis (2.6.6)
+	abstract (>= 1.0.0)
+	haml (3.0.15)
+	i18n (0.4.1)
+	mail (2.2.5)
+	activesupport (>= 2.3.6)
+	mime-types
+	treetop (>= 1.4.5)
+	mime-types (1.16)
+	polyglot (0.3.1)
+	rack (1.2.1)
+	rack-mount (0.6.9)
+	rack (>= 1.0.0)
+	rack-test (0.5.4)
+	rack (>= 1.0)
+	rails (3.0.0.rc)
+	actionmailer (= 3.0.0.rc)
+	actionpack (= 3.0.0.rc)
+	activerecord (= 3.0.0.rc)
+	activeresource (= 3.0.0.rc)
+	activesupport (= 3.0.0.rc)
+	bundler (>= 1.0.0.rc.1)
+	railties (= 3.0.0.rc)
+	railties (3.0.0.rc)
+	actionpack (= 3.0.0.rc)
+	activesupport (= 3.0.0.rc)
+	rake (>= 0.8.3)
+	thor (~> 0.14.0)
+	rake (0.8.7)
+	sqlite3-ruby (1.2.5)
+	thor (0.14.0)
+	treetop (1.4.8)
+	polyglot (>= 0.3.1)
+	tzinfo (0.3.22)
+
+	PLATFORMS
+	ruby
+
+	DEPENDENCIES
+	haml
+	rails (= 3.0.0.rc)
+	sqlite3-ruby

doc/README_FOR_APP +82 -2

@@	@@ -1,2 +1,82 @@
-	Use this README file to introduce your application and point to useful places in the API for learning more.
-	Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.
+	:type can be 'string', 'text', ('rich_text', 'datetime')
+
+	{{ cms:page:default }}
+
+	{{ cms:page:label:type }} # page content that gets rendered
+	{{ cms:field:label:type }} # page content that not rendered, but accessible via @cms_page object
+	{{ cms:snippet:label }} # snippet content that gets rendered
+	{{ cms:partial:path }} # interface to Rails partial
+
+	??? pages need to be aware of tags inside of them
+
+
+	MAYBE: allow html escaping based on tag definition
+
+
+	Example:
+	--------
+	parent layout:
+
+	{{ cms:field:css }}
+	{{ cms:field:meta_keywords }}
+	{{ cms:field:google_tracking }}
+
+	{{ cms:page:header }}
+	{{ cms:page:content }} <- child layout content goes here
+	{{ cms:page:footer }}
+
+	child layout
+
+	{{ cms:page:left }}
+	{{ cms:page:image:file }}
+	{{ cms:page:right }}
+
+
+	Repeatable partials:
+	--------------------
+
+	{{ cms:group:person:blah }}
+	{{ cms:group:car:something }}
+	{{ cms:group:person:meh }}
+
+
+	-- Person ---
+	Blah: [ ]
+	Meh: [ ]
+	+ add more person
+
+	-- Car ---
+	Something: [ ]
+	+ add more car
+
+
+	File Upload Field
+	-----------------
+	{{ cms:page:avatar:file }}
+	!!! this allows uploading of files and attaches them to an Asset system. Content stores ID of the asset.
+
+
+	{{ cms:group:person:face:file }} <- this will make many files, how to link???
+	{{ cms:group:person:name }}
+
+
+	STI?? [ merging CmsTag class with CmsPageContent AR class ]
+	-----------------------------------------------------------
+
+	CmsPageContent <- generic old 'cms_block'
+	CmsPageStringContent
+	CmsPageTextContent
+	CmsPageFileContent ???
+	CmsGroupContent
+
+	CmsFieldStringContent < CmsPageContent
+
+
+	IRB Escaping
+	------------
+	{{ cms:partial:blsh}} -> "<%= render blah %>" <-------- this is OK
+	<%= blah %> <-------- this is NOT OK
+
+
+	Can run irb escaping after pages and snippets are expanded.
+	Partials are injected later and should not be escaped.
	\ No newline at end of file