This forum is in READ-ONLY mode.
You can look around, but if you want to ask a new question, please use the new forum.
Home » development » Documentation » where to find documentation/usage guide of generate-module command?
where to find documentation/usage guide of generate-module command? [message #74465] Tue, 10 March 2009 14:25 Go to next message
wbdvlpr  is currently offline wbdvlpr
Messages: 10
Registered: December 2008
Location: West Midlands, UK
Junior Member
Hi,

I am new to Symfony and was trying my hands on it using Jobeet tutorial. In the day 3, they have mentioned creating modules using -
$ php symfony doctrine:generate-module --with-show --non-verbose-templates frontend job JobeetJob

It is on page -> http://www.symfony-project.org/jobeet/1_2/Doctrine/en/03

Where I can find information about what do the arguments --with-show or --non-verbose-templates do. I have tried in "Documentation" and API but could not find.

Could you please guide me?

Thanks.


~~CJ~~
Re: where to find documentation/usage guide of generate-module command? [message #75000 is a reply to message #74465 ] Tue, 17 March 2009 18:51 Go to previous messageGo to next message
leszczu  is currently offline leszczu
Messages: 6
Registered: March 2009
Location: Poland
Junior Member
Isn't that just great? Everywhere they keep telling how extensible and complete documentation is, but every now and then you stumble upon something completely undocumented.

From my first project:

Quote:

When using the propel:generate-module task, you have used the --non-verbose-templates option. If you want to learn the meaning of the available arguments and options for a given task, you can use the special help task:
$ php symfony help propel:generate-module


From $ php symfony help propel:generate-module:

Quote:

Usage:
symfony propel:generate-module [--theme="..."] [--generate-in-cache] [--non-verbose-templates] [--with-show] [--singular="..."] [--plural="..."] [--route-prefix="..."] [--with-propel-route] [--env="..."] application module model

{...}

Options:
--theme The theme name (default: default)
--generate-in-cache Generate the module in cache
--non-verbose-templates Generate non verbose templates
--with-show Generate a show method
--singular The singular name
--plural The plural name
--route-prefix The route prefix
--with-propel-route Whether you will use a Propel route
--env The environment (default: dev)



Well? How about that complete documentation?

I know symfony developers keep updating documentation and it's quite robust but stumbling upon options like that can confuse anyone. Any explanation on that option?
Re: where to find documentation/usage guide of generate-module command? [message #75002 is a reply to message #74465 ] Tue, 17 March 2009 19:03 Go to previous messageGo to next message
halfer  is currently offline halfer
Messages: 9535
Registered: January 2006
Location: West Midlands, UK
Faithful Member
A quick web search finds this:

http://www.symfony-project.org/book/forms/1_2/en/11-Doctrine -Integration#chapter_11_the_crud_generator

If this is insufficient detail, then you can always raise a ticket. Perhaps a synopsis of options would be nice, but then one can always write more (I read from the mailing list of another framework the suggestion that symfony has **too much** documentation - goes to show you can't keep everyone happy).

@leszczu - sarcasm is probably not the best mode in which to raise your suggestions. People who are regularly take this attitude mysteriously find their way into my ignore list, so in general it is best to be nice!


Remember Palestine
Re: where to find documentation/usage guide of generate-module command? [message #75003 is a reply to message #74465 ] Tue, 17 March 2009 19:05 Go to previous messageGo to next message
halfer  is currently offline halfer
Messages: 9535
Registered: January 2006
Location: West Midlands, UK
Faithful Member
@wbdvlpr - nice to see another Midlander on here. If you want to shout me and swap notes, feel free; my email's in my profile.


Remember Palestine
Re: where to find documentation/usage guide of generate-module command? [message #75004 is a reply to message #74465 ] Tue, 17 March 2009 19:16 Go to previous messageGo to next message
leszczu  is currently offline leszczu
Messages: 6
Registered: March 2009
Location: Poland
Junior Member
Sorry for sarcasm, sometimes it's frustrating when you find no documentation exist. I googled a bit for this option's description but found nothing I could use.

I find it too cryptic for a description like this:
Quote:


--non-verbose-templates Generate non verbose templates


In my opinion, 'symfony help' command should give a lot more information, like linux 'man' command. Or maybe a link to online documentation?

Anyway, I generated two modules (one with non-verbose-templates) and diff'd them to see differences. Still, it would be nice to add any info on this.

Regarding too much documentation, it's never too much, as long as it's current and kept in order, IMHO.

Re: where to find documentation/usage guide of generate-module command? [message #75052 is a reply to message #74465 ] Wed, 18 March 2009 11:14 Go to previous messageGo to next message
wbdvlpr  is currently offline wbdvlpr
Messages: 10
Registered: December 2008
Location: West Midlands, UK
Junior Member
Hi guys,

Thanks for your replies.

@leszczu

Quote:


I find it too cryptic for a description like this:
Quote:


--non-verbose-templates Generate non verbose templates





"cryptic" .. lol .. you are right in a way .. lol.

Anyhow, I think this is where the community/sfusers can take over and help ease out some pressure from Symfony development team so that they can keep adding more cool features.

For example, I am very much new to symfony but having played around with this beast ..err.. symfony .. I am loving it more and more .. and I should start sharing my problems and their solutions with others [@ sf blog/forum etc] and later sf team can get extracts from these to add up MORE documentation. Laughing


hello! @halfer .. thanks, I'll keep in touch with you. you are playing an important role here .. keep it up. Cool cheers!


~~CJ~~
Re: where to find documentation/usage guide of generate-module command? [message #79491 is a reply to message #75004 ] Sat, 06 June 2009 01:36 Go to previous messageGo to next message
devonpeterson  is currently offline devonpeterson
Messages: 1
Registered: June 2009
Location: BC, Canada
Junior Member
leszczu wrote on Tue, 17 March 2009 11:16


Anyway, I generated two modules (one with non-verbose-templates) and diff'd them to see differences. Still, it would be nice to add any info on this.



So what sort of differences were there in the diff?
Re: where to find documentation/usage guide of generate-module command? [message #79499 is a reply to message #79491 ] Sat, 06 June 2009 13:00 Go to previous message
leszczu  is currently offline leszczu
Messages: 6
Registered: March 2009
Location: Poland
Junior Member
devonpeterson wrote on Sat, 06 June 2009 01:36


So what sort of differences were there in the diff?


Well, only difference is in forms. In non-verbose templates forms are outputted in one line:
//..
<?php echo $form ?>
//..

So, all rows will be outputted automatically.

In verbose templates, each row is outputted:
//..
<tr>
  <td><?php echo $form['field_1']->renderLabel() ?></td>
  <td><?php echo $form['field_1']->renderError() ?></td>
  //etc..
</tr>
// then same with field_2 and so on
//..
Previous Topic:newbie: yaml database syntax, database specialities
Next Topic:INSERT INTO
Goto Forum:
  

powered by FUDforum - copyright ©2001-2004 FUD Forum Bulletin Board Software