-
Notifications
You must be signed in to change notification settings - Fork 305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
User-level documentation #692
Comments
Closed
To prevent further possible discussion: no, documentation automatically generated from the docblocks in PHP sources IS NOT the end-user documentation and will never be. YiiBooster will have both of this types of documentation. Also, examples are indispensable in case of UI widgets. |
hijarian
added a commit
that referenced
this issue
Oct 15, 2013
re #692 Added ln, pn, wn, p@label. Corrected formatting in opening PHP block. Removed `ctboost` prefix on sections.
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
re #692 Also added support for `a` and `em` tags.
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
re #692 It will be added to documentation website, too.
hijarian
added a commit
that referenced
this issue
Oct 18, 2013
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Version 3.0.0 (hopefully) will include the user-level documentation right in the YiiBooster sources, so you'll be able to look how to work with each widget without going to documentation website.
It's still in development, but it's decided that the format will be custom XML tailored to be human-readable, and a set of XSLT stylesheets will be present to convert it to standalone HTML pages or probably something else.
Please note that examples obviously require the full Yii-based PHP website set up to be interactive, so for standalone documentation in HTML format an automatically generated screenshots will be used instead.
The text was updated successfully, but these errors were encountered: