Improving documentation for AJAX Example

Looking forward to your patch! This is a community project, and your participation is very welcome.

Thanks,
-Randy

@threewestwinds, in case it's useful as you get your patch together, the ajax_example module grew out of the material at http://randyfay.com/ajax (and before that http://randyfay.com/ahah).

The related handbook page (which I believe is referenced in the code) is http://drupal.org/node/752056.

Thanks for your effort on this!
-Randy

Remember that this documentation is used to create the api.drupal.org examples, so has to generate good api.d.o docs.

Since you're kind enough to take this on, please take a look at http://drupal.org/coding-standards and http://drupal.org/node/1354 if you haven't already.

+++ ajax_example/ajax_example.module	6 Dec 2010 04:40:13 -0000
@@ -13,7 +13,7 @@
+ * @link ajax/7 AJAX Framework documentation @endlink and at the

Why is the /7 tacked on?

+++ ajax_example/ajax_example.module	6 Dec 2010 04:40:13 -0000
@@ -91,24 +98,8 @@ function ajax_example_menu() {
-  $items['examples/ajax_example/dynamic_sections'] = array(
-    'title' => 'Dynamic Sections (with graceful degradation)',
-    'page callback' => 'drupal_get_form',
-    'page arguments' => array('ajax_example_dynamic_sections'),
-    'access callback' => TRUE,
-    'weight' => 6,
-    'file' => 'ajax_example_graceful_degradation.inc',
-  );
-  $items['ajax_example/dynamic_sections_no_js'] = array(
-    'title' => 'Dynamic Sections w/JS turned off',
-    'page callback' => 'drupal_get_form',
-    'page arguments' => array('ajax_example_dynamic_sections', TRUE),
-    'access callback' => TRUE,
-    'weight' => 6,
-    'file' => 'ajax_example_graceful_degradation.inc',
-  );
-
-

I probably don't want to remove these. They're one of the best and easiest graceful degradation examples.

+++ ajax_example/ajax_example.module	6 Dec 2010 04:40:13 -0000
@@ -134,6 +128,7 @@ function ajax_example_menu() {
+  // The above example as it appears to users with no javascript

Use periods at the end of sentences in comments.

+++ ajax_example/ajax_example.module	6 Dec 2010 04:40:13 -0000
@@ -13,7 +13,7 @@
+ * @link ajax/7 AJAX Framework documentation @endlink and at the

@@ -91,24 +98,8 @@ function ajax_example_menu() {
-  $items['examples/ajax_example/dynamic_sections'] = array(
-    'title' => 'Dynamic Sections (with graceful degradation)',
-    'page callback' => 'drupal_get_form',
-    'page arguments' => array('ajax_example_dynamic_sections'),
-    'access callback' => TRUE,
-    'weight' => 6,
-    'file' => 'ajax_example_graceful_degradation.inc',
-  );
-  $items['ajax_example/dynamic_sections_no_js'] = array(
-    'title' => 'Dynamic Sections w/JS turned off',
-    'page callback' => 'drupal_get_form',
-    'page arguments' => array('ajax_example_dynamic_sections', TRUE),
-    'access callback' => TRUE,
-    'weight' => 6,
-    'file' => 'ajax_example_graceful_degradation.inc',
-  );

Thanks so much for your effort on this!

Powered by Dreditor.

The dependent dropdown is a fundamental thing that people copy and paste all the time. Sorry :-)

A lot of people use these examples not to learn, but just as starter code, so the wizard-like code and the dependent dropdown can be quite useful.

Since the AJAX example is D7, it automatically should link to D7. If not, it's probably a new API module bug.

I do see that http://api.drupal.org/api/examples/ajax_example--ajax_example.module/gro... is not rendering correctly, and hope we can get that fixed in this round, but adding ajax/7 isn't the right way to do it, since it's the group name we're referring to.

http://api.drupal.org/api/drupal/includes--ajax.inc/group/ajax/7 is the destination we wanted, which is group defined in ajax.inc. http://api.drupal.org/api/drupal/includes--ajax.inc/7/source

I filed #990108: Links and search do not make sense and are not working across projects about the issue you discovered. Nice work :-)

AJAX Example predates Form Example. If it didn't, though, it would be part of form example. Do you think long-term we should be figuring out how to put it in there?

Thanks for the great work. When you post a patch, setting it to "Needs review" makes it obvious that it needs review, and also runs the automated tests.

Thanks,
-Randy

Committed with some small changes. http://drupal.org/cvs?commit=463840 (changes are attached in the .txt file)

Thanks so much for the thoughtful work here, @threewestwinds. You are welcome anywhere in Examples. (Hoping you'll have many other learning experiences to take on :-)

(won't let me attach my patch or diff here, so I'll try in the next comment)

Here are the files. I was able to attach successfully when turning off javascript.

Well, it got one of the files. Here's the patch I committed.

When you do that much work, you can't see what you did any more. You *have* to have somebody else look at it :-)

The most important fixes to functional things were that drupal_add_library() call and some doxy links that were incorrect (we'll *see* if I got them right :-)

Thanks for the work on this!