<div id="RTEContent">You're right. I was also thinking about stuff such as use cases, tips and tricks etc. <br> <br> However, at the moment, I am thinking more about the documentation *on* the handbook pages. I suspect it will be easier to add this stuff there than to ask module developers to do it. Or, may be I am not understanding your point?<br> <br> Ramdak<br> <br><br><b><i>gunnar <gunnar@langemark.com></i></b> wrote:<blockquote class="replbq" style="border-left: 2px solid rgb(16, 16, 255); margin-left: 5px; padding-left: 5px;"> What you're hinting at could extend this way:<br>Have a structured documentation node type with fields to fill. For a module<br>document that would mean:<br><br>--------<br><br>Name of module<br>Purpose of module<br>Drupal version(s)<br>Prerequisites and dependencies<br>Installation and configuration procedure<br>- Database<br>- Settings<br>- Access Control<br>- Blocks configuration<br>- Menus<br>- Theme related stuff<br><br><br>Mor
e<br>-
Snippets<br>- Working with other modules<br><br>Use Cases<br>(fictional or real)<br><br>--------<br><br>Best<br>Gunnar<br><br><br><br>> I have a few ideas for improving the handbook documentation and <br>> would like to volunteer for implementing them if the people on this <br>> list think they will help.<br>> <br>> These ideas are based on the tremendous difficulties I have had as <br>> a non-geek in understanding what a drupal core or contributed <br>> module does. The only way is to test each one out and this can be <br>> really time consuming when testing multiple modules.<br>> <br>> Current problems that newbies (and, I suspect, even others) have <br>> in understanding modules:<br>> <br>> 1.) Whether a module is dependent on another<br>> 2.) Whether an sql table should be added to make it work<br>> 3.) No idea about the different tables added by a module's sql file<br>> 4.) No idea about the permissions
implemented by a module.<br>> <br>> 5.) No idea of what stuff a module adds to the navigation menu and <br>> UI.<br>> 6.) Whether the module adds customs blocks that can then be <br>> enabled and configured.<br>> <br>> There may also be other aspects that I have overlooked.<br>> <br>> I believe that documenting these would go a long way in helping <br>> people get up to speed on drupal very quickly. For example, until I <br>> got into the habit of visiting administer>>access <br>> control>>permissions>>module name>>permissions, I spent hours <br>> wondering why a module was not working. I bet many face the same problem.<br>> <br>> If this sounds useful, I am willing to do this work for 4.6 (as <br>> that has the largest user base at the moment), starting with each <br>> core module and moving on to the contribs.<br>> <br>> I also feel that if the handbook would allow screensho
ts, it
would <br>> make for great documentation. As they say, a picture is worth a <br>> thousand words and all that.<br>> <br>> Thanks,<br>> Ramdak<br>> <br>> ---------------------------------<br>> Yahoo! Photos – Showcase holiday pictures in hardcover<br>> Photo Books. You design it and we’ll bind it!<br><br><br>Gunnar Langemark<br>gunnar@langemark.com<br>--<br>Pending work: http://drupal.org/project/issues/documentation/<br>List archives: http://lists.drupal.org/pipermail/documentation/<br></blockquote><br></div><p>
<hr size=1>Yahoo! Photos – Showcase holiday pictures in hardcover<br>
<a href="http://us.rd.yahoo.com/mail_us/taglines/photobooks/*http://pa.yahoo.com/*http://us.rd.yahoo.com/mail_us/taglines/photos/evt=38088/*http://pg.photos.yahoo.com/ph//page?.file=photobook_splash.html">Photo Books</a>. You design it and we’ll bind it!