summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGábor Hojtsy2010-08-06 11:13:42 (GMT)
committer Gábor Hojtsy2010-08-06 11:13:42 (GMT)
commit5410afce2388a656f5c2638ff4254e66ae30e23a (patch)
tree213fd9d5cf06319b7c766d7f78fcb3fcf25c5876
parentb12fdcbd023fc561b6ed1225f449f4fab982eab3 (diff)
#629958 by jhodgdon, rdrh555: improve documenatation consistency and mention the node variable in page.tpl.php
-rw-r--r--modules/system/page.tpl.php57
1 files changed, 31 insertions, 26 deletions
diff --git a/modules/system/page.tpl.php b/modules/system/page.tpl.php
index d4cfe92..a0c9e7f 100644
--- a/modules/system/page.tpl.php
+++ b/modules/system/page.tpl.php
@@ -2,9 +2,8 @@
// $Id$
/**
- * @file page.tpl.php
- *
- * Theme implementation to display a single Drupal page.
+ * @file
+ * Displays a single Drupal page.
*
* Available variables:
*
@@ -14,62 +13,68 @@
* - $css: An array of CSS files for the current page.
* - $directory: The directory the theme is located in, e.g. themes/garland or
* themes/garland/minelli.
- * - $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.
*
* Page metadata:
* - $language: (object) The language the site is being displayed in.
* $language->language contains its textual representation.
- * $language->dir contains the language direction. It will either be 'ltr' or 'rtl'.
- * - $head_title: A modified version of the page title, for use in the TITLE tag.
- * - $head: Markup for the HEAD section (including meta tags, keyword tags, and
+ * $language->dir contains the language direction. It will either be 'ltr' or
+ * 'rtl'.
+ * - $head_title: A modified version of the page title, for use in the TITLE
+ * element.
+ * - $head: Markup for the HEAD element (including meta tags, keyword tags, and
* so on).
* - $styles: Style tags necessary to import all CSS files for the page.
* - $scripts: Script tags necessary to load the JavaScript files and settings
* for the page.
* - $body_classes: A set of CSS classes for the BODY tag. This contains flags
- * indicating the current layout (multiple columns, single column), the current
- * path, whether the user is logged in, and so on.
+ * indicating the current layout (multiple columns, single column), the
+ * current path, whether the user is logged in, and so on.
*
* 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.
+ * - $site_name: The name of the site, empty when display has been disabled in
+ * theme settings.
* - $site_slogan: The slogan of the site, empty when display has been disabled
* in theme settings.
- * - $mission: The text of the site mission, empty when display has been disabled
- * in theme settings.
+ * - $mission: The text of the site mission, empty when display has been
+ * disabled in theme settings.
*
* Navigation:
- * - $search_box: HTML to display the search box, empty if search has been disabled.
- * - $primary_links (array): An array containing primary navigation links for the
- * site, if they have been configured.
- * - $secondary_links (array): An array containing secondary navigation links for
+ * - $search_box: HTML to display the search box, empty if search has been
+ * disabled.
+ * - $primary_links (array): An array containing primary navigation links for
* the site, if they have been configured.
+ * - $secondary_links (array): An array containing secondary navigation links
+ * for the site, if they have been configured.
*
- * Page content (in order of occurrance in the default page.tpl.php):
+ * Page content (in order of occurrence in the default page.tpl.php):
* - $left: The HTML for the left sidebar.
- *
* - $breadcrumb: The breadcrumb trail for the current page.
* - $title: The page title, for use in the actual HTML content.
* - $help: Dynamic help text, mostly for admin pages.
- * - $messages: HTML for status and error messages. Should be displayed prominently.
- * - $tabs: Tabs linking to any sub-pages beneath the current page (e.g., the view
- * and edit tabs when displaying a node).
- *
+ * - $messages: HTML for status and error messages. Should be displayed
+ * prominently.
+ * - $tabs: Tabs linking to any sub-pages beneath the current page (e.g., the
+ * view and edit tabs when displaying a node).
* - $content: The main content of the current Drupal page.
- *
* - $right: The HTML for the right sidebar.
+ * - $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).
*
* Footer/closing data:
* - $feed_icons: A string of all feed icons for the current page.
* - $footer_message: The footer message as defined in the admin settings.
* - $footer : The footer region.
* - $closure: Final closing markup from any modules that have altered the page.
- * This variable should always be output last, after all other dynamic content.
+ * This variable should always be output last, after all other dynamic
+ * content.
*
* @see template_preprocess()
* @see template_preprocess_page()