[PHPTAL] automated documentation for templates?
Guillaume at lya.fr
Fri May 30 11:03:01 CEST 2008
Le jeudi 29 mai 2008 à 22:14 +0200, Iván -DrSlump- Montes a écrit :
> NaturalDocs  is a very flexible documentation system which can be
> configured to suit almost any language .
> The documentation could look something like this:
> Iterable: options
> label - The option label
> selected - Is the option selected?
> value - The option value
> <div tal:repeat="option options>
>  http://www.naturaldocs.org
>  http://www.naturaldocs.org/customizinglanguages.html
The idea of Jason is very good.
Iván, NaturalDocs could be an idea, but only if PHPTAL can remove
theses HTML comments.
This could be problematics if theses comments are show in the final HTML
> On Thu, May 29, 2008 at 9:54 PM, Anton Andrievskij <x.meglio at gmail.com> wrote:
> > Hi, Jason.
> > I think your idea is useful and we it need be realized.
> > What other people think?
> > Anton
> > On Thu, May 29, 2008 at 10:25 PM, Jason - USL <jason at underdogseattle.com>
> > wrote:
> >> Hi, everybody.
> >> I'm wondering if anybody's created or thought about a system for
> >> documenting the PHPTAL templates themselves. It seems to me that, for a
> >> project of any size, it would be ideal if each template could be
> >> processed by a documentation engine that tells the developers which
> >> variables/objects/arrays need to be passed into the template and how
> >> they're used.
> >> For example, if my template designer creates something like
> >> tal:repeat="option options", my php developer would see a corresponding
> >> line in the documentation saying that the variable 'options' needs to be
> >> set, and it needs to implement the iterable interface...
> >> I though maybe it could be achieved by hacking together some custom
> >> objects to use in place of the standard PHPTAL_Php_CodeGenerator and
> >> PHPTAL_Php_CodeWriter to generate documentation instead of compiled
> >> template files.
> >> After getting into the code, though, it looks like a bigger project than
> >> I'd thought. So, I was wondering if anybody on the list has done
> >> something like this, or has better ideas for communicating and
> >> documenting the templates' functions.
> >> Thanks for any advice you can give,
> >> Jason
> >> _______________________________________________
> >> PHPTAL mailing list
> >> PHPTAL at lists.motion-twin.com
> >> http://lists.motion-twin.com/mailman/listinfo/phptal
> > _______________________________________________
> > PHPTAL mailing list
> > PHPTAL at lists.motion-twin.com
> > http://lists.motion-twin.com/mailman/listinfo/phptal
> PHPTAL mailing list
> PHPTAL at lists.motion-twin.com
-------------- section suivante --------------
Une pi�ce jointe HTML a �t� enlev�e...
More information about the PHPTAL