Issue Details (XML | Word | Printable)

Key: LUCENE-1256
Type: Improvement Improvement
Status: Closed Closed
Resolution: Fixed
Priority: Trivial Trivial
Assignee: Doron Cohen
Reporter: Steven Rowe
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Lucene - Java

Changes.html formatting improvements

Created: 01/Apr/08 12:03 AM   Updated: 30/Oct/08 11:20 PM
Return to search
Component/s: Website
Affects Version/s: 2.4
Fix Version/s: 2.4

Time Tracking:
Not Specified

File Attachments:
  File Name Date Attached Attached By Size
Text File Licensed for inclusion in ASF works LUCENE-1256.patch 2008-04-18 08:29 PM Steven Rowe 13 kB
Text File Licensed for inclusion in ASF works LUCENE-1256.patch 2008-04-18 07:36 PM Doron Cohen 12 kB
Text File Licensed for inclusion in ASF works LUCENE-1256.patch 2008-04-02 08:02 PM Steven Rowe 13 kB
Text File Licensed for inclusion in ASF works LUCENE-1256.patch 2008-04-02 06:37 PM Steven Rowe 10 kB
Text File Licensed for inclusion in ASF works LUCENE-1256.patch 2008-04-02 02:56 PM Steven Rowe 9 kB
Text File Licensed for inclusion in ASF works LUCENE-1256.patch 2008-04-01 12:04 AM Steven Rowe 9 kB
Issue Links:
Reference

Lucene Fields: Patch Available
Resolution Date: 20/Apr/08 06:32 PM


 Description  « Hide
