diff options
| author | Angie Byron <webchick@24967.no-reply.drupal.org> | 2009-11-20 04:20:38 +0000 |
|---|---|---|
| committer | Angie Byron <webchick@24967.no-reply.drupal.org> | 2009-11-20 04:20:38 +0000 |
| commit | 3896ead12bfbd33331b6ee41785a8d90e3bf3e80 (patch) | |
| tree | b888635d24ef0eac77751988a05cdd5ade48bd2c | |
| parent | fd8579a30ab94d6be4f6aa8156e51e8fc20119aa (diff) | |
| download | drupal-3896ead12bfbd33331b6ee41785a8d90e3bf3e80.tar.gz drupal-3896ead12bfbd33331b6ee41785a8d90e3bf3e80.zip | |
#629958 by jhodgdon: Cleaned up page.tpl.php documentation.
| -rw-r--r-- | modules/system/page.tpl.php | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/modules/system/page.tpl.php b/modules/system/page.tpl.php index e474a22fdb3..3f7440b140c 100644 --- a/modules/system/page.tpl.php +++ b/modules/system/page.tpl.php @@ -12,13 +12,14 @@ * least, this will always default to /. * - $directory: The directory the template is located in, e.g. modules/system * or themes/garland. - * - $is_front: TRUE if the current page is the front page. Used to toggle the mission statement. + * - $is_front: TRUE if the current page is the front page. * - $logged_in: TRUE if the user is registered and signed in. * - $is_admin: TRUE if the user has permission to access administration pages. * * Site identity: * - $front_page: The URL of the front page. Use this instead of $base_path, - * when linking to the front page. This includes the language domain or prefix. + * when linking to the front page. This includes the language domain or + * prefix. * - $logo: The path to the logo image, as defined in theme configuration. * - $site_name: The name of the site, empty when display has been disabled * in theme settings. @@ -34,12 +35,17 @@ * * Page content (in order of occurrence in the default page.tpl.php): * - $title: The page title, for use in the actual HTML content. - * - $messages: HTML for status and error messages. Should be displayed prominently. + * - $messages: HTML for status and error messages. Should be displayed + * prominently. * - $tabs (array): Tabs linking to any sub-pages beneath the current page * (e.g., the view and edit tabs when displaying a node). * - $action_links (array): Actions local to the page, such as 'Add menu' on the * menu administration interface. * - $feed_icons: A string of all feed icons for the current page. + * - $node: The node object, if there is an automatically-loaded node + * associated with the page, and the node ID is the second argument + * in the page's path (e.g. node/12345 and node/12345/revisions, but not + * comment/reply/12345). * * Regions: * - $page['help']: Dynamic help text, mostly for admin pages. |