lack of documentation

[Andrea Fae']

Web2py is wonderful, but it has a big challenge. No documentation. Or at least no complete documentation. It's all based on the book and some site that can give you suggestions...it's too less.

Is there any person tha can tell me a complete reference of the language (don't tell me the api, I'm not so skilled to understand completely this docs...)

Thank you

[Anthony]

On Sunday, April 9, 2017 at 10:35:04 AM UTC-4, Andrea Fae' wrote:

Web2py is wonderful, but it has a big challenge. No documentation. Or at least no complete documentation. It's all based on the book

The book is the documentation, and is fairly comprehensive. What exactly do you consider to be incomplete?
 

and some site that can give you suggestions...it's too less.

Is there any person tha can tell me a complete reference of the language (don't tell me the api, I'm not so skilled to understand completely this docs...)

The book is the most complete documentation there is. If there are things you don't understand, just ask questions here or on Stack Overflow.

Anthony

[Marlysson Silva]

Do you are speaking about a couple of examples of "How to" ?

[António Ramos]

Andrea do you see what i see ?

http://www.web2py.com/books/default/chapter/29/06/the-database-abstraction-layer

Its only the DAL chapter...

....

--
Resources:
- http://web2py.com
- http://web2py.com/book (Documentation)
- http://github.com/web2py/web2py (Source code)
- https://code.google.com/p/web2py/issues/list (Report Issues)
---
You received this message because you are subscribed to the Google Groups "web2py-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to web2py+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Carlos Cesar Caballero Díaz]

Hi guys, I think he is talking about the web2py api, and there are some undocumented features, by example, when you authenticate against an ldap you can map ldap groups against web2py groups, but this is not documented, and there are some undocumented features like that.

Greetings.

El 10/04/17 a las 18:41, António Ramos escribió:

For more options, visit MailScanner ha detectado un intento de fraude en la siguiente página web "groups.google.com". No confíe en esta página web: MailScanner ha detectado un intento de fraude en la siguiente p�gina web "groups.google.com". No conf�e en esta p�gina web: https://groups.google.com/d/optout.

--
Resources:
- http://web2py.com
- http://web2py.com/book (Documentation)
- http://github.com/web2py/web2py (Source code)
- https://code.google.com/p/web2py/issues/list (Report Issues)
---
You received this message because you are subscribed to the Google Groups "web2py-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to web2py+un...@googlegroups.com.
For more options, visit MailScanner ha detectado un intento de fraude en la siguiente página web "groups.google.com". No confíe en esta página web: MailScanner ha detectado un intento de fraude en la siguiente p�gina web "groups.google.com". No conf�e en esta p�gina web: https://groups.google.com/d/optout.

[Anthony]

On Tuesday, April 11, 2017 at 8:55:20 AM UTC-4, Carlos Cesar Caballero wrote:

Hi guys, I think he is talking about the web2py api, and there are some undocumented features, by example, when you authenticate against an ldap you can map ldap groups against web2py groups, but this is not documented, and there are some undocumented features like that.

Yes, a few more advanced features are not documented, but that is far from being "no documentation".

Anthony

[Anthony]

And to be fair, ldap is a contrib module, and there is quite a bit of documentation in the module itself. For example:

    If you need group control from ldap to web2py app's database feel free
    to set:

        auth.settings.login_methods.append(ldap_auth(...as usual...,
            manage_groups=True,
            db=db,
            group_dn='ou=Groups,dc=domain,dc=com',
            group_name_attrib='cn',
            group_member_attrib='memberUid',
            group_filterstr='objectClass=*'
           ))

        Where:
        manage_group - let web2py handle the groups from ldap
        db - is the database object (need to have auth_user, auth_group,
            auth_membership)
        group_dn - the ldap branch of the groups
        group_name_attrib - the attribute where the group name is stored
        group_member_attrib - the attribute containing the group members name
        group_filterstr - as the filterstr but for group select

In fact, the book even explicitly directs the reader to the documentation within the module:

See the documentation of ldap_auth in web2py/gluon/contrib/login_methods/ldap_auth.py

Anthony

[Andrea Fae']

Yes you are right, but there is something in the book, something in the code....no complete full documentation...managed in only one site. It's like it is...I have to accept this. thanks

[António Ramos]

After a while you will go back to the book and say, aha here it is... and then you realize that the "ONES" that made the book did a great job...

That is my story :)

Sem vírus. www.avast.com

--

Resources:
- http://web2py.com
- http://web2py.com/book (Documentation)
- http://github.com/web2py/web2py (Source code)
- https://code.google.com/p/web2py/issues/list (Report Issues)
---
You received this message because you are subscribed to the Google Groups "web2py-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to web2py+unsubscribe@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Andrea Fae']

I completely agree with you about the book. It's very good written.

To unsubscribe from this group and stop receiving emails from it, send an email to web2py+un...@googlegroups.com.

[Anthony]

On Monday, April 24, 2017 at 7:07:29 AM UTC-4, Andrea Fae' wrote:

Yes you are right, but there is something in the book, something in the code....no complete full documentation...managed in only one site. It's like it is...I have to accept this. thanks

You don't have to accept it -- you could make some pull requests to the book repo. ;-)

[jean-mic...@meggitt.com]

Hi,

I'm starting with web2py, it seems a very powerfull tool.

But concerning the documentation, it's difficult to read : in this document (see link above) it's OK from the beginning up to 75%. After the 75% the explainations and the code (in 'code' box) are inverted.

Who is in charge of this, in order to make it readable ?

Thanks.

http://www.web2py.com/books/default/chapter/38/06/la-couche-dabstraction-de-base-de-donnees 

[Dave S]

I think that would be the translator's responsibility; probably missed closing a div or a MarkMin helper somewhere.

Can you use the English version for that chapter?

/dps

[jean-mic...@meggitt.com]

Hi,

First : thank you, it's extacly what I'm searching : to join the translator, to show him.

Second : of course I can read it in English, but it takes a little more time :):)

