Commit 0559d38f authored by merlinofchaos's avatar merlinofchaos
Browse files

Initial checkin for the advanced help module, which I intend to use with Views...

Initial checkin for the advanced help module, which I intend to use with Views in order to make a better help system.
parents
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<?php print $language->language ?>" lang="<?php print $language->language ?>" dir="<?php print $language->dir ?>">
<head>
<title><?php print $head_title; ?></title>
<?php print $head; ?>
<?php print $styles; ?>
<?php print $scripts; ?>
<script type="text/javascript"><?php /* Needed to avoid Flash of Unstyled Content in IE */ ?> </script>
</head>
<body>
<div id="page">
<div id="header">
<?php if (!empty($search_box)): ?>
<div id="search-box"><?php print $search_box; ?></div>
<?php endif; ?>
</div> <!-- /header -->
<div id="breadcrumb"><?php print $breadcrumb; ?></div>
<div id="content">
<?php if (!empty($title)): ?><h1 class="title" id="page-title"><?php print $title; ?></h1><?php endif; ?>
<?php if (!empty($tabs)): ?><div class="tabs"><?php print $tabs; ?></div><?php endif; ?>
<?php if (!empty($messages)): print $messages; endif; ?>
<?php if (!empty($help)): print $help; endif; ?>
<div id="content-content" class="clear-block">
<?php print $content; ?>
</div> <!-- /content-content -->
</div> <!-- /content -->
<?php print $closure; ?>
</div> <!-- /page -->
</body>
</html>
; $Id$
name = Advanced help
description = Allow advanced help and documentation
core = 6.x
<?php
// $Id$
/**
* @file advanced_help.install
* Contains install and update functions for advanced_help.
*/
function advanced_help_install() {
drupal_set_message('Installing advanced_help');
drupal_install_schema('advanced_help');
}
function advanced_help_uninstall() {
drupal_uninstall_schema('advanced_help');
variable_del('advanced_help_last_cron');
}
/**
* advanced_help's initial schema.
*/
function advanced_help_schema() {
$schema['advanced_help_index'] = array(
'description' => t('Stores search index correlations for advanced help topics.'),
'fields' => array(
'sid' => array(
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => t('The primary key to give to the search engine for this topic.'),
'no export' => TRUE,
),
'module' => array(
'type' => 'varchar',
'length' => '255',
'default' => '',
'not null' => TRUE,
'description' => t('The module that owns this topic.'),
),
'topic' => array(
'type' => 'varchar',
'length' => '255',
'default' => '',
'not null' => TRUE,
'description' => t('The topic id.'),
),
),
'primary key' => array('sid'),
);
return $schema;
}
\ No newline at end of file
This diff is collapsed.
/* $Id */
body {
margin: 0;
padding: 0;
background: #edf5fa;
font: 12px/170% Verdana, sans-serif;
color: #494949;
}
input {
font: 12px/100% Verdana, sans-serif;
color: #494949;
}
textarea, select {
font: 12px/160% Verdana, sans-serif;
color: #494949;
}
h1, h2, h3, h4, h5, h6 {
margin: 0;
padding: 0;
font-weight: normal;
font-family: Helvetica, Arial, sans-serif;
}
h1 {
font-size: 170%;
}
h2 {
font-size: 160%;
line-height: 130%;
}
h3 {
font-size: 140%;
}
h4 {
font-size: 130%;
}
h5 {
font-size: 120%;
}
h6 {
font-size: 110%;
}
ul, quote, code, fieldset {
margin: .5em 0;
}
p {
margin: 0.6em 0 1.2em;
padding: 0;
}
a:link, a:visited {
color: #027AC6;
text-decoration: none;
}
a:hover {
color: #0062A0;
text-decoration: underline;
}
a:active, a.active {
color: #5895be;
}
hr {
margin: 0;
padding: 0;
border: none;
height: 1px;
background: #5294c1;
}
ul {
margin: 0.5em 0 1em;
padding: 0;
}
ol {
margin: 0.75em 0 1.25em;
padding: 0;
}
ol li, ul li {
margin: 0.4em 0 0.4em .5em; /* LTR */
}
#content {
margin: .5em 1em 1em 1em;
}
#content #page-title {
padding-bottom: .5em;
}
div#breadcrumb {
padding-left: 1em;
background-color: white;
border-bottom: 1px solid #ccc;
height: 2em;
}
div#breadcrumb .breadcrumb {
padding: 0;
margin: 0;
}
code, pre {
border: 1px solid #444;
background: #f1f1f1;
margin: 1em;
padding: .2em;
display: block;
}
[using-advanced-help]
title = Using advanced help
file = using-advanced-help
<p>The advanced help system is a pluggable system to provide advanced help facilities for Drupal and modules. Currently it does not provide much in the way of help by itself, but instead it provides a facility to make it easier and more powerful to for modules to provide help.
</p>
<p>
Modules utilizing this help system should create a 'help' directory in their
module. Inside that directory place MODULENAME.help.ini which will be formatted
like this:
</p>
<pre>
[buses]
title = "How buses are tied into the system"
file = buses
[TOPIC_ID]
title = "Title of topic"
file = filename of topic, without the .html extension
weight = How important the topic is on the index page
parent = the optional topic parent to use in the breadcrumb.
Can be either topic or module%topic
</pre>
<p>
All topics are addressed by the module that provides the topic, and the topic
id. Modules can embed links anywhere they want with this:
</p>
<code>
$output .= theme('advanced_help_topic', $module, $topic);
</code>
<p>When writing help files, you can link to other topics using <strong>&lt;a href=&quot;topic:module/topic"&gt;</strong>. Using
this format will ensure that the popup/not-popup stays consistent from
link to link.</p>
<p>You can also use <strong>&lt;a href=&quot;path:example.jpg"&gt;</strong> to reference items
within the help directory, such as images to embed within the help.</p>
<p>
If the search module is enabled, this help system will be indexed on cron. If you enable new modules and immediately want to search its help, visit <a href="/admin/settings/run-cron">run cron</a> to facilitate this.</p>
<p>Example: <a href="path:nowhere.jpg">Don't click this!</a></p>
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment