Skip to content
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.

Sign up for GitHub

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

Jump to bottom

User-level documentation #692

Open
hijarian opened this issue Oct 7, 2013 · 1 comment
Open

User-level documentation #692

hijarian opened this issue Oct 7, 2013 · 1 comment
Assignees
@hijarian
Labels
announcement enhancement
Milestone
Backlog

Comments

@hijarian
Copy link
Contributor

hijarian commented Oct 7, 2013

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.
@ghost ghost assigned hijarian Oct 7, 2013
@hijarian hijarian mentioned this issue Oct 7, 2013
Closed
hijarian added a commit that referenced this issue Oct 7, 2013
@hijarian
Introduced an example of how the end-user documentation would like fo…
695e146 
…r CKEditor widget.

re #692
hijarian added a commit that referenced this issue Oct 7, 2013
@hijarian
Added a first draft for converter from XML documentation to PHP page …
25caff7 
…for documentation website.

re #692
@hijarian
Copy link
Contributor Author

hijarian commented Oct 7, 2013

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
@hijarian
Several additions to XML->PHP transformation
36e0d8f 
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 "yiidoc" element support to XML->PHP transformation.
4ee1446 
re #692
hijarian added a commit that referenced this issue Oct 18, 2013
@hijarian
Added support for property list building in XML->PHP transformation
bae17d9 
re #692

Also added support for `a` and `em` tags.
hijarian added a commit that referenced this issue Oct 18, 2013
@hijarian
Moved XML documentation to subfolders along with the example snippets.
e888d3b 
re #692
hijarian added a commit that referenced this issue Oct 18, 2013
@hijarian
Added support for github-issue element in XML documentation.
51f6b1a 
re #692
hijarian added a commit that referenced this issue Oct 18, 2013
@hijarian
Introduced a clean script and removed generated PHP files from `.giti…
91701da 
…gnore`

re #692
hijarian added a commit that referenced this issue Oct 18, 2013
@hijarian
Added XML documentation and examples for TbHighCharts
5c36258 
re #692

It will be added to documentation website, too.
hijarian added a commit that referenced this issue Oct 18, 2013
@hijarian
Added documentation for TbRedactorJs
1d3fb7e 
re #692
@amrbedair amrbedair modified the milestones: Backlog, 3.0.0 May 8, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hijarian hijarian

Labels
announcement enhancement
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
2 participants
@hijarian @amrbedair