Thank you for your awswer.

[Richard Vézina]

Translation are a work in progress and the english version of the book is the most accurate up to date... 

You may have better result taking the english version and google translate it... You may consider improving the translation in your native language by forking an submitting PR here : https://github.com/web2py/web2py-book

Thanks

Richard

--

Resources:
- http://web2py.com
- http://web2py.com/book (Documentation)
- http://github.com/web2py/web2py (Source code)
- https://code.google.com/p/web2py/issues/list (Report Issues)
---
You received this message because you are subscribed to the Google Groups "web2py-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to web2py+unsubscribe@googlegroups.com.

[Matt Bockman]

I'm also new to web2py and I have trouble with the documentation. I'm fairly green with python itself so maybe there are better ways to use the documentation or look for things. Sometimes I don't know what things are called or how to search for them. One thing I liked about developing in C++ with Qt is that I could always find a reference page for whatever class I was using that would give very concrete information about it. Sometimes I'm confused about what type a variable is and I often don't know how to even find out what type it is, let alone look up that type in documentation. I've been at it now for about 20 hours so I don't have too much time under my belt. 

I'm still able to build my web application as fast or faster than using no framework with PHP. If I find an improvement to make the documentation I will try to contribute. 

Cheers,

Matt

On Wednesday, April 26, 2017 at 6:57:50 PM UTC-7, jean-mic...@meggitt.com wrote:

[Kiran Subbaraman]

There is another piece of documentation that you may find useful: http://web2py.readthedocs.io/en/latest/ ... this is the API documentation. It hasn't been updated in a while, but holds good for most of the APIs.
You could also open up a ipython console, and use the python `dir` function, or the `?` at the end of the method to get details of the API. You can use the TAB to help with type-ahead, or code lookup.
For example, try this on the ipython console: 
`from gluon import html`
`dir html`
` html.xmlescape?`

I guess you have also tried the search capability in the web2py documentation?

________________________________________
Kiran Subbaraman
http://subbaraman.wordpress.com/about/

--
Resources:
- http://web2py.com
- http://web2py.com/book (Documentation)
- http://github.com/web2py/web2py (Source code)
- https://code.google.com/p/web2py/issues/list (Report Issues)
---
You received this message because you are subscribed to the Google Groups "web2py-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to web2py+un...@googlegroups.com.