> On 24. Jun 2019, at 08:20, Palaraja, Kavindra <[email protected]> wrote: > > Hi Andre, > > I'm really curious -- why is it bad to make WebEngine mandatory for anything > that passes as "Qt Creator's Help Integration”?
- QtWebEngine is a big beast - and browsing help only needs a small subset of the actual features of QtWebEngine - we do not want the “connect to the internet” part in Qt Creator, since that has lots of implications (security, privacy), and a help viewer doesn’t need it either. > I'm asking because, these days, many Software companies spend a lot of time, > energy, and money in making their documentation look and feel good. This > includes not just the large chunks of content that's published, but also the > in-line text, UI strings, tooltips, etc. They believe that it adds to the > developer experience. > > The Qt Project has a unique opportunity here, in that we have our own IDE, > which is a luxury. And there's also a way to use an existing module, > WebEngine, to improve this look and feel (among other reasons). So why > shouldn't we use it? > > Have you seen Qt Creator's Help Integration recently? > * It doesn't render 1:1 with the default style that is used on > https://doc.qt.io Yes, the style has to be changed for QTextBrowser. Partly that is a limitation of QTextBrowser (like the issues below), partly offline documentation integrated into an application should look different than the online variant anyhow (like not having the Google search). > * It can't display the borders for tables - so every single table looks > weird as all borders are stripped out. Qt's documentation is full of tables. > * It doesn't scale images accordingly, so you have manually guess what > Creator can display and try really hard to shrink your diagrams without > losing clarity > > Is this really what we want to showcase to our customers? Well, what I’d really like would be a lightweight RichText / HTML+CSS viewer without all the baggage of a complete internet browser. QTextBrowser does too little, QtWebEngine much too much. Br, Eike > Kavindra. > > On 23.06.19, 19:09, "Development on behalf of André Pönitz" > <[email protected] on behalf of [email protected]> wrote: > > On Fri, Jun 21, 2019 at 01:05:32PM +0000, Simon Hausmann wrote: >> Would we provide a menu in the start menu for "Qt documentation" that >> would launch the web server and then the user preferred web browser with >> that url? How is the server terminated? >> >> >> Either way, this requires developing either a new frontend application >> first or a back-end that can do the index searches, etc. >> >> >> To me it seems easier to solve this first by making the Qt Assistant use >> WebEngine and when we later have a better doc "frontend" (as web app) >> switch to that and potentially an external browser. > > As that this does not make WebEngine mandatory for anyhthing that passes > as "Qt Creator's Help integration"... > > Andre' > _______________________________________________ > Development mailing list > [email protected] > https://lists.qt-project.org/listinfo/development > > > > ________________________________ > > This e-mail and any attachment(s) are intended only for the recipient(s) > named above and others who have been specifically authorized to receive them. > They may contain confidential information. If you are not the intended > recipient, please do not read this email or its attachment(s). Furthermore, > you are hereby notified that any dissemination, distribution or copying of > this e-mail and any attachment(s) is strictly prohibited. If you have > received this e-mail in error, please immediately notify the sender by > replying to this e-mail and then delete this e-mail and any attachment(s) or > copies thereof from your system. Thank you. > _______________________________________________ > Development mailing list > [email protected] > https://lists.qt-project.org/listinfo/development -- Eike Ziller Principal Software Engineer The Qt Company GmbH Rudower Chaussee 13 D-12489 Berlin [email protected] http://qt.io Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B _______________________________________________ Development mailing list [email protected] https://lists.qt-project.org/listinfo/development
