More Documentation
| Project: | jCarousel |
| Version: | 6.x-1.x-dev |
| Component: | Documentation |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | active |
Jump to:
It would be great if the readme could offer a bit more verbosity in its skin change instructions. I'm no Drupal wizard, but I'm definitely not a novice either, and I've reached the point today where I believe I probably would already have a working, customized jCarousel solution on my site if I hadn't tried to do it with the module. Honestly not trying to be negative here when I say this, but just adding a few step-by-step lines to the readme would make a huge difference for some of us.
More specifically, I am still not 100% sure whether I am supposed to add a line of php code (similar to what's in post #2 in this thread) to the top of the node (no perceptible effect), or if I should be editing line #72 in the jcarousel.module file (edited the skin name in the quotes and it broke jCarousel).
I'm sure I'll figure it out via trial and error eventually, but having clearer instructions from the beginning would have been very helpful. (Or maybe the 6.x-1.x-dev version will be a little clearer - I will give that a shot next).
Thanks for the module!
#1
Nope, 6.x-1.x-dev seems to be the same. Unless I have a flash of inspiration very soon, I'm probably going to just scrap my efforts and set it up sans module.
#2
If you visit admin/help/jcarousel, you'll get some live examples of jCarousel being used. What other documentation did you want?
#3
Whoops, didn't mean to change to fixed.
#4
Well I seem to not be able to implement jcarousel in my website...
I've googled, checked the jCarousel help, searched and tried lots of things but still have not managed to succeed...
So I would appreciate if there was more documentation...
#5
What are you trying to make a jCarousel of? This is just an API module, so you'd have to write code:
<?php$rows = array('ntg', 'werd', 'herrro');
echo theme('jcarousel', $rows);
?>
#6
I have been starring at the admin/help/jcarousel file, and all the examples work beautifully. What the file is MISSING is actual instructions. For instance,
1. where do I place: jcarousel_add()
2. Do I need to surround in PHP tags?
3. How do I place the parameters?
The help page simply shows that it is possible, but it does not show how the page itself was created, i.e., what jquery was called, how each one was set, where the call is places, etc. It would be VERY HELPFUL if above each example was a
jcarousel_add (etc)simply presenting the code used to create each example. then the link to Sorgulla would be helpful for people to expand.It seems the problem is not building on the code, it is knowing where to place it in the first place. If someone will tell me how to do it, i can rewrite the help page and send it to someone so it can be posted.
#7
Well, those questions are Drupal theming basics, as far as I can tell. Which is why they're not documented in this module.
#8
Wim,
I mean this in the nicest way, but I have read through the documentation and the issues on this site, and the number of 'basic' questions which you do not answer are plenty. I am not a basic themer, though there there are clear holes in my knowledge. This is one of them. I did figure out the answer and am happy to add to the documentation page included in the module. I think this would be immensely helpful for people, far more helpful than dismissing such requests as "basic" and not deserving of documentation.
Currently, the documentation shows that the code works. It does not show where to place the code, etc. If the documentation can list, before or after each example, something like this, it would really save frustration:
"Place the following in the body of your node, enclosed in the PHP tags. Be sure to include the PHP tags and select PHP as your input format.
<?php jcarousel_add('#carousel',
array(
'scroll'=>'1',
'wrap'=>'both',
'animation'=>'slow',
'start'=>'4',
),
'mgm'
);
?>
#9
Where should we put that documentation though? In README.txt for Drupal 6?
#10
Currently, the standard help includes some very nice examples. I think the ideal is that immediately before each of these examples, the sample code which creates the carousel would appear. Further, the Sorgalla configuration link could be highlighted as a place to see all the options. A single example could be placed in the read me. I think that would cover the important areas.