The module should allow theme maintainers to add documentation using Advanced Help in the same way a module maintainers can do this.

CommentFileSizeAuthor
#6 help_themes.patch20.89 KBfgm
#5 help_themes.patch1.02 KBfgm
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

merlinofchaos’s picture

Currently only modules are checked for help files, but this could easily be extended to themes.

thekenshow’s picture

I agree – theme support is a terrific idea. I was thinking about documenting my experience with various aspects of the Zen theme and immediately wondered how to use Advanced Help for this.

stephthegeek’s picture

Definitely +1. We make some complicated themes, would love to have a Drupally way to document things inside the theme itself :)

merlinofchaos’s picture

I was totally wrong

// Search paths:
$paths = array(
path_to_theme() . '/help', // Allow theme override.
drupal_get_path('module', $module) . "/translations/help/$language->language", // Translations.
$info['path'], // In same directory as .inc file.
);

So there you go.

This only really allows overrides, though. Actually having help *for* a theme might be trickier, though not completely impossible. I'm not sure if what's in there is enough so not yet marking fixed, though if it is sufficient for folks, go ahead and do so.

fgm’s picture

Status: Active » Needs review
FileSize
1.02 KB

This patch seems to add theme support. Use just as in modules: help directory in the theme, (theme).help.ini file, and pages.

fgm’s picture

FileSize
20.89 KB

Revised patch includes revision of the help text.

Zach Harkey’s picture

Priority: Normal » Major

+1 This is huge!

@fgm: Thank you! The patch works great.

Also, I hope it's ok if I change the priority of this feature request to major, because this really is a huge deal for theme developers.

This finally makes it possible for the theme to easily provide deluxe style guides, code snippets, image and graphic specifications, best practices, how-to videos, etc.

BrightBold’s picture

Anyone willing/able to port this patch to D7? I'd love to test it out by creating theme documentation, but all the new sites I'm developing are in 7. I agree that this will be an amazing benefit for theme developers and, more importantly, for content administrators who will be able get help on themes, so I'd love to help test and get it committed.

nerilka’s picture

suscribe

fgm’s picture

@nerilka: please no longer use comments to subscribe to issues on d.o.: click the "Follow" button on top of the issue instead.

esmerel’s picture

Funny that stephthegeek asked me about this very thing today. I bet she forgot that she's asked for it once already! =-)

fgm’s picture

Now if anyone would commit that patch, or at least RTBC it so I can commit it...

jrabeemer’s picture

I scanned the code. There's only three lines of code change. The rest is text. I don't see any reason not to commit it.

fgm’s picture

Simply drupal usage: I wrote the patch, so I may not RTBC it.

  • gisle committed 0613a7a on 6.x-1.x authored by fgm
    Issue #401810 by fgm: Added support for themes
    
gisle’s picture

Title: Supports themes? » Add support for themes
Version: 6.x-1.x-dev » 7.x-1.x-dev
Component: Documentation » Code
Assigned: Unassigned » gisle
Priority: Major » Normal
Issue summary: View changes
Status: Needs review » Active

Committed for D6 (so far 6.x-1.x-dev only). Needs to be ported to D7.

gisle’s picture

Status: Active » Reviewed & tested by the community

Committed for D7 (so far 7.x-1.x-dev only).

  • gisle committed d948759 on 6.x-1.x
    Issue #401810 by gisle: Added documentation about the use of .htaccess
    
fgm’s picture

Fixed at last, then, since it's committed to both 6.x and 7.x ?

gisle’s picture

Yes, it is committed to both, but so far only in the nightly dev snapshot.

I signed on as a new maintainer of this project yesterday, and there is a huge backlog of issues in the queue to look at. I am slowly working my way through it. Expect a new full release for both D6 and D7 in about two weeks time.

PS: A huge "thank you" for this and your other contributions to the Advanced help project.

gisle’s picture

Status: Reviewed & tested by the community » Fixed
gisle’s picture

Version: 7.x-1.x-dev » 7.x-1.2

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.