styleguide.theme.inc in Style Guide 7

Theme file for Style Guide module.

File

styleguide.theme.inc

<?php

/**
 * @file
 *   Theme file for Style Guide module.
 */

/**
 * Theme the page header.
 *
 * @param $variables
 *   The theme variables array, including:
 *   -- 'theme_info' an array of information about the current theme.
 */
function theme_styleguide_header($variables) {
  $theme_info = $variables['theme_info'];
  $output = '<h2>' . t('Showing style guide for %theme', array(
    '%theme' => $theme_info['name'],
  )) . '</h2>';
  if (isset($theme_info['description'])) {
    $output .= '<p>' . $theme_info['description'] . '</p>';
  }
  $output .= '<h2 class="styleguide">' . t('Styleguide element entries') . '</h2>';
  $output .= '<p class="styleguide-description">' . t('Optional item description.') . '</p>';
  $output .= '<div class="styleguide">';
  $output .= t('The header area indicates the style element being displayed. The horizontal rules indicate the top and bottom baselines of the rendered element.');
  $output .= '</div>';
  $output .= '<div class="break"><br /></div>';
  return $output;
}

/**
 * Theme a display item.
 *
 * @param $variables
 *   The theme variables array, including:
 *   -- 'key' a unique string indicating the name of the item.
 *   -- 'item' an array of data about the item.
 *   -- 'content' the content to display for this item.
 *
 * @see hook_styleguide()
 */
function theme_styleguide_item($variables) {
  $key = $variables['key'];
  $item = $variables['item'];
  $content = $variables['content'];
  $output = '';
  $output .= "<a name=\"{$key}\"></a>";
  $output .= '<h2 class="styleguide">' . $item['title'] . '</h2>';
  if (!empty($item['description'])) {
    $output .= '<p class="styleguide-description">';
    $output .= $item['description'];
    $output .= '</p>';
  }
  $output .= '<div class="styleguide">';
  $output .= $content;
  $output .= '</div>';
  $output .= l(t('Back to top'), '', array(
    'external' => TRUE,
    'attributes' => array(
      'class' => array(
        'styleguide-top',
      ),
    ),
  ));
  return $output;
}

/**
 * Theme the page links.
 *
 * NOTE: these may be turned into sub-tabs.
 *
 * @param $variables
 *   The theme variables array, including:
 *   -- 'items' the list of links.
 */
function theme_styleguide_links($variables) {

  // Close the header.
  $output = '<div id="styleguide-header" class="styleguide">';
  $output .= $variables['items'];
  $output .= '<div class="break"><br /></div>';
  $output .= '</div>';
  return $output;
}

/**
 * Theme the content.
 *
 * This function is here in case anyone wants to change it.
 *
 * @param $variables
 *   The theme variables array, including:
 *   -- 'content' an HTML content element.
 */
function theme_styleguide_content($variables) {
  return $variables['content'];
}

Functions

Name	Description
theme_styleguide_content	Theme the content.
theme_styleguide_header	Theme the page header.
theme_styleguide_item	Theme a display item.
theme_styleguide_links	Theme the page links.