Given that this module is rapidly gaining in popularity, the documentation needs to be improved. Even looking at your support issues, it looks like some of them would be answered by more complete documentation. Please consider improving the section in the "Contributed Modules" area of the handbooks to explain your callable functions, hooks, etc. possibly along with some examples.

BTW - this is not just for the project maintainers. Those who have adopted the module can also contribute to the effort.

Comments

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

Oh, yes, and point to the handbooks from the project page with the "Documentation" link in the project information.

fighella’s picture

fighella commented

I am attempting to change the link used by contribute... currently it is sending the user to "node/ (whatever node the image is in)" but I really want to control where these images link to: ie: to the users profile (or whatever i decide)...

Below is a suggestion from nancyw--->

Here's purely a guess based on what I see here. Change:

$output = l($image, 'node/'. $item['nid'], array(), NULL, NULL, FALSE, TRUE);

to: $output = l($image, 'user/'. $item['uid'], array(), NULL, NULL, FALSE, TRUE);

But this doesnt seem to work. I am assuming because $item['uid'] isnt correct.. as the node/ will change to user/ but the [uid] doesnt seem to appear...

Any suggestions...

fighella’s picture

fighella commented

Here is another suggestion from nevets:

First copy the function theme_imagecache_formatter to your themes template.php file, rename the function phptemplate_imagecache_formatter. Then this line

$output = l($image, 'node/'. $item['nid'], array(), NULL, NULL, FALSE, TRUE);

can be changed to

$node = node_load($item['nid']);
$output = l($image,'user/'. $node->uid, array(), NULL, NULL, FALSE, TRUE);

--- I am in the process of trying this now and will let u know ----

dopry’s picture

dopry commented
Category: feature » task

nancyw this feature request is a given, but I'm not a doc writer.. Please write better documentation instead of opening support issues or feature requests... I don't know what you do and don't know... How about compiling a FAQ if the documentation of this module is important to you, instead of admonishing others to do the work for you!

.darrel.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

I have written documentation for other maintainers and been admonished for it; I will no longer do it unsolicited. IMO it is the maintainer's responsibility to either do this or have someone else do it. I did not contribute any of my modules until I had at least a basic page ready. And if I make feature changes, I try to go back as soon as possible and update those docs.

It doesn't take a Nobel laureate in literature to write docs. Just find someone's description that you like and use it as a template.

I would be happy to help with writing this, but I don't know this module that well yet - especially the internals.

eigentor’s picture

eigentor commented

+1 for me for a better documentation. The present one does not reflect the popularity of the module, as nancy says. I can help writing things from the users view.

I see you maintain a lot of modules and apparently doc writing is not what you do for recreation. But this needs fixing.

By the way: what role do I need to be allowed to write docs? In my present rights-scheme I obviously cannot change your documentation, no rights for editing.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

Anyone with a DO account can contribute to the handbooks. However, to edit what's already there you have to join the documentation team. You can do that by posting a message to the webmasters queue asking for it - you'll probably get that within a few hours.

To edit the project page you have to be listed as a co-maintainer, which may not be something you really want.

dopry’s picture

dopry commented
Status: Active » Closed (duplicate)

see #197207... someone actual plans to write some docs since I'm not so good at it... Gotta love google and those willing to put in some time to help the beleaguered folk who write code like this for people to use.