Re: [SMARTY] the manual
| From: | Andrei Zmievski | Date: | Mon, 03 Jun 2002 15:06:50 +0000 |
| Subject: | Re: [SMARTY] the manual | ||
| References: | 1 | Groups: | php.smarty.general |
| Request: | Send a blank email to php-smarty-general+get-4528@lists.php.net to get a copy of this message | ||
On Mon, 03 Jun 2002, Blue Presley wrote:
> 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?
I am glad you brought this up. You see, the manual is already the best
that Monte and I could do with it. It's simply the limit of our
abilities as technical writers, which should tell you that our talents
probably lie somewhere else. :)
The manual should be converted to the same structure as the PHP
documentation. Meaning, making it XML compatible, setting up the build
system, etc. Last I heard, Hartmut <hholzgra@php.net> was going to set
up a unified build system for all the projects under php.net. You should
probably contact him and see where he is at. If he is not done with it,
then we'll just have to have our own build system and ask for PHP Doc
people's help with setting it up. We should be really vocal in asking
for it, as a group, because I mentioned it on the phpdoc list once and
no one replied.
From then on, it will be pretty easy to make documentation -- just check
out the files, edit them, commit and the manual is updated on the web
automatically.
-Andrei http://www.gravitonic.com/
* The future is not what it used to be. *