Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-ua-dev] BuildHelpIndex ant task problem in 3.2

Just to clarify what Curtis said below, for 3.2 we will use Eclipse
platform support for content types that will look past the file extension
and peek into the DOCTYPE to see if it is of the XHTML variety. Having a
DOCTYPE is a reasonable request and most web documents have it.

Curtis, I think the idea with meta tag is good because it would allow us to
shortcut any processing. Since it is in HEAD, we could look for it before
passing the file to XHTML->XHTML transformation. Today, for each XHTML file
we need to build the DOM, walk it, look for elements we care about
(filters, includes, anchors etc.). Do we still dump the DOM into the output
stream if we don't find any? Either way, it would be much faster if we
would be able to look at the meta tag and exit right there if the value is
'false'.

For best performance, I would keep static documents as HTML and only
convert to XHTML if I need dynamic. With the new content type support we
are working on, it should not be difficult to do - just convert the HTML
document to XHTML (same file extension) as needed.

Regards,

Dejan Glozic, Ph.D.
Manager, Eclipse Development 1A
D1/R0Q/8200/MKM
IBM Canada Ltd.
Tel. 905 413-2745  T/L 969-2745
Fax. 905 413-4850



                                                                           
             Curtis                                                        
             D'Entremont/Toron                                             
             to/IBM@IBMCA                                               To 
             Sent by:                  "Eclipse Platform User Assistance   
             platform-ua-dev-b         component developers list."         
             ounces@xxxxxxxxxx         <platform-ua-dev@xxxxxxxxxxx>       
             g                                                          cc 
                                       platform-ua-dev@xxxxxxxxxxx,        
                                       platform-ua-dev-bounces@xxxxxxxxxxx 
             04/07/2006 10:41                                      Subject 
             AM                        Re: [platform-ua-dev]               
                                       BuildHelpIndex ant task problem in  
                                       3.2                                 
             Please respond to                                             
             "Eclipse Platform                                             
              User Assistance                                              
                 component                                                 
             developers list."                                             
             <platform-ua-dev@                                             
               eclipse.org>                                                
                                                                           
                                                                           





Hi Pierre,

Glad to hear things are working out.

What if xhtml documents with dynamic content had a specific "dynamic
content" meta tag in their head element:
ex: <meta name="DynamicContent" content="true"/>

Would it be better, performance wise?

It certainly would. This is one option we thought about and we might use
this in the future. For now we're in end-game 3.2 so probably not enough
time to do this.

I wonder if Internet Explorer is XHTML 1.0 compliant...

I don't think it's 100% but it seems ok for most purposes. Everything I've
thrown at it so far it seems to accept, with the exception of a few things
like having an XML declaration at the top <?xml ...> (it shows the XML
markup).

Thanks,
Curtis d'Entremont
Eclipse User Assistance
IBM Toronto Lab

Phone: (905) 413-5754
E-Mail: curtispd@xxxxxxxxxx



                                                                           
 "pierre _" <pican123@xxxxxxxxxxx>                                         
 Sent by:                                                                  
 platform-ua-dev-bounces@xxxxxxxxxxx                                    To 
                                                   platform-ua-dev@eclipse 
                                                   .org                    
 07/04/2006 03:25 AM                                                    cc 
                                                                           
                                                                   Subject 
              Please respond to                    Re: [platform-ua-dev]   
      "Eclipse Platform User Assistance            BuildHelpIndex ant task 
         component developers list."               problem in 3.2          
        <platform-ua-dev@xxxxxxxxxxx>                                      
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           





Hi Curtis,
thank you so much for answering all my questions. I feel better already :)
Integrating our doc plugin into Eclipse 3.2 won't be as complicated as I
first imagined.
I added some comments to your answers.
Regards,
Pierre

>Shouldn't you rather detect xhtml documents that use dynamic content
>specific markup?
>
>- It can, but there would be a significant performance cost. For example,
>if you only have one instance of dynamic content at the very end of your
>long document, it has to scan through the entire document just to find out
>whether it has dynamic content.

You're absolutely right.

What if xhtml documents with dynamic content had a specific "dynamic
content" meta tag in their head element:
ex: <meta name="DynamicContent" content="true"/>

Would it be better, performance wise?

>- While it is true that it now contains eclipse-specific content, browsers
>must still be able to handle the xhtml and ignore the extra
>eclipse-specific content. So it should not break any browsers as long as
>they're compliant.

I wonder if Internet Explorer is XHTML 1.0 compliant...

Btw, how are you gonna overcome the problem mentioned at the bottom of this

page:
http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-doc-home/docs/EclipseStyle.htm


>Can xhtml files and html files coexist in the same documentation plugin?
>
>- Yes.

Then the XHTML conversion tool will have to be really careful when (and if)

link updating is implemented:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=135069

So as to not change a link from a non-javadoc file to a javadoc file, for
instance.


_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev
_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev




Back to the top