You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Robert Muir (Created) (JIRA)" <ji...@apache.org> on 2012/03/23 11:53:28 UTC
[jira] [Created] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Similarity javadocs look ugly if created with java7's javadoc
-------------------------------------------------------------
Key: LUCENE-3904
URL: https://issues.apache.org/jira/browse/LUCENE-3904
Project: Lucene - Java
Issue Type: Bug
Components: general/javadocs
Affects Versions: 3.6, 4.0
Reporter: Robert Muir
The captions used to illustrate the formulas are tables here:
in jdk 5/6 the table is centered nicely.
But with java7's javadocs (I think due to some css styles changes?),
the table is not centered but instead stretched.
I think we just need to center this table with a different technique?
Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Posted by "Stefan Matheis (steffkes) (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Stefan Matheis (steffkes) updated LUCENE-3904:
----------------------------------------------
Attachment: Screen Shot 2012-03-23 at 12.38.21 PM.png
I just had quick look .. in [stylesheet.css|http://people.apache.org/~rmuir/java7-style-javadocs/stylesheet.css] on line #345 is a declaration for
{code}.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table {
width:100%;
}{code}
which expands the table. the fix would be to remove this, but i don't know if there are tables which requires this?
In the attached Screenshot, i've modified the Source w/ Chrome Dev-Tools and set {{width: auto}} (see at the right bottom) and it's no longer expanded.
Does this help?
> Similarity javadocs look ugly if created with java7's javadoc
> -------------------------------------------------------------
>
> Key: LUCENE-3904
> URL: https://issues.apache.org/jira/browse/LUCENE-3904
> Project: Lucene - Java
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 3.6, 4.0
> Reporter: Robert Muir
> Attachments: LUCENE-3904.patch, Screen Shot 2012-03-23 at 12.38.21 PM.png
>
>
> The captions used to illustrate the formulas are tables here:
> in jdk 5/6 the table is centered nicely.
> But with java7's javadocs (I think due to some css styles changes?),
> the table is not centered but instead stretched.
> I think we just need to center this table with a different technique?
> Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
> NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Posted by "Stefan Matheis (steffkes) (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13236531#comment-13236531 ]
Stefan Matheis (steffkes) commented on LUCENE-3904:
---------------------------------------------------
bq. Can you review my patch?
+1 looks good
> Similarity javadocs look ugly if created with java7's javadoc
> -------------------------------------------------------------
>
> Key: LUCENE-3904
> URL: https://issues.apache.org/jira/browse/LUCENE-3904
> Project: Lucene - Java
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 3.6, 4.0
> Reporter: Robert Muir
> Attachments: LUCENE-3904.patch, Screen Shot 2012-03-23 at 12.38.21 PM.png, patchScreenShot.jpg
>
>
> The captions used to illustrate the formulas are tables here:
> in jdk 5/6 the table is centered nicely.
> But with java7's javadocs (I think due to some css styles changes?),
> the table is not centered but instead stretched.
> I think we just need to center this table with a different technique?
> Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
> NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Posted by "Robert Muir (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Robert Muir updated LUCENE-3904:
--------------------------------
Attachment: patchScreenShot.jpg
a screenshot of the java7 docs with the patch
> Similarity javadocs look ugly if created with java7's javadoc
> -------------------------------------------------------------
>
> Key: LUCENE-3904
> URL: https://issues.apache.org/jira/browse/LUCENE-3904
> Project: Lucene - Java
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 3.6, 4.0
> Reporter: Robert Muir
> Attachments: LUCENE-3904.patch, Screen Shot 2012-03-23 at 12.38.21 PM.png, patchScreenShot.jpg
>
>
> The captions used to illustrate the formulas are tables here:
> in jdk 5/6 the table is centered nicely.
> But with java7's javadocs (I think due to some css styles changes?),
> the table is not centered but instead stretched.
> I think we just need to center this table with a different technique?
> Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
> NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Resolved] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Posted by "Robert Muir (Resolved) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Robert Muir resolved LUCENE-3904.
---------------------------------
Resolution: Fixed
Fix Version/s: 4.0
3.6
Thanks Stefan
> Similarity javadocs look ugly if created with java7's javadoc
> -------------------------------------------------------------
>
> Key: LUCENE-3904
> URL: https://issues.apache.org/jira/browse/LUCENE-3904
> Project: Lucene - Java
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 3.6, 4.0
> Reporter: Robert Muir
> Fix For: 3.6, 4.0
>
> Attachments: LUCENE-3904.patch, Screen Shot 2012-03-23 at 12.38.21 PM.png, patchScreenShot.jpg
>
>
> The captions used to illustrate the formulas are tables here:
> in jdk 5/6 the table is centered nicely.
> But with java7's javadocs (I think due to some css styles changes?),
> the table is not centered but instead stretched.
> I think we just need to center this table with a different technique?
> Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
> NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Posted by "Robert Muir (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13236530#comment-13236530 ]
Robert Muir commented on LUCENE-3904:
-------------------------------------
Stefan: that was exactly the problem!
Additionally when we had a math formula with something like A/B
(such as the 1/sumOfSquaredWeights^1/2), the text wasn't being centered, but that was more minor.
Can you review my patch?
> Similarity javadocs look ugly if created with java7's javadoc
> -------------------------------------------------------------
>
> Key: LUCENE-3904
> URL: https://issues.apache.org/jira/browse/LUCENE-3904
> Project: Lucene - Java
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 3.6, 4.0
> Reporter: Robert Muir
> Attachments: LUCENE-3904.patch, Screen Shot 2012-03-23 at 12.38.21 PM.png
>
>
> The captions used to illustrate the formulas are tables here:
> in jdk 5/6 the table is centered nicely.
> But with java7's javadocs (I think due to some css styles changes?),
> the table is not centered but instead stretched.
> I think we just need to center this table with a different technique?
> Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
> NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-3904) Similarity javadocs look ugly if
created with java7's javadoc
Posted by "Robert Muir (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-3904?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Robert Muir updated LUCENE-3904:
--------------------------------
Attachment: LUCENE-3904.patch
patch against 3x... i plan to just port forward to trunk.
The problem was that java7's default table style has width:100%, so we need to explicitly set it to auto for these captions.
Additionally we need to ensure the text is actually centered for formulas where we have A/B.
This changes nothing for java5/6 but fixes the issue for java7.
> Similarity javadocs look ugly if created with java7's javadoc
> -------------------------------------------------------------
>
> Key: LUCENE-3904
> URL: https://issues.apache.org/jira/browse/LUCENE-3904
> Project: Lucene - Java
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 3.6, 4.0
> Reporter: Robert Muir
> Attachments: LUCENE-3904.patch
>
>
> The captions used to illustrate the formulas are tables here:
> in jdk 5/6 the table is centered nicely.
> But with java7's javadocs (I think due to some css styles changes?),
> the table is not centered but instead stretched.
> I think we just need to center this table with a different technique?
> Have a look at http://people.apache.org/~rmuir/java7-style-javadocs/org/apache/lucene/search/Similarity.html to see what I mean.
> NOTE: these javadocs are under TFIDFSimilarity.java in trunk.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org