Some improvements to the Changes.html generated by the changes2html.pl script via the 'changes-to-html' ant task:
  1. Simplified the Simple stylesheet (removed monospace font specification) and made it the default. The Fancy stylesheet is really hard for me to look at (yellow text on light blue background may provide high contrast with low eye strain, but IMHO it's ugly).
  2. Moved the monospace style from the Simple stylesheet to a new stylesheet named "Fixed Width"
  3. Fixed syntax errors in the Fancy stylesheet, so that it displays as intended.
  4. Added <span style="attrib"> to change attributions.
  5. In the Fancy and Simple stylesheets, change attributions are colored dark green.
  6. Now properly handling change attributions in CHANGES.txt that have trailing periods.
  7. Clicking on an anchor to expand its children now changes the document location to show the children.
  8. Hovering over anchors now causes a tooltip to be displayed - either "Click to expand" or "Click to collapse" - the tooltip changes appropriately after a collapse or expansion.

 All   Comments   Work Log   Change History   Subversion Commits      Sort Order: Ascending order - Click to sort in descending order
[ Permlink | « Hide ]
Steven Rowe added a comment - 01/Apr/08 12:04 AM
Patch implementing above-described changes.

Steven Rowe made changes - 01/Apr/08 12:04 AM
Field Original Value New Value
Attachment LUCENE-1256.patch [ 12378990 ]
Steven Rowe made changes - 01/Apr/08 12:10 AM
Link This issue is related to LUCENE-1157 [ LUCENE-1157 ]
[ Permlink | « Hide ]
Steven Rowe added a comment - 01/Apr/08 12:10 AM
The issue that introduced generation of Changes.html

Steven Rowe made changes - 01/Apr/08 12:11 AM
Component/s Build [ 12311546 ]
Component/s Website [ 12310237 ]
Lucene Fields [Patch Available, New] [New, Patch Available]
[ Permlink | « Hide ]
Steven Rowe added a comment - 02/Apr/08 02:56 PM
Since the Lucene Bugzilla bugs mentioned in CHANGES.txt are no longer present in the Apache Bugzilla database, it doesn't make sense to auto-linkify these any longer.

Instead, this version of the patch links from each mentioned Bugzilla bug number to the JIRA issue that was cloned from it, and includes the JIRA issue name. For example, the following text:

ArrayIndexOutOfBoundsExceptions (patch #9110);

becomes:

ArrayIndexOutOfBoundsExceptions (patch #9110 [LUCENE-35]);


Steven Rowe made changes - 02/Apr/08 02:56 PM
Attachment LUCENE-1256.patch [ 12379141 ]
[ Permlink | « Hide ]
Doron Cohen added a comment - 02/Apr/08 04:24 PM
I didn't try it but from the description it sounds great.
I'll try it over the weekend.
For the fancy stylesheet - I put those colors but no sentiments for them here - please feel free to modify them to your taste..

[ Permlink | « Hide ]
Steven Rowe added a comment - 02/Apr/08 06:37 PM
One last bugfix: item #3.1 under 2.3.0's "New features" section is intended to be understood as a component of item #3. This version of the patch renumbers this item to #4, like all previous versions, but it no longer includes a '1' at the beginning of the item's text, as all previous versions did.

Should hierarchical change item formatting be supported? AFAICT, the above-described item #3.1 is the only occurrence of this phenomenon currently in CHANGES.txt.


Steven Rowe made changes - 02/Apr/08 06:37 PM
Attachment LUCENE-1256.patch [ 12379168 ]
[ Permlink | « Hide ]
Steven Rowe added a comment - 02/Apr/08 08:02 PM
One last feature: added "Expand All" and "Collapse All" buttons at the top of the page.

These buttons are added via Javascript, so they don't appear when Javascript disabled and everything is always expanded.

This version also cleans up some mis-identified change attributions, e.g. "(see #3 above)".


Steven Rowe made changes - 02/Apr/08 08:02 PM
Attachment LUCENE-1256.patch [ 12379178 ]
[ Permlink | « Hide ]
Doron Cohen added a comment - 18/Apr/08 07:36 PM
Patch looks great!
One minor issue the dynamically inserted buttons do not work on IE 6 for me.
I changed that to create them in the static HTML lines and now it works in both IE and FF.
Also modified the colors of the fancy style to be more pleasant and made it default again - for visible separation between the three parts (trunk, last release, older releases).
Attaching the update - will commit soon.
Doron

Doron Cohen made changes - 18/Apr/08 07:36 PM
Attachment LUCENE-1256.patch [ 12380536 ]
Doron Cohen made changes - 18/Apr/08 07:41 PM
Assignee Doron Cohen [ doronc ]
[ Permlink | « Hide ]
Steven Rowe added a comment - 18/Apr/08 08:29 PM - edited
Hi Doron, I like the Fancy stylesheet now - thanks. Attaching a new patch that contains a couple of small changes from your version:
  1. I found a way to fix the bad IE6 behavior with the dynamic Expand All/Collapse All buttons, so I removed your static <input> tags and put the button creation back in the <head><SCRIPT> tag. I prefer this way, because the buttons will not appear at all if javascript is disabled.
  2. Removed an extra copy of styles in ChangesFixedWidthStyle.css
  3. Removed the alternative stylesheets <link> to the Fancy stylesheet (not necessary since it's the default stylesheet)

Steven Rowe made changes - 18/Apr/08 08:29 PM
Attachment LUCENE-1256.patch [ 12380539 ]
[ Permlink | « Hide ]
Doron Cohen added a comment - 18/Apr/08 08:31 PM
I just realized that adding the buttons statically means they are shown also when javascript is disabled and then they do nothing.
I would like to have both - buttons that work also in IE6 and view that is consistent also with javascript disabled.
If this is not possible I think it is more important for IE6 to work properly. Steven?

[ Permlink | « Hide ]
Doron Cohen added a comment - 18/Apr/08 08:38 PM
cool, thanks, that was fast!

[ Permlink | « Hide ]
Steven Rowe added a comment - 18/Apr/08 08:48 PM
I just realized that I didn't save the editor buffer where I removed the extra styles from ChangesFixedWidthStyle.css – somehow, there are three copies of each style in there. Not attaching (yet another) patch - can you manually remove the extras, Doron?

[ Permlink | « Hide ]
Doron Cohen added a comment - 18/Apr/08 08:51 PM
Actually there are now 3 duplicates in ChangesFixedWidthStyle.css - never mind I'll remove that.
Yes now without the setAttribute() it works for me too in IE6 as well.
So I am committing this.

[ Permlink | « Hide ]
Doron Cohen added a comment - 18/Apr/08 08:52 PM - edited
Second time in a row(e) that I am too slow for your fast response...

[ Permlink | « Hide ]
Steven Rowe added a comment - 18/Apr/08 09:14 PM
One tiny display issue I noticed: the Bugzilla issue autolinkification places the </a> tag before the closing right square bracket (']') around the LUCENE-XXXX issue, so the closing bracket is not part of the link text, but it should be.

This occurs on line #389 on changes2html.pl:

. qq!$issue&nbsp;[LUCENE-$jira_issue_num</a>]!

should be

. qq!$issue&nbsp;[LUCENE-$jira_issue_num]</a>!

Again, not including another patch - would you mind fixing this for me, Doron?


[ Permlink | « Hide ]
Doron Cohen added a comment - 19/Apr/08 04:11 PM
sure np

Repository Revision Date User Message
ASF #649949 Sun Apr 20 18:29:15 UTC 2008 doronc LUCENE-1157 and LUCENE-1256: HTML changes log, created automatically from CHANGES.txt.
Files Changed
ADD /lucene/java/trunk/src/site/changes/ChangesFixedWidthStyle.css
MODIFY /lucene/java/trunk/src/site/changes/ChangesSimpleStyle.css
MODIFY /lucene/java/trunk/src/site/changes/ChangesFancyStyle.css
MODIFY /lucene/java/trunk/src/site/changes/changes2html.pl
MODIFY /lucene/java/trunk/CHANGES.txt

[ Permlink | « Hide ]
Doron Cohen added a comment - 20/Apr/08 06:32 PM
Committed, Thanks Steve!

Doron Cohen made changes - 20/Apr/08 06:32 PM
Resolution Fixed [ 1 ]
Lucene Fields [Patch Available, New] [Patch Available]
Status Open [ 1 ] Resolved [ 5 ]
Michael McCandless made changes - 11/Oct/08 12:49 PM
Status Resolved [ 5 ] Closed [ 6 ]
Steven Rowe made changes - 30/Oct/08 11:20 PM
Link This issue relates to LUCENE-1433 [ LUCENE-1433 ]

Powered by a free Atlassian JIRA open source license for Apache Software Foundation. Try JIRA - bug tracking software for your team.
Atlassian JIRA the Professional Issue Tracker. (Enterprise Edition, Version: 3.13.2-#335) - Bug/feature request - Atlassian news - Contact Administrators