DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

Daniil Titov
    Please review a fix for the doc bug.
   
    The fix does the following:
        1. Removes empty <ul> elements.
        2. Adds an outer <ul> element to the index section .
        3. Removes obsolete in HTML5 “summary” attribute in <table> elements.
        4. Removes empty <p> elements.
        5. Replaces not supported in HTML5 “bgcolor” attribute for <body> element with “style="background-color”” attribute.
        6. Removes <dd> element in  ConstantSetNode  (there is no outer <dl> element in this case)
        7. Adds required by accessibility audits “lang” attribute for <html> element.
   
    Testing:
           1. Built the docs target and looked at the resulting jdwp-protocol.html.
           2. Tested that is passes validation with tidy
           3. Tested it passes accessibility audits with Accessibility Developer Tool (Chrome)
           
   
    Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
    Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.01
   
    Thanks,
    Daniil
   
   
   
   


Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

serguei.spitsyn@oracle.com
Hi Daniil,

The fix looks good to me.
Thank you for taking care about this!

Thanks,
Serguei


On 12/22/17 09:39, Daniil Titov wrote:

>      Please review a fix for the doc bug.
>      
>      The fix does the following:
>          1. Removes empty <ul> elements.
>          2. Adds an outer <ul> element to the index section .
>          3. Removes obsolete in HTML5 “summary” attribute in <table> elements.
>          4. Removes empty <p> elements.
>          5. Replaces not supported in HTML5 “bgcolor” attribute for <body> element with “style="background-color”” attribute.
>          6. Removes <dd> element in  ConstantSetNode  (there is no outer <dl> element in this case)
>          7. Adds required by accessibility audits “lang” attribute for <html> element.
>      
>      Testing:
>             1. Built the docs target and looked at the resulting jdwp-protocol.html.
>             2. Tested that is passes validation with tidy
>             3. Tested it passes accessibility audits with Accessibility Developer Tool (Chrome)
>            
>      
>      Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
>      Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.01
>      
>      Thanks,
>      Daniil
>      
>      
>      
>      
>
>

Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

Alex Menkov-2
In reply to this post by Daniil Titov
Hi Daniil,

AbstractTypeListNode.java:

-            writer.println("<dd><table border=1 cellpadding=3
cellspacing=0 width=\"90%\" summary=\"\"><tr>");
+            writer.println("<dd><table border=1 cellpadding=3
cellspacing=0 width=\"90%\"><tr>");

