You are viewing a plain text version of this content. The canonical link for it is here.
Posted to batik-dev@xmlgraphics.apache.org by bu...@apache.org on 2008/11/13 18:37:16 UTC
DO NOT REPLY [Bug 46202] New: [PATCH] Minor Web site/general
documentation fixes
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
Summary: [PATCH] Minor Web site/general documentation fixes
Product: Batik
Version: 2.0
Platform: All
OS/Version: All
Status: NEW
Severity: trivial
Priority: P5
Component: Web Site
AssignedTo: batik-dev@xmlgraphics.apache.org
ReportedBy: helder.magalhaes@gmail.com
Created an attachment (id=22861)
--> (https://issues.apache.org/bugzilla/attachment.cgi?id=22861)
Documentation fixes
Currently the site documentation (see URL) is missing information for several
latest updates.
The proposed changes include:
* Reflect Java 1.3 support removed
* (revision 666001 ( https://svn.apache.org/viewcvs.cgi?view=rev&rev=666001 ))
* Missing documentation for window.postURL
* (already implemented for a while, just not documented [1])
* Missing documentation for window.location
* (recently implemented [2], revisions 712954, 712955)
* Mention Window Object [3] standard
* (within the scripting support, "status.xml")
* Add JRE as an alternative requirement and add note for JDK regarding
compilation
* (only JDK was listed as requirement in "faq.xml")
* (clearing JDK need for compilation, although intuitive for advanced users,
can be useful for starters)
* References to Batik version 1.6 changed to 1.7
* (although only used for example purposes, 1.7 is around for a while)
[1] http://xmlgraphics.apache.org/batik/status.html#ecmascript
[2] https://issues.apache.org/bugzilla/show_bug.cgi?id=46072
[3] http://www.w3.org/TR/Window/
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
Helder Magalhães <he...@gmail.com> changed:
What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |RESOLVED
Resolution| |FIXED
Status|NEW |RESOLVED
Resolution| |FIXED
--- Comment #6 from Helder Magalhães <he...@gmail.com> 2010-10-05 04:40:47 EDT ---
(In reply to comment #0)
> The proposed changes include:
>
> * Reflect Java 1.3 support removed
> * (revision 666001)
> * Add JRE as an alternative requirement and add note for JDK regarding
> compilation
> * (only JDK was listed as requirement in "faq.xml")
> * (clearing JDK need for compilation, although intuitive for advanced users,
> can be useful for starters)
Done in revision 1004565.
> * Missing documentation for window.postURL
> * (already implemented for a while, just not documented [1])
> * Missing documentation for window.location
> * (recently implemented [2], revisions 712954, 712955)
Done in revision 1004572.
> * Mention Window Object [3] standard
> * (within the scripting support, "status.xml")
Reworked to use the proper SVG 1.2 Tiny DOM interface instead.
> * References to Batik version 1.6 changed to 1.7
> * (although only used for example purposes, 1.7 is around for a while)
Reverted this: using 1.6 for examples is fine.
(In reply to comment #4)
> Duplicating all of the documentation for trunk vs release doesn't seem like a
> nice way to present it, IMO. There aren't that many changes in trunk vs the
> 1.7 release anyway, so perhaps the documentation can reflect trunk
> functionality, but with notes stating if certain aspects are since the release?
> WDYT?
Added a note to the location interface stating it's available since version
1.8. ;-)
> > Apart from this, I recently stumbled at bug 43950, which could also be
> > addressed within this patch. Should it (by creating a bug dependency), or was
> > it better to create two separate patches?
>
> If you could create a separate patch and attach it to that bug, that would be
> better I think.
That issue was (already) fixed in a separate commit. :-)
--- Comment #7 from Helder Magalhães <he...@gmail.com> 2010-10-05 04:40:47 EDT ---
(In reply to comment #0)
> The proposed changes include:
>
> * Reflect Java 1.3 support removed
> * (revision 666001)
> * Add JRE as an alternative requirement and add note for JDK regarding
> compilation
> * (only JDK was listed as requirement in "faq.xml")
> * (clearing JDK need for compilation, although intuitive for advanced users,
> can be useful for starters)
Done in revision 1004565.
> * Missing documentation for window.postURL
> * (already implemented for a while, just not documented [1])
> * Missing documentation for window.location
> * (recently implemented [2], revisions 712954, 712955)
Done in revision 1004572.
> * Mention Window Object [3] standard
> * (within the scripting support, "status.xml")
Reworked to use the proper SVG 1.2 Tiny DOM interface instead.
> * References to Batik version 1.6 changed to 1.7
> * (although only used for example purposes, 1.7 is around for a while)
Reverted this: using 1.6 for examples is fine.
(In reply to comment #4)
> Duplicating all of the documentation for trunk vs release doesn't seem like a
> nice way to present it, IMO. There aren't that many changes in trunk vs the
> 1.7 release anyway, so perhaps the documentation can reflect trunk
> functionality, but with notes stating if certain aspects are since the release?
> WDYT?
Added a note to the location interface stating it's available since version
1.8. ;-)
> > Apart from this, I recently stumbled at bug 43950, which could also be
> > addressed within this patch. Should it (by creating a bug dependency), or was
> > it better to create two separate patches?
>
> If you could create a separate patch and attach it to that bug, that would be
> better I think.
That issue was (already) fixed in a separate commit. :-)
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
Helder Magalhães <he...@gmail.com> changed:
What |Removed |Added
----------------------------------------------------------------------------
Blocks| |50045
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
--- Comment #4 from Cameron McCormack <ca...@apache.org> 2009-03-12 15:41:40 PST ---
(In reply to comment #3)
> I believe there might be interest in breaking this down, in order to allow a
> commit whenever possible and a later commit (potentially creating a separate
> bug report) for dealing with things which only make sense after the next
> release (such as java 1.3 drop and the new window.location interfaces). Does
> this make sense?
It brings up a good point. What version of Batik the site documentation
reflect? In the Status page at least, I have just had it describe whatever the
current SVN trunk can do. FOP has separate pages for trunk vs releases.
Duplicating all of the documentation for trunk vs release doesn't seem like a
nice way to present it, IMO. There aren't that many changes in trunk vs the
1.7 release anyway, so perhaps the documentation can reflect trunk
functionality, but with notes stating if certain aspects are since the release?
WDYT?
> Apart from this, I recently stumbled at bug 43950, which could also be
> addressed within this patch. Should it (by creating a bug dependency), or was
> it better to create two separate patches?
If you could create a separate patch and attach it to that bug, that would be
better I think.
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
--- Comment #2 from Helder Magalhães <he...@gmail.com> 2009-02-19 06:39:05 PST ---
I'm thinking if it would be a good idea to add a FAQ item regarding the out of
memory issues that haunt the mailing list [1] and the bug tracker itself (bug
44164 [2] and , for example). This was also already explicitly asked for in the
mailing list [3].
If it sounds good, I'll be glad to update the current patch. :-)
Regards,
Helder Magalhães
[1]
http://www.nabble.com/forum/Search.jtp?forum=308&local=y&query=out+of+memory
[2] https://issues.apache.org/bugzilla/show_bug.cgi?id=44164
[3] http://www.nabble.com/FAQ---Memory-td13530949.html#a13530949
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
Helder Magalhães <he...@gmail.com> changed:
What |Removed |Added
----------------------------------------------------------------------------
Attachment #22861|0 |1
is obsolete| |
--- Comment #1 from Helder Magalhães <he...@gmail.com> 2009-01-07 10:27:44 PST ---
Created an attachment (id=23093)
--> (https://issues.apache.org/bugzilla/attachment.cgi?id=23093)
Documentation fixes v2
One more added to the previous items:
* Fix typo in
http://xmlgraphics.apache.org/batik/using/scripting/ecmascript.html
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
--- Comment #3 from Helder Magalhães <he...@gmail.com> 2009-03-12 15:30:45 PST ---
I believe there might be interest in breaking this down, in order to allow a
commit whenever possible and a later commit (potentially creating a separate
bug report) for dealing with things which only make sense after the next
release (such as java 1.3 drop and the new window.location interfaces). Does
this make sense?
Apart from this, I recently stumbled at bug 43950, which could also be
addressed within this patch. Should it (by creating a bug dependency), or was
it better to create two separate patches?
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
Helder Magalhães <he...@gmail.com> changed:
What |Removed |Added
----------------------------------------------------------------------------
Keywords| |PatchAvailable
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org
DO NOT REPLY [Bug 46202] [PATCH] Minor Web site/general
documentation fixes
Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=46202
--- Comment #5 from Helder Magalhães <he...@gmail.com> 2009-03-13 10:44:35 PST ---
(In reply to comment #4)
> It brings up a good point. What version of Batik the site documentation
> reflect? In the Status page at least, I have just had it describe whatever
> the current SVN trunk can do. FOP has separate pages for trunk vs releases.
I was generally thinking that the documentation was meant to reflected the last
release, but now that you pointed out the status page, I remember so it seems
that this is unclear (you have my memory refreshed )... :-|
> Duplicating all of the documentation for trunk vs release doesn't seem like a
> nice way to present it, IMO. There aren't that many changes in trunk vs the
> 1.7 release anyway, so perhaps the documentation can reflect trunk
> functionality, but with notes stating if certain aspects are since the
> release?
> WDYT?
My 2 cents go for having the documentation always reflect the trunk status. One
could use something like the @since javadoc keyword for stating newly
introduced features, but I'm not sure if this can become confusing for users.
I also like the idea of only stating the relevant differences of trunk vs. last
release, but this means that changes need to be tracked down whenever a new
version is released...
I'm comfortable with any of these, please post your opinion(s) and I'll try to
review the patch whenever possible.
> If you could create a separate patch and attach it to that bug, that would be
> better I think.
OK, I'll take a look at that whenever possible. ;-)
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: batik-dev-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: batik-dev-help@xmlgraphics.apache.org