Issue #1137096: Document admin_title and admin_description in export.html.
authorEarl Miles
Thu, 14 Jul 2011 21:05:58 +0000 (14:05 -0700)
committerEarl Miles
Thu, 14 Jul 2011 21:05:58 +0000 (14:05 -0700)
help/export.html

index 9b7350e..234ef15 100644 (file)
@@ -117,6 +117,12 @@ function mymodule_schema() {
 <dt>object factory</dt>
 <dd>Function used to create the object. The function receives the schema and the loaded data as a parameters: your_factory_function($schema, $data). If this is set,  'object' has no effect since you can use your function to create whatever class you wish.</dd>
 
+<dt>admin_title</dt>
+<dd>A convenience field that may contain the field which represents the human readable administrative title for use in export UI. If a field "admin_title" exists, it will automatically be used.</dd>
+
+<dt>admin_description</dt>
+<dd>A convenience field that may contain the field which represents the human readable administrative title for use in export UI. If a field "admin_title" exists, it will automatically be used.</dd>
+
 <dt>can disable</dt>
 <dd>Control whether or not the exportable objects can be disabled. All this does is cause the 'disabled' field on the object to always be set appropriately, and a variable is kept to record the state. Changes made to this state must be handled by the owner of the object. Defaults to TRUE.</dd>
 
@@ -146,7 +152,7 @@ function mymodule_schema() {
 
 <dt>to hook code callback</dt>
 <dd>Function used to generate an export for the bulk export process. This is only necessary if the export is more complicated than simply listing the fields. Defaults to $module . '_' . $table . '_to_hook_code'.</dt>
-</dl>
+
 
 <dt>create callback</dt>
 <dd>CRUD callback to use to create a new exportable item in memory. If not provided, the default function will be used. The single argument is a boolean used to determine if defaults should be set on the object. This object will not be written to the database by this callback.</dd>
@@ -189,6 +195,8 @@ api supports these subkeys:
 <dd>The current version of the API. Any module reporting a required API higher than this will not have its default objects used.</dd>
 </dl>
 </dd>
+
+</dl>
 In addition, each field can contain the following:
 <dl>
 <dt>no export</dt>