Index: modules/actions/actions.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/actions/actions.schema,v retrieving revision 1.2 diff -u -p -r1.2 actions.schema --- modules/actions/actions.schema 1 Jul 2007 15:37:08 -0000 1.2 +++ modules/actions/actions.schema 25 Aug 2007 06:43:10 -0000 @@ -3,24 +3,74 @@ function actions_schema() { $schema['actions'] = array( + 'description' => t('Stores individual actions that may be applied in the system.'), 'fields' => array( - 'aid' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => '0'), - 'type' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), - 'callback' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'parameters' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'description' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => '0'), + 'aid' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '0', + 'description' => t('Primary Key: Unique action ID.'), + ), + 'type' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The module from which the action originates; for example, node or comment.'), + ), + 'callback' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The callback function to trigger when the action fires.'), + ), + 'parameters' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('A serialized array of action parameters; used with advanced actions.'), + ), + 'description' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '0', + 'description' => t('A human-readable description of what the action does.'), + ), ), 'primary key' => array('aid'), ); $schema['actions_assignments'] = array( + 'description' => t('Maps actions to hook and operation assignments from actions.module.'), 'fields' => array( - 'hook' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), - 'op' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), - 'aid' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), + 'hook' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The name of the internal Drupal hook upon which an action is firing; for example, nodeapi.'), + ), + 'op' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The specific operation of the hook upon which an action is firing: for example, presave.'), + ), + 'aid' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t("Action's {action}.aid."), + ), 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), ), 'index keys' => array( - 'hook_op' => array('hook', 'op')) + 'hook_op' => array('hook', 'op'), + ), ); return $schema; } Index: modules/aggregator/aggregator.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/aggregator/aggregator.schema,v retrieving revision 1.3 diff -u -p -r1.3 aggregator.schema --- modules/aggregator/aggregator.schema 15 Jul 2007 10:09:21 -0000 1.3 +++ modules/aggregator/aggregator.schema 25 Aug 2007 06:43:10 -0000 @@ -3,45 +3,149 @@ function aggregator_schema() { $schema['aggregator_category'] = array( + 'description' => t('Stores categories for aggregator feeds and feed items.'), 'fields' => array( - 'cid' => array('type' => 'serial', 'not null' => TRUE), - 'title' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'description' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'block' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny') + 'cid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique aggregator category ID.'), + ), + 'title' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Title of the category.'), + ), + 'description' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Description of the category'), + ), + 'block' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('TODO: ???'), + ) ), 'primary key' => array('cid'), 'unique keys' => array('title' => array('title')), ); $schema['aggregator_category_feed'] = array( + 'description' => t('Bridge table; maps feeds to categories.'), 'fields' => array( - 'fid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'cid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0) + 'fid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The feed's {aggregator_feed}.fid.'), + ), + 'cid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {aggregator_category}.cid to which the feed is being assigned.'), + ) ), 'primary key' => array('fid', 'cid'), ); $schema['aggregator_category_item'] = array( + 'description' => t('Bridge table; maps feed items to categories.'), 'fields' => array( - 'iid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'cid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0) + 'iid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The feed item's {aggregator_feed_item}.iid.'), + ), + 'cid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {aggregator_category}.cid to which the feed item is being assigned.'), + ) ), 'primary key' => array('iid', 'cid'), ); $schema['aggregator_feed'] = array( + 'description' => t('Stores feeds to be parsed by the aggregator.'), 'fields' => array( - 'fid' => array('type' => 'serial', 'not null' => TRUE), - 'title' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'url' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'refresh' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'checked' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'link' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'description' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'image' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'etag' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'modified' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'block' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny') + 'fid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique feed ID.'), + ), + 'title' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Title of the feed.'), + ), + 'url' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('URL to the feed.'), + ), + 'refresh' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('How often to check for new feed items, in seconds.'), + ), + 'checked' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Last time feed was checked for new items, as Unix timestamp.'), + ), + 'link' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The parent website of the feed; comes from the element in the feed.'), + ), + 'description' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t("The parent website's description; comes from the element in the feed."), + ), + 'image' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('TODO: ???'), + ), + 'etag' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('TODO: ???'), + ), + 'modified' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('When the feed was last modified, as a Unix timestamp.'), + ), + 'block' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('TODO: ???'), + ) ), 'unique keys' => array( 'url' => array('url'), @@ -51,15 +155,57 @@ function aggregator_schema() { ); $schema['aggregator_item'] = array( + 'description' => t('Stores the individual items imported from feeds.'), 'fields' => array( - 'iid' => array('type' => 'serial', 'not null' => TRUE), - 'fid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'title' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'link' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'author' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'description' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'timestamp' => array('type' => 'int', 'not null' => FALSE), - 'guid' => array('type' => 'varchar', 'length' => 255, 'not null' => FALSE) + 'iid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique ID for feed item.'), + ), + 'fid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {aggregator_feed}.fid to which this item belongs.'), + ), + 'title' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Title of the feed item.'), + ), + 'link' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Link to the feed item.'), + ), + 'author' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Author of the feed item.'), + ), + 'description' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Body of the feed item.'), + ), + 'timestamp' => array( + 'type' => 'int', + 'not null' => FALSE, + 'description' => t('Post date of feed item, as a Unix timestamp.'), + ), + 'guid' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + 'description' => t('TODO: ???'), + ) ), 'indexes' => array('fid' => array('fid')), 'primary key' => array('iid'), Index: modules/block/block.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/block/block.schema,v retrieving revision 1.2 diff -u -p -r1.2 block.schema --- modules/block/block.schema 19 Aug 2007 08:08:44 -0000 1.2 +++ modules/block/block.schema 25 Aug 2007 06:43:10 -0000 @@ -3,29 +3,120 @@ function block_schema() { $schema['blocks'] = array( + 'description' => array(t('Stores block settings, such as region and visibility settings.')); 'fields' => array( - 'bid' => array('type' => 'serial', 'not null' => TRUE), - 'module' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''), - 'delta' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => '0'), - 'theme' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'status' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'region' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => 'left'), - 'custom' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'throttle' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'visibility' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'pages' => array('type' => 'text', 'not null' => TRUE), - 'title' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''), - 'cache' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), + 'bid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique block ID.'), + ), + 'module' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t("The module from which the block originates; for example, 'user' for the Who's Online block, and 'block' for any custom blocks."), + ), + 'delta' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '0', + 'description' => t('Unique ID for block within a module.'), + ), + 'theme' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The theme under which the block settings apply.'), + ), + 'status' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Block enabled status. (1 = enabled, 0 = disabled)'), + ), + 'weight' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Block weight within region.'), + ), + 'region' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => 'left', + 'description' => t('Theme region within which the block is set.'), + ), + 'custom' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Flag to indicate how users may control visibility of the block. (0 = Users cannot control, 1 = On by default, but can be hidden, 2 = Hidden by default, but can be shown)'), + ), + 'throttle' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Flag to indicate whether or not to remove block when website traffic is high. (1 = throttle, 0 = do not throttle)'), + ), + 'visibility' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Flag to indicate how to show blocks on pages. (0 = Show on all pages except listed pages, 1 = Show only on listed pages, 2 = Use custom PHP code to determine visibility)'), + ), + 'pages' => array( + 'type' => 'text', + 'not null' => TRUE, + 'description' => t('Contents of the "Pages" block; contain either a list of paths on which to include/exlclude the block or PHP code, depending on "visibility" setting.'), + ), + 'title' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Custom title for the block. (Empty string will use block default title, will remove the title, text will cause block to use specified title.)'), + ), + 'cache' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Binary flag to indicate block cache mode. (-1: Do not cache, 1: Cache per role, 2: Cache per user, 4: Cache per page, 8: Block cache global) See BLOCK_CACHE_* constants in block.module for more detailed information.'), + ), ), 'primary key' => array('bid'), ); $schema['blocks_roles'] = array( + 'description' => t('Sets up access permissions for blocks based on user roles'), 'fields' => array( - 'module' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE), - 'delta' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE), - 'rid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE) + 'module' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'description' => t("The block's origin module, from {blocks}.module."), + ), + 'delta' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'description' => t("The block's unique delta within module, from {blocks}.delta."), + ), + 'rid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => t("The user's role ID from {user_roles}.rid."), + ), ), 'primary key' => array( 'module', @@ -35,11 +126,33 @@ function block_schema() { ); $schema['boxes'] = array( + 'description' => t('Stores contents of custom-made blocks.'), 'fields' => array( - 'bid' => array('type' => 'serial', 'not null' => TRUE), - 'body' => array('type' => 'text', 'not null' => FALSE, 'size' => 'big'), - 'info' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - 'format' => array('type' => 'int', 'size' => 'small', 'not null' => TRUE, 'default' => 0) + 'bid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t("The block's {block}.bid."), + ), + 'body' => array( + 'type' => 'text', + 'not null' => FALSE, + 'size' => 'big', + 'description' => t('Block contents.'), + ), + 'info' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Block description.'), + ), + 'format' => array( + 'type' => 'int', + 'size' => 'small', + 'not null' => TRUE, + 'default' => 0, + 'description' => t("Block body's {filter_formats}.format; for example, 1 = Filtered HTML."), + ) ), 'unique keys' => array('info' => array('info')), 'primary key' => array('bid'), Index: modules/book/book.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/book/book.schema,v retrieving revision 1.2 diff -u -p -r1.2 book.schema --- modules/book/book.schema 30 Jul 2007 18:20:21 -0000 1.2 +++ modules/book/book.schema 25 Aug 2007 06:43:10 -0000 @@ -3,10 +3,29 @@ function book_schema() { $schema['book'] = array( + 'description' => t('Stores book outline information.'), 'fields' => array( - 'mlid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), - 'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), - 'bid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), + 'mlid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The book page's {menu_links}.mlid."), + ), + 'nid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The book page's {node}.nid."), + ), + 'bid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The book page's parent {book}.nid."), + ), ), 'indexes' => array( 'nid' => array('nid'), Index: modules/comment/comment.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/comment/comment.schema,v retrieving revision 1.4 diff -u -p -r1.4 comment.schema --- modules/comment/comment.schema 30 Jul 2007 21:27:34 -0000 1.4 +++ modules/comment/comment.schema 25 Aug 2007 06:43:10 -0000 @@ -3,21 +3,96 @@ function comment_schema() { $schema['comments'] = array( + 'description' => t('Stores comments and associated data.'), 'fields' => array( - 'cid' => array('type' => 'serial', 'not null' => TRUE), - 'pid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'nid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'uid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'subject' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''), - 'comment' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'hostname' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - 'timestamp' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'status' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'format' => array('type' => 'int', 'size' => 'small', 'not null' => TRUE, 'default' => 0), - 'thread' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE), - 'name' => array('type' => 'varchar', 'length' => 60, 'not null' => FALSE), - 'mail' => array('type' => 'varchar', 'length' => 64, 'not null' => FALSE), - 'homepage' => array('type' => 'varchar', 'length' => 255, 'not null' => FALSE) + 'cid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique comment ID.'), + ), + 'pid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {comment}.cid to which this comment is a reply. If set to 0, this comment is not a reply to an existing comment.'), + ), + 'nid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {node}.nid to which this comment is a reply.'), + ), + 'uid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {user}.uid who authored the comment. If set to 0, this comment was created by an anonymous user.'), + ), + 'subject' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The comment title.'), + ), + 'comment' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('The comment body.'), + ), + 'hostname' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t("The author's host name."), + ), + 'timestamp' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The time that the comment was created, as a Unix timestamp.'), + ), + 'status' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('The published status of a comment. (0 = Published, 1 = Not Published)'), + ), + 'format' => array( + 'type' => 'int', + 'size' => 'small', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {filter_formats}.format of the comment body.'), + ), + 'thread' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'description' => t("The vancode representation of the comment's place in a thread."), + ), + 'name' => array( + 'type' => 'varchar', + 'length' => 60, + 'not null' => FALSE, + 'description' => t("The comment author's name. Uses {user}.name if the user is logged in, otherwise uses the value typed into the comment form."), + ), + 'mail' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => FALSE, + 'description' => t("The comment author's e-mail address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on."), + ), + 'homepage' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + 'description' => t("The comment author's home page address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on."), + ) ), 'indexes' => array( 'nid' => array('nid'), @@ -27,12 +102,39 @@ function comment_schema() { ); $schema['node_comment_statistics'] = array( + 'description' => t('Maintains statistics of node and comments posts to show "new" and "updated" flags.'), 'fields' => array( - 'nid' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), - 'last_comment_timestamp' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'last_comment_name' => array('type' => 'varchar', 'length' => 60, 'not null' => FALSE), - 'last_comment_uid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'comment_count' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0) + 'nid' => array( + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => t('The {node}.nid for which the statistics are compiled.'), + ), + 'last_comment_timestamp' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The Unix timestamp of the last comment that was posted within this node, from {comment}.timestamp.'), + ), + 'last_comment_name' => array( + 'type' => 'varchar', + 'length' => 60, + 'not null' => FALSE, + 'description' => t('The name of the latest author to post a comment on this node, from {comment}.author.'), + ), + 'last_comment_uid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The user ID of the latest author to post a comment on this node, from {comment}.uid.'), + ), + 'comment_count' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The total number of comments on this node.'), + ), ), 'indexes' => array('node_comment_timestamp' => array('last_comment_timestamp')), 'primary key' => array('nid'), Index: modules/contact/contact.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/contact/contact.schema,v retrieving revision 1.3 diff -u -p -r1.3 contact.schema --- modules/contact/contact.schema 15 Jul 2007 10:09:21 -0000 1.3 +++ modules/contact/contact.schema 25 Aug 2007 06:43:10 -0000 @@ -3,13 +3,47 @@ function contact_schema() { $schema['contact'] = array( + 'description' => t('Contact form category settings.'), 'fields' => array( - 'cid' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), - 'category' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'recipients' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'reply' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'selected' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny') + 'cid' => array( + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => t('Primary Key: Unique category ID.'), + ), + 'category' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Category name.'), + ), + 'recipients' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Comma-separated list of recipient e-mail addresses.'), + ), + 'reply' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Text of the auto-reply message.'), + ), + 'weight' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t("The category's weight."), + ), + 'selected' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Flag to indicate whether or not category is selected by default. (1 = Yes, 0 = No)'), + ), ), 'unique keys' => array('category' => array('category')), 'primary key' => array('cid'), Index: modules/dblog/dblog.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/dblog/dblog.schema,v retrieving revision 1.3 diff -u -p -r1.3 dblog.schema --- modules/dblog/dblog.schema 28 Jul 2007 07:11:14 -0000 1.3 +++ modules/dblog/dblog.schema 25 Aug 2007 06:43:10 -0000 @@ -3,18 +3,78 @@ function dblog_schema() { $schema['watchdog'] = array( + 'description' => t('Table that contains logs of all system events.'), 'fields' => array( - 'wid' => array('type' => 'serial', 'not null' => TRUE), - 'uid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'type' => array('type' => 'varchar', 'length' => 16, 'not null' => TRUE, 'default' => ''), - 'message' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'variables' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'severity' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'link' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'location' => array('type' => 'text', 'not null' => TRUE), - 'referer' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - 'hostname' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - 'timestamp' => array('type' => 'int', 'not null' => TRUE, 'default' => 0) + 'wid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique watchdog event ID.'), + ), + 'uid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {user}.uid of the user who triggered the event.'), + ), + 'type' => array( + 'type' => 'varchar', + 'length' => 16, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Type of log message, for example "user" or "page not found."'), + ), + 'message' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Text of log message to be passed into the t() function.'), + ), + 'variables' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Serialized array of variables that match the message string and that is passed into the t() function.'), + ), + 'severity' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('The severity level of the event; ranges from 0 (Emergency) to 7 (Debug)'), + ), + 'link' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Link to view the result of the event.'), + ), + 'location' => array( + 'type' => 'text', + 'not null' => TRUE, + 'description' => t('URL of the origin of the event.'), + ), + 'referer' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('URL of referring page.'), + ), + 'hostname' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Hostname of the user who triggered the event.'), + ), + 'timestamp' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Unix timestamp of when event occurred.'), + ), ), 'primary key' => array('wid'), 'indexes' => array('type' => array('type')), Index: modules/drupal/drupal.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/drupal/drupal.schema,v retrieving revision 1.1 diff -u -p -r1.1 drupal.schema --- modules/drupal/drupal.schema 25 May 2007 12:46:44 -0000 1.1 +++ modules/drupal/drupal.schema 25 Aug 2007 06:43:10 -0000 @@ -3,27 +3,105 @@ function drupal_schema() { $schema['client'] = array( + 'description' => t('Lists details of all client sites that use this affiliate site for distributed logins.'), 'fields' => array( - 'cid' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE), - 'link' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'name' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - 'mail' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - 'slogan' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'mission' => array('type' => 'text', 'not null' => TRUE, 'size' => 'big'), - 'users' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'nodes' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'version' => array('type' => 'varchar', 'length' => 35, 'not null' => TRUE, 'default' => ''), - 'created' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'changed' => array('type' => 'int', 'not null' => TRUE, 'default' => 0) + 'cid' => array( + 'type' => 'serial', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'description' => t('Primary Key: Unique client ID.'), + ), + 'link' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Link to client site.'), + ), + 'name' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Name of client site.'), + ), + 'mail' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Client site admin e-mail address.'), + ), + 'slogan' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Client site slogan.'), + ), + 'mission' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('Client site mission statement.'), + ), + 'users' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Number of users in client site.'), + ), + 'nodes' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Number of nodes in client site.'), + ), + 'version' => array( + 'type' => 'varchar', + 'length' => 35, + 'not null' => TRUE, + 'default' => '', + 'description' => t('What Drupal version client site is running.'), + ), + 'created' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('When the client site was created, as Unix timestamp.'), + ), + 'changed' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Date client site was last modified, as Unix timestamp.'), + ), ), 'primary key' => array('cid'), ); $schema['client_system'] = array( + 'description' => t('What components are installed on the client site.'), 'fields' => array( - 'cid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'type' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => '') + 'cid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Foreign key: The client site {client}.cid.'), + ), + 'name' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The name of the component ("blog" or "garland").'), + ), + 'type' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The type of component ("module" or "theme").'), + ), ), 'primary key' => array('cid', 'name'), ); Index: modules/filter/filter.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/filter/filter.schema,v retrieving revision 1.1 diff -u -p -r1.1 filter.schema --- modules/filter/filter.schema 25 May 2007 12:46:44 -0000 1.1 +++ modules/filter/filter.schema 25 Aug 2007 06:43:11 -0000 @@ -3,22 +3,73 @@ function filter_schema() { $schema['filters'] = array( + 'description' => t('Table that maps filters (HTML corrector) to input formats (Filtered HTML).'), 'fields' => array( - 'fid' => array('type' => 'serial', 'not null' => TRUE), - 'format' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - 'module' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''), - 'delta' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'), - 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny') + 'fid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Auto-incrementing filter ID.'), + ), + 'format' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Foreign Key: The {filter_formats}.fid to which this filter is assigned.'), + ), + 'module' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The origin module of the filter.'), + ), + 'delta' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('ID to identify which filter within module is being referenced.'), + ), + 'weight' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny' + 'description' => t('Weight of filter within format.'), + ) ), 'primary key' => array('fid'), 'indexes' => array('weight' => array('weight')), ); $schema['filter_formats'] = array( + 'description' => t('Stores input formats: custom groupings of filters, such as Filtered HTML.'), 'fields' => array( - 'format' => array('type' => 'serial', 'not null' => TRUE), - 'name' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'roles' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'cache' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny') + 'format' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique ID for format.'), + ), + 'name' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Name of the input format (Filtered HTML).'), + ), + 'roles' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('A comma-separated string of roles; references {role}.rid.'), + ), + 'cache' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('Flag to indicate whether format is cachable. (1 = cachable, 0 = not cachable)'), + ), ), 'unique keys' => array('name' => array('name')), 'primary key' => array('format'), Index: modules/locale/locale.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/locale/locale.schema,v retrieving revision 1.5 diff -u -p -r1.5 locale.schema --- modules/locale/locale.schema 2 Jul 2007 14:41:36 -0000 1.5 +++ modules/locale/locale.schema 25 Aug 2007 06:43:11 -0000 @@ -3,43 +3,113 @@ function locale_schema() { $schema['languages'] = array( + 'description' => t('List of all available languages in the system.'), 'fields' => array( - // Language code, eg 'de' or 'en-US'. - 'language' => array('type' => 'varchar', 'length' => 12, 'not null' => TRUE, 'default' => ''), - // Language name in English. - 'name' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''), - // Native language name. - 'native' => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''), - // LANGUAGE_RTL or LANGUAGE_LTR - 'direction' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - // Enabled flag. - 'enabled' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - // Number of plural indexes in this language. - 'plurals' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - // Plural formula in PHP code to evaluate to get plural indexes. - 'formula' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - // Domain to use for this language. - 'domain' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - // Path prefix to use for this language. - 'prefix' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''), - // Weight, used in lists of languages. - 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - // Location of JavaScript translation file. - 'javascript' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''), + 'language' => array( + 'type' => 'varchar', + 'length' => 12, + 'not null' => TRUE, + 'default' => '', + 'description' => t("Language code, eg 'de' or 'en-US'."), + ), + 'name' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Language name in English.'), + ), + 'native' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Native language name.'), + ), + 'direction' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Direction of language (Left-to-Right = 0, Right-to-Left = 1).'), + ), + 'enabled' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Enabled flag (1 = Enabled, 0 = Disabled).'), + ), + 'plurals' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Number of plural indexes in this language.'), + ), + 'formula' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Plural formula in PHP code to evaluate to get plural indexes.'), + ), + 'domain' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Domain to use for this language.'), + ), + 'prefix' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Path prefix to use for this language.'), + ), + 'weight' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Weight, used in lists of languages.'), + ), + 'javascript' => array( + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Location of JavaScript translation file.'), + ), ), 'primary key' => array('language'), ); $schema['locales_source'] = array( + 'description' => t('List of English source strings.'), 'fields' => array( - // Unique identifier of this string. - 'lid' => array('type' => 'serial', 'not null' => TRUE), - // Drupal path in case of online discovered translations or file path in case of imported strings. - 'location' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - // A module defined group of translations, see hook_locale(). - 'textgroup' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - // The original string in English. - 'source' => array('type' => 'text', 'mysql_type' => 'blob', 'not null' => TRUE), + 'lid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Unique identifier of this string.'), + ), + 'location' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Drupal path in case of online discovered translations or file path in case of imported strings.'), + ), + 'textgroup' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('A module defined group of translations, see hook_locale().'), + ), + 'source' => array( + 'type' => 'text', + 'mysql_type' => 'blob', + 'not null' => TRUE, + 'description' => t('The original string in English.'), + ), ), 'primary key' => array('lid'), 'indexes' => array @@ -47,17 +117,39 @@ function locale_schema() { ); $schema['locales_target'] = array( + 'description' => t('Stores translated versions of strings.'), 'fields' => array( - // References locales_source. - 'lid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - // Translation string value in this language. - 'translation' => array('type' => 'text', 'mysql_type' => 'blob', 'not null' => TRUE), - // Language code referencing the languages table. - 'language' => array('type' => 'varchar', 'length' => 12, 'not null' => TRUE, 'default' => ''), - // Parent lid (lid of the previous string in the plural chain) in case of plural strings. - 'plid' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), - // Plural index number in case of plural strings. - 'plural' => array('type' => 'int', 'not null' => TRUE, 'default' => 0) + 'lid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Source string ID. References {locales_source}.lid.'), + ), + 'translation' => array( + 'type' => 'text', + 'mysql_type' => 'blob', + 'not null' => TRUE, + 'description' => t('Translation string value in this language.'), + ), + 'language' => array( + 'type' => 'varchar', + 'length' => 12, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Language code. References {languages}.language.'), + ), + 'plid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Parent lid (lid of the previous string in the plural chain) in case of plural strings. References {locales_source}.lid.'), + ), + 'plural' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('Plural index number in case of plural strings.'), + ), ), 'indexes' => array( 'language' => array('language'), Index: modules/menu/menu.schema =================================================================== RCS file: /cvs/drupal/drupal/modules/menu/menu.schema,v retrieving revision 1.3 diff -u -p -r1.3 menu.schema --- modules/menu/menu.schema 27 May 2007 20:31:13 -0000 1.3 +++ modules/menu/menu.schema 25 Aug 2007 06:43:11 -0000 @@ -4,9 +4,26 @@ function menu_schema() { $schema['menu_custom'] = array( 'fields' => array( - 'menu_name' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'title' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''), - 'description' => array('type' => 'text', 'not null' => FALSE), + 'description' => t('Holds definitions for top-level custom menus (for example, Primary Links).'), + 'menu_name' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Primary Key: Unique key for menu.'), + ), + 'title' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'default' => '', + 'description' => t('Menu title; displayed at top of block.'), + ), + 'description' => array( + 'type' => 'text', + 'not null' => FALSE, + 'description' => t('Menu description.'), + ), ), 'primary key' => array('menu_name'), );