diff options
| author | Xavier Noria <fxn@hashref.com> | 2010-12-20 20:13:34 +0100 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2010-12-20 20:13:34 +0100 |
| commit | 880f8419c41db0aea4b7cf3abd74fe5d32fa04a7 (patch) | |
| tree | 0c21b8e0829136b6fb33a136caf3085f2a78c857 /railties/guides/source/ruby_on_rails_guides_guidelines.textile | |
| parent | 0cbfd6c28d327304432f7d0c067662b5c1e41a78 (diff) | |
| parent | 6909fb6cff49e11574909b55864af8673d044eb7 (diff) | |
| download | rails-880f8419c41db0aea4b7cf3abd74fe5d32fa04a7.tar.gz rails-880f8419c41db0aea4b7cf3abd74fe5d32fa04a7.tar.bz2 rails-880f8419c41db0aea4b7cf3abd74fe5d32fa04a7.zip | |
Merge branch 'master' of git://github.com/lifo/docrails
Diffstat (limited to 'railties/guides/source/ruby_on_rails_guides_guidelines.textile')
| -rw-r--r-- | railties/guides/source/ruby_on_rails_guides_guidelines.textile | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/railties/guides/source/ruby_on_rails_guides_guidelines.textile b/railties/guides/source/ruby_on_rails_guides_guidelines.textile index 0bc409cbda..a2e830b574 100644 --- a/railties/guides/source/ruby_on_rails_guides_guidelines.textile +++ b/railties/guides/source/ruby_on_rails_guides_guidelines.textile @@ -16,7 +16,7 @@ h3. Titles The title of every guide uses +h2+, guide sections use +h3+, subsections +h4+, etc. -Capitalize all words except for internal articles, prepositions, conjuctions, and forms of the verb to be: +Capitalize all words except for internal articles, prepositions, conjunctions, and forms of the verb to be: <plain> h5. Middleware Stack is an Array @@ -48,7 +48,7 @@ To generate all the guides just cd into the +railties+ directory and execute rake generate_guides </plain> -You'll need the gems erubis, i18n, and RedCloth. +You'll need the gems erubis, i18n, and RedCloth. To process +my_guide.textile+ and nothing else use the +ONLY+ environment variable: @@ -58,7 +58,7 @@ rake generate_guides ONLY=my_guide Although by default guides that have not been modified are not processed, so +ONLY+ is rarely needed in practice. -To force process of al the guides pass +ALL=1+. +To force process of all the guides, pass +ALL=1+. It is also recommended that you work with +WARNINGS=1+, this detects duplicate IDs and warns about broken internal links. |