| Index: trunk/extensions/SemanticForms/includes/SF_AutoeditAPI.php |
| — | — | @@ -64,7 +64,7 @@ |
| 65 | 65 | return array( |
| 66 | 66 | 'form' => 'The form to use.', |
| 67 | 67 | 'target' => 'The target page.', |
| 68 | | - 'query' => 'The query string. Format: template[parameter]=value' |
| | 68 | + 'query' => "The query string.\nFormat: template[parameter]=value\nMerge assignations using %26, i.e. template[parameter1]=value1%26template[parameter2]=value2" |
| 69 | 69 | ); |
| 70 | 70 | } |
| 71 | 71 | |
| — | — | @@ -73,10 +73,18 @@ |
| 74 | 74 | * @return mixed string or array of strings |
| 75 | 75 | */ |
| 76 | 76 | function getDescription() { |
| 77 | | - return 'This module is used to remotely create or edit pages using Semantic Forms'; |
| | 77 | + return "This module is used to remotely create or edit pages using Semantic Forms"; |
| 78 | 78 | } |
| 79 | 79 | |
| 80 | 80 | /** |
| | 81 | + * Returns usage examples for this module. |
| | 82 | + * @return mixed string or array of strings |
| | 83 | + */ |
| | 84 | + protected function getExamples() { |
| | 85 | + return 'api.php?action=sfautoedit&form=Event&target=SomeEvent&query=Event[Start]=2011/07/09%26Event[End]=2011/07/10'; |
| | 86 | + } |
| | 87 | + |
| | 88 | + /** |
| 81 | 89 | * Returns a string that identifies the version of the class. |
| 82 | 90 | * Includes the class name, the svn revision, timestamp, and |
| 83 | 91 | * last author. |