Re: [SMARTY] the manual

From: Date: Mon, 03 Jun 2002 15:14:37 +0000
Subject: Re: [SMARTY] the manual
References: 1  Groups: php.smarty.general 
Request: Send a blank email to php-smarty-general+get-4529@lists.php.net to get a copy of this message
The manual is written in SGML and rendered to HTML with dsssl using dbtools like so: cd /path/to/smarty/docs db2html -d /path/to/smarty/docs/html.dsl manual.sgml db2pdf manual.sgml The current manual is kind of a mix and match between a reference manual and a user guide, leaning more toward a reference manual. I've been wanting to put together a comprehensive user guide, but haven't had any time to start such a project. It should not only cover how Smarty works, but more importantly _how_ to write applications using Smarty. Such material would be more than enough to write an entire book (which is not a bad idea IMHO.) FYI, the latest "PHP in 24 hours" book covers Smarty in an entire chapter by itself! So cleaning up the ref manual is one project, and extracting parts of it to a user guide and writing a user guide from scratch is another. Monte Blue Presley wrote:
I realize that the question I asked generated a bit of off topic response about the manual. Once upon a time, I posted a criticism of the manuals usefulness and ability to be read and understood, however, I was pretty much flammed with "well, if you don't like it and can't understand it, use something else" Smarty is a powerful program, and I'm sure that through the hard work of the authors it's constantly evolving. I'm not sure if the authors want to keep it's use limited to proficient programmers or if they would be happy if their program became widely used and accepted throughout the programming and web development world. If the latter is appealing, then something has to be done about the manual. in my flamming, i was sarcastically challenged to "rewrite" the manual. well, i'm all for it, but i'll need some help. there are parts of smarty with which i've become very proficient. there are other things, like $global_assign, that because of the manual's inefficiencies are almost impossible to understand unless you've been programming since COBAL or something. in fact, because the manual has been so inadequate, i've actually looked at the Smarty code and only THEN did i understand how a particular aspect work. so yea, let's rewrite the manual. if we all chip in and write about what we know real well then it can be done quickly and easily with lots of examples.. it would be beneficial to the life of Smarty and the sanity of beginners. almost like a CVS type system. or, even better, like the DOC files on php.net where users can add their own examples and comments to makes parts of the code even more easily understood. so how do we get started? blue
-- Monte Ohrt <monte@ispi.net> Director of Technology, ispi Inc.

« previous php.smarty.general (#4529) next »