You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@wink.apache.org by "Shiva Kumar H R (JIRA)" <ji...@apache.org> on 2010/04/26 08:45:31 UTC
[jira] Created: (WINK-276) Improvements to
docs\Apache_Wink_User_Guide.pdf in v1.1 release
Improvements to docs\Apache_Wink_User_Guide.pdf in v1.1 release
---------------------------------------------------------------
Key: WINK-276
URL: https://issues.apache.org/jira/browse/WINK-276
Project: Wink
Issue Type: Improvement
Components: Documentation
Affects Versions: 1.1
Reporter: Shiva Kumar H R
Fix For: 1.1
In docs\Apache_Wink_User_Guide.pdf that is currently there in trunk:
a) The attractive starting page that was there in v1.0 guide is missing.
b) In the Chapter Bookmarks, the first entry says "Space Details", which is unnecessary and hence should be removed. And the root of the tree is labeled as "Available Pages" while in v1.0 it used to be appropriately labeled as "Apache Wink Developer Guide Contents".
c) The Chapter Bookmarks used to be shown by default in v1.0 guide, while it isn't in v1.1 guide.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (WINK-276) Improvements to
docs\Apache_Wink_User_Guide.pdf in v1.1 release
Posted by "Bryant Luk (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WINK-276?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Bryant Luk reassigned WINK-276:
-------------------------------
Assignee: Bryant Luk
I'll convert the documentation to DocBook format over time. I think this will solve a number of issues:
1) Patchable documentation so that people can submit patches to the docs.
2) More control over the output format.
3) DocBook is used in a few other projects such as OpenJPA and I think their documentation satisifies all the requirements that Shiva said.
4) Different output formats still supported (HTML as multiple pages or single pages, I guess there's some support for ePub, Word doc, OpenOffice doc, etc.).
5) Documentation as part of the source code so that people can modify the documentation on their own
Unless anyone has any objections, please let me know.
I'll try to maintain the exact same content but I think the formatting will be different unless I learn the intricacies of XSLT well enough.
> Improvements to docs\Apache_Wink_User_Guide.pdf in v1.1 release
> ---------------------------------------------------------------
>
> Key: WINK-276
> URL: https://issues.apache.org/jira/browse/WINK-276
> Project: Wink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.1
> Reporter: Shiva Kumar H R
> Assignee: Bryant Luk
>
> In docs\Apache_Wink_User_Guide.pdf that is currently there in trunk:
> a) The attractive starting page that was there in v1.0 guide is missing.
> b) In the Chapter Bookmarks, the first entry says "Space Details", which is unnecessary and hence should be removed. And the root of the tree is labeled as "Available Pages" while in v1.0 it used to be appropriately labeled as "Apache Wink Developer Guide Contents".
> c) The Chapter Bookmarks used to be shown by default in v1.0 guide, while it isn't in v1.1 guide.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (WINK-276) Improvements to
docs\Apache_Wink_User_Guide.pdf in v1.1 release
Posted by "Mike Rheinheimer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WINK-276?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mike Rheinheimer updated WINK-276:
----------------------------------
Fix Version/s: (was: 1.1)
> Improvements to docs\Apache_Wink_User_Guide.pdf in v1.1 release
> ---------------------------------------------------------------
>
> Key: WINK-276
> URL: https://issues.apache.org/jira/browse/WINK-276
> Project: Wink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.1
> Reporter: Shiva Kumar H R
>
> In docs\Apache_Wink_User_Guide.pdf that is currently there in trunk:
> a) The attractive starting page that was there in v1.0 guide is missing.
> b) In the Chapter Bookmarks, the first entry says "Space Details", which is unnecessary and hence should be removed. And the root of the tree is labeled as "Available Pages" while in v1.0 it used to be appropriately labeled as "Apache Wink Developer Guide Contents".
> c) The Chapter Bookmarks used to be shown by default in v1.0 guide, while it isn't in v1.1 guide.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WINK-276) Improvements to
docs\Apache_Wink_User_Guide.pdf in v1.1 release
Posted by "Mike Rheinheimer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WINK-276?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12861088#action_12861088 ]
Mike Rheinheimer commented on WINK-276:
---------------------------------------
Thanks Shiva. From the discussion on the mailing list, it appears someone needs a PDF editor, and to do some hand edits to the PDF exported from the wiki prior to commit. So far, no one has claimed to have an editor, and we want to move forward with the 1.1 release, so I'm postponing this to 1.2.
Thanks!
> Improvements to docs\Apache_Wink_User_Guide.pdf in v1.1 release
> ---------------------------------------------------------------
>
> Key: WINK-276
> URL: https://issues.apache.org/jira/browse/WINK-276
> Project: Wink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.1
> Reporter: Shiva Kumar H R
>
> In docs\Apache_Wink_User_Guide.pdf that is currently there in trunk:
> a) The attractive starting page that was there in v1.0 guide is missing.
> b) In the Chapter Bookmarks, the first entry says "Space Details", which is unnecessary and hence should be removed. And the root of the tree is labeled as "Available Pages" while in v1.0 it used to be appropriately labeled as "Apache Wink Developer Guide Contents".
> c) The Chapter Bookmarks used to be shown by default in v1.0 guide, while it isn't in v1.1 guide.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WINK-276) Improvements to
docs\Apache_Wink_User_Guide.pdf in v1.1 release
Posted by "Shiva Kumar H R (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WINK-276?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12861260#action_12861260 ]
Shiva Kumar H R commented on WINK-276:
--------------------------------------
Sure Mike. Thanks for willing to consider this in v1.2.
> Improvements to docs\Apache_Wink_User_Guide.pdf in v1.1 release
> ---------------------------------------------------------------
>
> Key: WINK-276
> URL: https://issues.apache.org/jira/browse/WINK-276
> Project: Wink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.1
> Reporter: Shiva Kumar H R
>
> In docs\Apache_Wink_User_Guide.pdf that is currently there in trunk:
> a) The attractive starting page that was there in v1.0 guide is missing.
> b) In the Chapter Bookmarks, the first entry says "Space Details", which is unnecessary and hence should be removed. And the root of the tree is labeled as "Available Pages" while in v1.0 it used to be appropriately labeled as "Apache Wink Developer Guide Contents".
> c) The Chapter Bookmarks used to be shown by default in v1.0 guide, while it isn't in v1.1 guide.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (WINK-276) Improvements to
docs\Apache_Wink_User_Guide.pdf in v1.1 release
Posted by "Shiva Kumar H R (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/WINK-276?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12860855#action_12860855 ]
Shiva Kumar H R commented on WINK-276:
--------------------------------------
I recollected the following discussion on dev-list where Michael was mentioning that he manually replaced the additional garbage pages:
http://apache-wink-dev.3470905.n2.nabble.com/VOTE-Release-Wink-1-0-tt3800871.html#a3803646
> Improvements to docs\Apache_Wink_User_Guide.pdf in v1.1 release
> ---------------------------------------------------------------
>
> Key: WINK-276
> URL: https://issues.apache.org/jira/browse/WINK-276
> Project: Wink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.1
> Reporter: Shiva Kumar H R
> Fix For: 1.1
>
>
> In docs\Apache_Wink_User_Guide.pdf that is currently there in trunk:
> a) The attractive starting page that was there in v1.0 guide is missing.
> b) In the Chapter Bookmarks, the first entry says "Space Details", which is unnecessary and hence should be removed. And the root of the tree is labeled as "Available Pages" while in v1.0 it used to be appropriately labeled as "Apache Wink Developer Guide Contents".
> c) The Chapter Bookmarks used to be shown by default in v1.0 guide, while it isn't in v1.1 guide.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.