rails 4.0.13 → 4.1.0.beta1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of rails might be problematic. Click here for more details.

Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -15
  3. data/guides/CHANGELOG.md +5 -74
  4. data/guides/assets/images/edge_badge.png +0 -0
  5. data/guides/assets/images/feature_tile.gif +0 -0
  6. data/guides/assets/images/footer_tile.gif +0 -0
  7. data/guides/assets/images/fxn.png +0 -0
  8. data/guides/assets/images/getting_started/challenge.png +0 -0
  9. data/guides/assets/images/getting_started/forbidden_attributes_for_new_post.png +0 -0
  10. data/guides/assets/images/getting_started/new_post.png +0 -0
  11. data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
  12. data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
  13. data/guides/assets/images/getting_started/template_is_missing_posts_new.png +0 -0
  14. data/guides/assets/images/getting_started/unknown_action_create_for_posts.png +0 -0
  15. data/guides/assets/images/getting_started/unknown_action_new_for_posts.png +0 -0
  16. data/guides/assets/images/header_tile.gif +0 -0
  17. data/guides/assets/images/icons/README +1 -1
  18. data/guides/assets/images/icons/callouts/11.png +0 -0
  19. data/guides/assets/images/icons/callouts/12.png +0 -0
  20. data/guides/assets/images/icons/callouts/13.png +0 -0
  21. data/guides/assets/images/icons/callouts/15.png +0 -0
  22. data/guides/assets/images/icons/caution.png +0 -0
  23. data/guides/assets/images/icons/example.png +0 -0
  24. data/guides/assets/images/radar.png +0 -0
  25. data/guides/assets/images/rails4_features.png +0 -0
  26. data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
  27. data/guides/assets/images/vijaydev.jpg +0 -0
  28. data/guides/assets/javascripts/guides.js +30 -34
  29. data/guides/assets/stylesheets/main.css +2 -1
  30. data/guides/assets/stylesheets/print.css +1 -1
  31. data/guides/bug_report_templates/action_controller_gem.rb +2 -0
  32. data/guides/bug_report_templates/action_controller_master.rb +2 -0
  33. data/guides/bug_report_templates/active_record_gem.rb +1 -1
  34. data/guides/bug_report_templates/active_record_master.rb +2 -1
  35. data/guides/code/getting_started/Gemfile +1 -1
  36. data/guides/code/getting_started/app/assets/javascripts/application.js +1 -2
  37. data/guides/code/getting_started/config/environments/development.rb +1 -1
  38. data/guides/code/getting_started/public/404.html +2 -0
  39. data/guides/code/getting_started/public/422.html +2 -0
  40. data/guides/code/getting_started/public/500.html +2 -0
  41. data/guides/rails_guides/helpers.rb +1 -1
  42. data/guides/source/2_2_release_notes.md +2 -2
  43. data/guides/source/2_3_release_notes.md +8 -8
  44. data/guides/source/3_0_release_notes.md +1 -2
  45. data/guides/source/3_1_release_notes.md +1 -1
  46. data/guides/source/3_2_release_notes.md +12 -12
  47. data/guides/source/4_0_release_notes.md +79 -46
  48. data/guides/source/4_1_release_notes.md +601 -0
  49. data/guides/source/_welcome.html.erb +1 -1
  50. data/guides/source/action_controller_overview.md +117 -31
  51. data/guides/source/action_mailer_basics.md +19 -19
  52. data/guides/source/action_view_overview.md +131 -12
  53. data/guides/source/active_model_basics.md +6 -6
  54. data/guides/source/active_record_basics.md +15 -15
  55. data/guides/source/active_record_callbacks.md +18 -16
  56. data/guides/source/active_record_querying.md +67 -39
  57. data/guides/source/active_record_validations.md +31 -31
  58. data/guides/source/active_support_core_extensions.md +63 -74
  59. data/guides/source/active_support_instrumentation.md +13 -4
  60. data/guides/source/api_documentation_guidelines.md +19 -5
  61. data/guides/source/asset_pipeline.md +544 -249
  62. data/guides/source/association_basics.md +81 -22
  63. data/guides/source/caching_with_rails.md +15 -6
  64. data/guides/source/command_line.md +28 -19
  65. data/guides/source/configuring.md +98 -50
  66. data/guides/source/contributing_to_ruby_on_rails.md +11 -11
  67. data/guides/source/credits.html.erb +2 -2
  68. data/guides/source/debugging_rails_applications.md +36 -5
  69. data/guides/source/development_dependencies_install.md +89 -8
  70. data/guides/source/documents.yaml +7 -1
  71. data/guides/source/engines.md +648 -224
  72. data/guides/source/form_helpers.md +56 -45
  73. data/guides/source/generators.md +7 -3
  74. data/guides/source/getting_started.md +379 -164
  75. data/guides/source/i18n.md +59 -23
  76. data/guides/source/index.html.erb +1 -1
  77. data/guides/source/initialization.md +153 -56
  78. data/guides/source/kindle/toc.html.erb +1 -1
  79. data/guides/source/layout.html.erb +3 -3
  80. data/guides/source/layouts_and_rendering.md +12 -11
  81. data/guides/source/maintenance_policy.md +4 -23
  82. data/guides/source/migrations.md +41 -37
  83. data/guides/source/nested_model_forms.md +3 -3
  84. data/guides/source/plugins.md +27 -23
  85. data/guides/source/rails_application_templates.md +25 -6
  86. data/guides/source/rails_on_rack.md +35 -51
  87. data/guides/source/routing.md +108 -99
  88. data/guides/source/ruby_on_rails_guides_guidelines.md +2 -2
  89. data/guides/source/security.md +33 -31
  90. data/guides/source/testing.md +37 -34
  91. data/guides/source/upgrading_ruby_on_rails.md +335 -16
  92. data/guides/source/working_with_javascript_in_rails.md +18 -10
  93. metadata +66 -39
  94. data/guides/assets/images/jaimeiniesta.jpg +0 -0
  95. data/guides/source/kindle/KINDLE.md +0 -26
