Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
This patch is stripped down version of the patch at #299050-306: Help System - Master Patch.
Features:
- Each module can have multiple help pages/topics.
- Each help topic is a separate file with content in HTML format.
- admin/help provides an overview to browse topics "by module".
- Each topic page is accompanied by a Table of contents block, and next/prev navigation links, iff there are more than 1 topics.
- Each module defines available topics in path/to/module/help/module.help file, in ini format.
- Each defined topic can have a "title", "file", "weight", and "path". See help's help to know what they mean.
- A module can be given a special name (which appears on the admin/help overview page). e.g. content.module probably wants itself to be called CCK instead.
- Help files use [internal:X] token for linking to other topics.
- That's all.
Comment | File | Size | Author |
---|---|---|---|
#6 | help-system-402404-3.patch | 106.2 KB | redndahead |
#2 | drupal7-help-system_402404-2.patch | 105.29 KB | Gurpartap Singh |
#1 | drupal7-help-system_402404-1.patch | 105.29 KB | Gurpartap Singh |
Comments
Comment #1
Gurpartap Singh CreditAttribution: Gurpartap Singh commentedA better highlighted view: http://pastie.org/416700
Comment #2
Gurpartap Singh CreditAttribution: Gurpartap Singh commentedWith a minor change. http://pastie.org/416703
Comment #3
dmitrig01 CreditAttribution: dmitrig01 commentedThese are some of DamZ's comments, and some of mine
module_exists needs to come first.
the topic needs to have the same name as a URL? what if i want help on just admin/build?
This makes me think there is another "mode" to see topics in (help_by_X).
That if statement is unneeded
That function name makes me think it's building a tree, but it's only building children. Also, calling the function with $topic['children'] doesn't lead me to believe that there is no hierarchy handling. THe parameter names and descriptions are unclear too.
Let's cache this with cache_set
could be
<?
+function help_get_topic_file_info($module, $topic) {
...
+ $info['path'], // In same directory as .inc file.
?>
do you mean .help file? if not, which .inc file?
'access help' needs to be on the next line and the following array needs to be on the same line
that's it for now
Comment #4
redndahead CreditAttribution: redndahead commentedGood suggestions dmitrig01. (Okay this is just a subscribe post. Thought I'd spruce it up a bit.)
Comment #5
redndahead CreditAttribution: redndahead commentedMoving to CNW
Comment #6
redndahead CreditAttribution: redndahead commentedRerolled with few fixes. Here are responses to dmitrig01 comments.
So to recap what's left:
Comment #7
redndahead CreditAttribution: redndahead commentedMoving to needs review. But it will still need a little more work to be moved to RTBC
Comment #9
catchafaik this is postponed on #401956: Provide an [internal] filter (which is stalled). If it's not really postponed on that, we could do with some feedback from webchick and Dries on what needs doing to get this RTBC.
Comment #10
redndahead CreditAttribution: redndahead commentedI don't think we need to postpone for tokens. I think token support has a lot further to go than this help patch and making the necessary changes after #401956 goes in should be trivial. But we do need feedback from Dries or Webchick on what to do to get this in.
Comment #11
catch:(
Comment #12
catchForgot version change, sorry.
Comment #13
catchDowngrading all D8 criticals to major per http://drupal.org/node/45111
Comment #14
quicksketchEventually catch's post resulted in a cap on majors also. See http://drupal.org/node/1201874 for the new caps on all major tasks/bugs. Obviously this patch has seen major postponements and it doesn't make sense for it to prevent new features. I'm moving this to a feature, since the original issue quite clearly states this as a list of new features.
Still an incredibly important issue. Our help is lame. :(
Comment #15
realityloopIt might be better to split this into smaller sub-tasks.
Comment #16
catch#2351991: Add a config entity for a configurable, topic-based help system.
Not sure what this does that's not handled by that issue.
Comment #17
jhodgdonI don't think this is really a Meta issue, so changing title. Really it's an issue with a specific approach, more or less the Advanced Help module.
So I've filed a new meta issue to collect all the problems with the current help system and discuss the best route to fixing them; this issue is being added as Related there:
#2592487: [meta] Help system overhaul
Comment #19
jhodgdonComment #23
andypostComment #27
gisleI am closing this as outdated. It looks like another approach has been selected for Drupal 8, re: #2920309: Add experimental module for Help Topics.