border, cellpadding, cellspacing, width are also unsupported in HTML5
It's unclear why tidy doesn't report them.
Could you try to run W3 validator (https://validator.w3.org/)

--alex


On 12/22/2017 09:39, Daniil Titov wrote:

>      Please review a fix for the doc bug.
>      
>      The fix does the following:
>          1. Removes empty <ul> elements.
>          2. Adds an outer <ul> element to the index section .
>          3. Removes obsolete in HTML5 “summary” attribute in <table> elements.
>          4. Removes empty <p> elements.
>          5. Replaces not supported in HTML5 “bgcolor” attribute for <body> element with “style="background-color”” attribute.
>          6. Removes <dd> element in  ConstantSetNode  (there is no outer <dl> element in this case)
>          7. Adds required by accessibility audits “lang” attribute for <html> element.
>      
>      Testing:
>             1. Built the docs target and looked at the resulting jdwp-protocol.html.
>             2. Tested that is passes validation with tidy
>             3. Tested it passes accessibility audits with Accessibility Developer Tool (Chrome)
>            
>      
>      Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
>      Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.01
>      
>      Thanks,
>      Daniil
>      
>      
>      
>      
>
>
Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

Daniil Titov
In reply to this post by Daniil Titov
Thank you, Alex!

Please review a new version of the patch that fixes these W3 validator issues.

In addition to the previous changes the fix does:
1. Replaces cellpadding, cellspacing, border and width attributes for table, td and th elements with internal CSS
2. Replaces <a name=”..”> elements with id attribute on the nearest container element.
   
Testing:
    1. Built the docs target and looked at the resulting jdwp-protocol.html.
    2. Tested that it passes validation with tidy
    3. Tested that it passes validation with W3 validator (https://validator.w3.org/)
    4. Tested that it passes accessibility audits with Accessibility Developer Tool (Chrome)


Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.02
New jdwp-protocol.html : http://cr.openjdk.java.net/~dtitov/8187448/doc/new/jdwp-protocol.html
Old jdwp-protocol.html: http://cr.openjdk.java.net/~dtitov/8187448/doc/old/jdwp-protocol.html


Best regards,
Daniil

On 1/8/18, 11:06 AM, "serviceability-dev on behalf of Alex Menkov" <[hidden email] on behalf of [hidden email]> wrote:

    Hi Daniil,
   
    AbstractTypeListNode.java:
   
    -            writer.println("<dd><table border=1 cellpadding=3
    cellspacing=0 width=\"90%\" summary=\"\"><tr>");
    +            writer.println("<dd><table border=1 cellpadding=3
    cellspacing=0 width=\"90%\"><tr>");
   
    border, cellpadding, cellspacing, width are also unsupported in HTML5
    It's unclear why tidy doesn't report them.
    Could you try to run W3 validator (https://validator.w3.org/)
   
    --alex
   
   
    On 12/22/2017 09:39, Daniil Titov wrote:
    >      Please review a fix for the doc bug.
    >      
    >      The fix does the following:
    >          1. Removes empty <ul> elements.
    >          2. Adds an outer <ul> element to the index section .
    >          3. Removes obsolete in HTML5 “summary” attribute in <table> elements.
    >          4. Removes empty <p> elements.
    >          5. Replaces not supported in HTML5 “bgcolor” attribute for <body> element with “style="background-color”” attribute.
    >          6. Removes <dd> element in  ConstantSetNode  (there is no outer <dl> element in this case)
    >          7. Adds required by accessibility audits “lang” attribute for <html> element.
    >      
    >      Testing:
    >             1. Built the docs target and looked at the resulting jdwp-protocol.html.
    >             2. Tested that is passes validation with tidy
    >             3. Tested it passes accessibility audits with Accessibility Developer Tool (Chrome)
    >            
    >      
    >      Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
    >      Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.01
    >      
    >      Thanks,
    >      Daniil
    >      
    >      
    >      
    >      
    >
    >
   
   


Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

serguei.spitsyn@oracle.com
Hi Daniil,

It looks good to me.
Thank you for fixing these extra issues!

Thanks,
Serguei


On 1/8/18 18:49, Daniil Titov wrote:

> Thank you, Alex!
>
> Please review a new version of the patch that fixes these W3 validator issues.
>
> In addition to the previous changes the fix does:
> 1. Replaces cellpadding, cellspacing, border and width attributes for table, td and th elements with internal CSS
> 2. Replaces <a name=”..”> elements with id attribute on the nearest container element.
>    
> Testing:
>      1. Built the docs target and looked at the resulting jdwp-protocol.html.
>      2. Tested that it passes validation with tidy
>      3. Tested that it passes validation with W3 validator (https://validator.w3.org/)
>      4. Tested that it passes accessibility audits with Accessibility Developer Tool (Chrome)
>
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
> Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.02
> New jdwp-protocol.html : http://cr.openjdk.java.net/~dtitov/8187448/doc/new/jdwp-protocol.html
> Old jdwp-protocol.html: http://cr.openjdk.java.net/~dtitov/8187448/doc/old/jdwp-protocol.html
>
>
> Best regards,
> Daniil
>
> On 1/8/18, 11:06 AM, "serviceability-dev on behalf of Alex Menkov" <[hidden email] on behalf of [hidden email]> wrote:
>
>      Hi Daniil,
>      
>      AbstractTypeListNode.java:
>      
>      -            writer.println("<dd><table border=1 cellpadding=3
>      cellspacing=0 width=\"90%\" summary=\"\"><tr>");
>      +            writer.println("<dd><table border=1 cellpadding=3
>      cellspacing=0 width=\"90%\"><tr>");
>      
>      border, cellpadding, cellspacing, width are also unsupported in HTML5
>      It's unclear why tidy doesn't report them.
>      Could you try to run W3 validator (https://validator.w3.org/)
>      
>      --alex
>      
>      
>      On 12/22/2017 09:39, Daniil Titov wrote:
>      >      Please review a fix for the doc bug.
>      >
>      >      The fix does the following:
>      >          1. Removes empty <ul> elements.
>      >          2. Adds an outer <ul> element to the index section .
>      >          3. Removes obsolete in HTML5 “summary” attribute in <table> elements.
>      >          4. Removes empty <p> elements.
>      >          5. Replaces not supported in HTML5 “bgcolor” attribute for <body> element with “style="background-color”” attribute.
>      >          6. Removes <dd> element in  ConstantSetNode  (there is no outer <dl> element in this case)
>      >          7. Adds required by accessibility audits “lang” attribute for <html> element.
>      >
>      >      Testing:
>      >             1. Built the docs target and looked at the resulting jdwp-protocol.html.
>      >             2. Tested that is passes validation with tidy
>      >             3. Tested it passes accessibility audits with Accessibility Developer Tool (Chrome)
>      >
>      >
>      >      Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
>      >      Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.01
>      >
>      >      Thanks,
>      >      Daniil
>      >
>      >
>      >
>      >
>      >
>      >
>      
>      
>
>

Reply | Threaded
Open this post in threaded view
|

Re: DOC RFR: 8187448: 360 doc issues in jdwp-protocol.html

Alex Menkov-2
+1

--alex

On 01/08/2018 19:11, [hidden email] wrote:

> Hi Daniil,
>
> It looks good to me.
> Thank you for fixing these extra issues!
>
> Thanks,
> Serguei
>
>
> On 1/8/18 18:49, Daniil Titov wrote:
>> Thank you, Alex!
>>
>> Please review a new version of the patch that fixes these W3 validator
>> issues.
>>
>> In addition to the previous changes the fix does:
>> 1. Replaces cellpadding, cellspacing, border and width attributes for
>> table, td and th elements with internal CSS
>> 2. Replaces <a name=”..”> elements with id attribute on the nearest
>> container element.
>> Testing:
>>      1. Built the docs target and looked at the resulting
>> jdwp-protocol.html.
>>      2. Tested that it passes validation with tidy
>>      3. Tested that it passes validation with W3 validator
>> (https://validator.w3.org/)
>>      4. Tested that it passes accessibility audits with Accessibility
>> Developer Tool (Chrome)
>>
>>
>> Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
>> Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.02
>> New jdwp-protocol.html :
>> http://cr.openjdk.java.net/~dtitov/8187448/doc/new/jdwp-protocol.html
>> Old jdwp-protocol.html:
>> http://cr.openjdk.java.net/~dtitov/8187448/doc/old/jdwp-protocol.html
>>
>>
>> Best regards,
>> Daniil
>>
>> On 1/8/18, 11:06 AM, "serviceability-dev on behalf of Alex Menkov"
>> <[hidden email] on behalf of
>> [hidden email]> wrote:
>>
>>      Hi Daniil,
>>      AbstractTypeListNode.java:
>>      -            writer.println("<dd><table border=1 cellpadding=3
>>      cellspacing=0 width=\"90%\" summary=\"\"><tr>");
>>      +            writer.println("<dd><table border=1 cellpadding=3
>>      cellspacing=0 width=\"90%\"><tr>");
>>      border, cellpadding, cellspacing, width are also unsupported in
>> HTML5
>>      It's unclear why tidy doesn't report them.
>>      Could you try to run W3 validator (https://validator.w3.org/)
>>      --alex
>>      On 12/22/2017 09:39, Daniil Titov wrote:
>>      >      Please review a fix for the doc bug.
>>      >
>>      >      The fix does the following:
>>      >          1. Removes empty <ul> elements.
>>      >          2. Adds an outer <ul> element to the index section .
>>      >          3. Removes obsolete in HTML5 “summary” attribute in
>> <table> elements.
>>      >          4. Removes empty <p> elements.
>>      >          5. Replaces not supported in HTML5 “bgcolor” attribute
>> for <body> element with “style="background-color”” attribute.
>>      >          6. Removes <dd> element in  ConstantSetNode  (there is
>> no outer <dl> element in this case)
>>      >          7. Adds required by accessibility audits “lang”
>> attribute for <html> element.
>>      >
>>      >      Testing:
>>      >             1. Built the docs target and looked at the
>> resulting jdwp-protocol.html.
>>      >             2. Tested that is passes validation with tidy
>>      >             3. Tested it passes accessibility audits with
>> Accessibility Developer Tool (Chrome)
>>      >
>>      >
>>      >      Bug: https://bugs.openjdk.java.net/browse/JDK-8187448
>>      >      Webrev: http://cr.openjdk.java.net/~dtitov/8187448/webrev.01
>>      >
>>      >      Thanks,
>>      >      Daniil
>>      >
>>      >
>>      >
>>      >
>>      >
>>      >
>>
>>
>