@@ -169,7 +169,7 @@ This will generate the following HTML:
169
169
  </form>
170
170
  ```
171
171
 
172
- Note the `data-remote='true'`. Now, the form will be submitted by Ajax rather
172
+ Note the `data-remote="true"`. Now, the form will be submitted by Ajax rather
173
173
  than by the browser's normal submit mechanism.
174
174
 
175
175
  You probably don't want to just sit there with a filled out `<form>`, though.
@@ -185,7 +185,7 @@ $(document).ready ->
185
185
  ```
186
186
 
187
187
  Obviously, you'll want to be a bit more sophisticated than that, but it's a
188
- start.
188
+ start. You can see more about the events [in the jquery-ujs wiki](https://github.com/rails/jquery-ujs/wiki/ajax).
189
189
 
190
190
  ### form_tag
191
191
 
@@ -194,7 +194,17 @@ is very similar to `form_for`. It has a `:remote` option that you can use like
194
194
  this:
195
195
 
196
196
  ```erb
197
- <%= form_tag('/posts', remote: true) %>
197
+ <%= form_tag('/posts', remote: true) do %>
198
+ ...
199
+ <% end %>
200
+ ```
201
+
202
+ This will generate the following HTML:
203
+
204
+ ```html
205
+ <form accept-charset="UTF-8" action="/posts" data-remote="true" method="post">
206
+ ...
207
+ </form>
198
208
  ```
199
209
 
200
210
  Everything else is the same as `form_for`. See its documentation for full
@@ -278,9 +288,7 @@ The index view (`app/views/users/index.html.erb`) contains:
278
288
  <b>Users</b>
279
289
 
280
290
  <ul id="users">
281
- <% @users.each do |user| %>
282
- <%= render user %>
283
- <% end %>
291
+ <%= render @users %>
284
292
  </ul>
285
293
 
286
294
  <br>
@@ -301,10 +309,10 @@ The `app/views/users/_user.html.erb` partial contains the following:
301
309
  The top portion of the index page displays the users. The bottom portion
302
310
  provides a form to create a new user.
303
311
 
304
- The bottom form will call the create action on the Users controller. Because
312
+ The bottom form will call the `create` action on the `UsersController`. Because
305
313
  the form's remote option is set to true, the request will be posted to the
306
- users controller as an Ajax request, looking for JavaScript. In order to
307
- service that request, the create action of your controller would look like
314
+ `UsersController` as an Ajax request, looking for JavaScript. In order to
315
+ serve that request, the `create` action of your controller would look like
308
316
  this:
309
317
 
310
318
  ```ruby
@@ -394,4 +402,4 @@ Here are some helpful links to help you learn even more:
394
402
  * [jquery-ujs list of external articles](https://github.com/rails/jquery-ujs/wiki/External-articles)
395
403
  * [Rails 3 Remote Links and Forms: A Definitive Guide](http://www.alfajango.com/blog/rails-3-remote-links-and-forms/)
396
404
  * [Railscasts: Unobtrusive JavaScript](http://railscasts.com/episodes/205-unobtrusive-javascript)
397
- * [Railscasts: Turbolinks](http://railscasts.com/episodes/390-turbolinks)
405
+ * [Railscasts: Turbolinks](http://railscasts.com/episodes/390-turbolinks)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.13
4
+ version: 4.1.0.beta1
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Heinemeier Hansson
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-01-06 00:00:00.000000000 Z
11
+ date: 2013-12-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport
@@ -16,104 +16,132 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 4.0.13
19
+ version: 4.1.0.beta1
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 4.0.13
26
+ version: 4.1.0.beta1
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: actionpack
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 4.0.13
33
+ version: 4.1.0.beta1
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '='
39
39
  - !ruby/object:Gem::Version
40
- version: 4.0.13
40
+ version: 4.1.0.beta1
41
+ - !ruby/object:Gem::Dependency
42
+ name: actionview
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '='
46
+ - !ruby/object:Gem::Version
47
+ version: 4.1.0.beta1
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '='
53
+ - !ruby/object:Gem::Version
54
+ version: 4.1.0.beta1
55
+ - !ruby/object:Gem::Dependency
56
+ name: activemodel
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '='
60
+ - !ruby/object:Gem::Version
61
+ version: 4.1.0.beta1
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '='
67
+ - !ruby/object:Gem::Version
68
+ version: 4.1.0.beta1
41
69
  - !ruby/object:Gem::Dependency
42
70
  name: activerecord
43
71
  requirement: !ruby/object:Gem::Requirement
44
72
  requirements:
45
73
  - - '='
46
74
  - !ruby/object:Gem::Version
47
- version: 4.0.13
75
+ version: 4.1.0.beta1
48
76
  type: :runtime
49
77
  prerelease: false
50
78
  version_requirements: !ruby/object:Gem::Requirement
51
79
  requirements:
52
80
  - - '='
53
81
  - !ruby/object:Gem::Version
54
- version: 4.0.13
82
+ version: 4.1.0.beta1
55
83
  - !ruby/object:Gem::Dependency
56
84
  name: actionmailer
57
85
  requirement: !ruby/object:Gem::Requirement
58
86
  requirements:
59
87
  - - '='
60
88
  - !ruby/object:Gem::Version
61
- version: 4.0.13
89
+ version: 4.1.0.beta1
62
90
  type: :runtime
63
91
  prerelease: false
64
92
  version_requirements: !ruby/object:Gem::Requirement
65
93
  requirements:
66
94
  - - '='
67
95
  - !ruby/object:Gem::Version
68
- version: 4.0.13
96
+ version: 4.1.0.beta1
69
97
  - !ruby/object:Gem::Dependency
70
98
  name: railties
71
99
  requirement: !ruby/object:Gem::Requirement
72
100
  requirements:
73
101
  - - '='
74
102
  - !ruby/object:Gem::Version
75
- version: 4.0.13
103
+ version: 4.1.0.beta1
76
104
  type: :runtime
77
105
  prerelease: false
78
106
  version_requirements: !ruby/object:Gem::Requirement
79
107
  requirements:
80
108
  - - '='
81
109
  - !ruby/object:Gem::Version
82
- version: 4.0.13
110
+ version: 4.1.0.beta1
83
111
  - !ruby/object:Gem::Dependency
84
112
  name: bundler
85
113
  requirement: !ruby/object:Gem::Requirement
86
114
  requirements:
87
- - - ">="
115
+ - - '>='
88
116
  - !ruby/object:Gem::Version
89
117
  version: 1.3.0
90
- - - "<"
118
+ - - <
91
119
  - !ruby/object:Gem::Version
92
120
  version: '2.0'
93
121
  type: :runtime
94
122
  prerelease: false
95
123
  version_requirements: !ruby/object:Gem::Requirement
96
124
  requirements:
97
- - - ">="
125
+ - - '>='
98
126
  - !ruby/object:Gem::Version
99
127
  version: 1.3.0
100
- - - "<"
128
+ - - <
101
129
  - !ruby/object:Gem::Version
102
130
  version: '2.0'
103
131
  - !ruby/object:Gem::Dependency
104
132
  name: sprockets-rails
105
133
  requirement: !ruby/object:Gem::Requirement
106
134
  requirements:
107
- - - "~>"
135
+ - - ~>
108
136
  - !ruby/object:Gem::Version
109
- version: '2.0'
137
+ version: 2.0.0
110
138
  type: :runtime
111
139
  prerelease: false
112
140
  version_requirements: !ruby/object:Gem::Requirement
113
141
  requirements:
114
- - - "~>"
142
+ - - ~>
115
143
  - !ruby/object:Gem::Version
116
- version: '2.0'
144
+ version: 2.0.0
117
145
  description: Ruby on Rails is a full-stack web framework optimized for programmer
118
146
  happiness and sustainable productivity. It encourages beautiful code by favoring
119
147
  convention over configuration.
@@ -123,8 +151,6 @@ extensions: []
123
151
  extra_rdoc_files: []
124
152
  files:
125
153
  - README.md
126
- - guides/CHANGELOG.md
127
- - guides/Rakefile
128
154
  - guides/assets/images/akshaysurve.jpg
129
155
  - guides/assets/images/belongs_to.png
130
156
  - guides/assets/images/book_icon.gif
@@ -167,7 +193,6 @@ files:
167
193
  - guides/assets/images/i18n/demo_translated_pirate.png
168
194
  - guides/assets/images/i18n/demo_translation_missing.png
169
195
  - guides/assets/images/i18n/demo_untranslated.png
170
- - guides/assets/images/icons/README
171
196
  - guides/assets/images/icons/callouts/1.png
172
197
  - guides/assets/images/icons/callouts/10.png
173
198
  - guides/assets/images/icons/callouts/11.png
@@ -190,10 +215,10 @@ files:
190
215
  - guides/assets/images/icons/next.png
191
216
  - guides/assets/images/icons/note.png
192
217
  - guides/assets/images/icons/prev.png
218
+ - guides/assets/images/icons/README
193
219
  - guides/assets/images/icons/tip.png
194
220
  - guides/assets/images/icons/up.png
195
221
  - guides/assets/images/icons/warning.png
196
- - guides/assets/images/jaimeiniesta.jpg
197
222
  - guides/assets/images/nav_arrow.gif
198
223
  - guides/assets/images/oscardelben.jpg
199
224
  - guides/assets/images/polymorphic.png
@@ -213,20 +238,20 @@ files:
213
238
  - guides/assets/javascripts/guides.js
214
239
  - guides/assets/javascripts/jquery.min.js
215
240
  - guides/assets/javascripts/responsive-tables.js
216
- - guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js
217
241
  - guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js
242
+ - guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js
218
243
  - guides/assets/javascripts/syntaxhighlighter/shBrushBash.js
219
- - guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js
220
244
  - guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js
221
245
  - guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js
246
+ - guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js
222
247
  - guides/assets/javascripts/syntaxhighlighter/shBrushCss.js
223
248
  - guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js
224
249
  - guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js
225
250
  - guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js
226
251
  - guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js
227
- - guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js
228
252
  - guides/assets/javascripts/syntaxhighlighter/shBrushJava.js
229
253
  - guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js
254
+ - guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js
230
255
  - guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js
231
256
  - guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js
232
257
  - guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js
@@ -262,16 +287,13 @@ files:
262
287
  - guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css
263
288
  - guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css
264
289
  - guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css
265
- - guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css
266
290
  - guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css
291
+ - guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css
267
292
  - guides/bug_report_templates/action_controller_gem.rb
268
293
  - guides/bug_report_templates/action_controller_master.rb
269
294
  - guides/bug_report_templates/active_record_gem.rb
270
295
  - guides/bug_report_templates/active_record_master.rb
271
- - guides/code/getting_started/Gemfile
272
- - guides/code/getting_started/Gemfile.lock
273
- - guides/code/getting_started/README.rdoc
274
- - guides/code/getting_started/Rakefile
296
+ - guides/CHANGELOG.md
275
297
  - guides/code/getting_started/app/assets/javascripts/application.js
276
298
  - guides/code/getting_started/app/assets/javascripts/comments.js.coffee
277
299
  - guides/code/getting_started/app/assets/javascripts/posts.js.coffee
@@ -302,7 +324,6 @@ files:
302
324
  - guides/code/getting_started/bin/bundle
303
325
  - guides/code/getting_started/bin/rails
304
326
  - guides/code/getting_started/bin/rake
305
- - guides/code/getting_started/config.ru
306
327
  - guides/code/getting_started/config/application.rb
307
328
  - guides/code/getting_started/config/boot.rb
308
329
  - guides/code/getting_started/config/database.yml
@@ -320,15 +341,20 @@ files:
320
341
  - guides/code/getting_started/config/initializers/wrap_parameters.rb
321
342
  - guides/code/getting_started/config/locales/en.yml
322
343
  - guides/code/getting_started/config/routes.rb
344
+ - guides/code/getting_started/config.ru
323
345
  - guides/code/getting_started/db/migrate/20130122042648_create_posts.rb
324
346
  - guides/code/getting_started/db/migrate/20130122045842_create_comments.rb
325
347
  - guides/code/getting_started/db/schema.rb
326
348
  - guides/code/getting_started/db/seeds.rb
349
+ - guides/code/getting_started/Gemfile
350
+ - guides/code/getting_started/Gemfile.lock
327
351
  - guides/code/getting_started/public/404.html
328
352
  - guides/code/getting_started/public/422.html
329
353
  - guides/code/getting_started/public/500.html
330
354
  - guides/code/getting_started/public/favicon.ico
331
355
  - guides/code/getting_started/public/robots.txt
356
+ - guides/code/getting_started/Rakefile
357
+ - guides/code/getting_started/README.rdoc
332
358
  - guides/code/getting_started/test/controllers/comments_controller_test.rb
333
359
  - guides/code/getting_started/test/controllers/posts_controller_test.rb
334
360
  - guides/code/getting_started/test/controllers/welcome_controller_test.rb
@@ -340,20 +366,22 @@ files:
340
366
  - guides/code/getting_started/test/models/comment_test.rb
341
367
  - guides/code/getting_started/test/models/post_test.rb
342
368
  - guides/code/getting_started/test/test_helper.rb
343
- - guides/rails_guides.rb
344
369
  - guides/rails_guides/generator.rb
345
370
  - guides/rails_guides/helpers.rb
346
371
  - guides/rails_guides/indexer.rb
347
372
  - guides/rails_guides/kindle.rb
348
373
  - guides/rails_guides/levenshtein.rb
349
- - guides/rails_guides/markdown.rb
350
374
  - guides/rails_guides/markdown/renderer.rb
375
+ - guides/rails_guides/markdown.rb
376
+ - guides/rails_guides.rb
377
+ - guides/Rakefile
351
378
  - guides/source/2_2_release_notes.md
352
379
  - guides/source/2_3_release_notes.md
353
380
  - guides/source/3_0_release_notes.md
354
381
  - guides/source/3_1_release_notes.md
355
382
  - guides/source/3_2_release_notes.md
356
383
  - guides/source/4_0_release_notes.md
384
+ - guides/source/4_1_release_notes.md
357
385
  - guides/source/_license.html.erb
358
386
  - guides/source/_welcome.html.erb
359
387
  - guides/source/action_controller_overview.md
@@ -384,7 +412,6 @@ files:
384
412
  - guides/source/i18n.md
385
413
  - guides/source/index.html.erb
386
414
  - guides/source/initialization.md
387
- - guides/source/kindle/KINDLE.md
388
415
  - guides/source/kindle/copyright.html.erb
389
416
  - guides/source/kindle/layout.html.erb
390
417
  - guides/source/kindle/rails_guides.opf.erb
@@ -416,17 +443,17 @@ require_paths:
416
443
  - lib
417
444
  required_ruby_version: !ruby/object:Gem::Requirement
418
445
  requirements:
419
- - - ">="
446
+ - - '>='
420
447
  - !ruby/object:Gem::Version
421
448
  version: 1.9.3
422
449
  required_rubygems_version: !ruby/object:Gem::Requirement
423
450
  requirements:
424
- - - ">="
451
+ - - '>='
425
452
  - !ruby/object:Gem::Version
426
453
  version: 1.8.11
427
454
  requirements: []
428
455
  rubyforge_project:
429
- rubygems_version: 2.4.5
456
+ rubygems_version: 2.1.11
430
457
  signing_key:
431
458
  specification_version: 4
432
459
  summary: Full-stack web application framework.
@@ -1,26 +0,0 @@
1
- # Rails Guides on the Kindle
2
-
3
-
4
- ## Synopsis
5
-
6
- 1. Obtain `kindlegen` from the link below and put the binary in your path
7
- 2. Run `KINDLE=1 rake generate_guides` to generate the guides and compile the `.mobi` file
8
- 3. Copy `output/kindle/rails_guides.mobi` to your Kindle
9
-
10
- ## Resources
11
-
12
- * [Stack Overflow: Kindle Periodical Format](http://stackoverflow.com/questions/5379565/kindle-periodical-format)
13
- * Example Periodical [.ncx](https://gist.github.com/mipearson/808c971ed087b839d462) and [.opf](https://gist.github.com/mipearson/d6349aa8488eca2ee6d0)
14
- * [Kindle Publishing Guidelines](http://kindlegen.s3.amazonaws.com/AmazonKindlePublishingGuidelines.pdf)
15
- * [KindleGen & Kindle Previewer](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621)
16
-
17
- ## TODO
18
-
19
- ### Post release
20
-
21
- * Integrate generated Kindle document into published HTML guides
22
- * Tweak heading styles (most docs use h3/h4/h5, which end up being smaller than the text under it)
23
- * Tweak table styles (smaller text? Many of the tables are unusable on a Kindle in portrait mode)
24
- * Have the HTML/XML TOC 'drill down' into the TOCs of the individual guides
25
- * `.epub` generation.
26
-