docbook-apps

  • 1.  Ideas for GSoC 2011

    Posted 02-10-2011 11:35
    Hi list,

    I was checking out the GSoC 2011 Wiki page for upcoming developments and I had an idea. I think it would also be useful if DB could generate MS Help 3 Help... Anyone interested in that one.

    Greetings,
    Scott

    Scott Speights
    Technical Writer
    --------------------------------------------------------------
    Haufe-Lexware GmbH & Co. KG
    Munzinger Str. 9, D-79111 Freiburg
    Tel. +49 761 898-5313
    E-Mail: scott.speights@haufe-lexware.com
    Internet: http://www.haufe-lexware.com <http://www.haufe-lexware.com/>
    --------------------------------------------------------------
    Kommanditgesellschaft, Sitz und Registergericht Freiburg, HRA 4408
    Komplementäre: Haufe-Lexware Verwaltungs GmbH,
    Sitz und Registergericht Freiburg, HRB 5557; Martin Laqua
    Geschäftsführung: Isabel Blank, Birte Hackenjos, Jörg Frey,
    Matthias Mühe, Markus Reithwiesner, Joachim Rotzinger, Dr. Carsten Thies
    Beiratsvorsitzende: Andrea Haufe





  • 2.  Re: [docbook-apps] Ideas for GSoC 2011

    Posted 02-10-2011 13:08
    I second the motion, but maybe there's not a huge hurry. My 2?:

    Help 3 (official name: Microsoft Help Viewer) is currently used only in
    Visual Studio (and MSDN, in some form) -- MS does not yet consider it a
    general purpose replacement for HTML Help.

    Help 3 design is still a moving target. The original design was
    minimalist in the extreme - no keyword index or search, I think. After a
    lot of complaints from the user community, the MS Help 3 team recently
    added many new features (in the latest Visual Studio 2010 Service Pack).

    That said, Help 3 seems likely to eventually take hold. And since the
    outputs will be mostly straight XHTML, maybe it's not too risky to get
    started on the DocBook stylesheets.

    Cheers,
    Denis

    On 02/10/2011 06:34 AM, Speights, Scott wrote:
    > Hi list,
    >
    > I was checking out the GSoC 2011 Wiki page for upcoming developmentsand
    > I hadanidea. I think it would also be useful if DB could generate MS
    > Help 3 Help…Anyone interested in that one.
    >
    > Greetings,
    >
    > Scott
    >
    > Scott Speights
    >
    > Technical Writer
    >
    > --------------------------------------------------------------
    >
    > Haufe-Lexware GmbH & Co.KG
    >
    > Munzinger Str. 9, D-79111 Freiburg
    >
    > Tel. +49 761 898-5313
    >
    > E-Mail: scott.speights@haufe-lexware.com
    >
    > Internet:_____http://www.haufe-lexware.com_<http://www.haufe-lexware.com/>
    >
    > --------------------------------------------------------------
    >
    > Kommanditgesellschaft, Sitz und Registergericht Freiburg, HRA 4408
    >
    > Komplementäre: Haufe-Lexware Verwaltungs GmbH,
    >
    > Sitz und Registergericht Freiburg, HRB 5557; MartinLaqua
    >
    > Geschäftsführung: Isabel Blank, Birte Hackenjos, Jörg Frey,
    >
    > Matthias Mühe, Markus Reithwiesner, Joachim Rotzinger, Dr. Carsten Thies
    >
    > Beiratsvorsitzende: Andrea Haufe
    >





  • 3.  Re: [docbook-apps] Ideas for GSoC 2011

    Posted 02-10-2011 15:46
    Denis Bradford wrote:

    > That said, Help 3 seems likely to eventually take hold. And since the
    > outputs will be mostly straight XHTML, maybe it's not too risky to get
    > started on the DocBook stylesheets.

    Or we can decide not to wait for MS and build just packaging to Web
    Widgets, or Air, or iPad, or Android application, or... of WebHelp
    output. Almost any platform now supports applications written purely in
    HTML, CSS and Javascript and packaged for easy installation. This is
    something worth to explore. And it is more "sexy" then boring
    VisualStudio help ;-)

    Jirka

    --
    ------------------------------------------------------------------
    Jirka Kosek e-mail: jirka@kosek.cz http://xmlguru.cz
    ------------------------------------------------------------------
    Professional XML consulting and training services
    DocBook customization, custom XSLT/XSL-FO document processing
    ------------------------------------------------------------------
    OASIS DocBook TC member, W3C Invited Expert, ISO JTC1/SC34 member
    ------------------------------------------------------------------




  • 4.  Re: [docbook-apps] Ideas for GSoC 2011

    Posted 02-10-2011 16:00
    Amen to that!

    On 02/10/2011 10:45 AM, Jirka Kosek wrote:
    > or... of WebHelp
    > output.Almost any platform now supports applications written purely in
    > HTML, CSS and Javascript and packaged for easy installation. This is
    > something worth to explore. And it is more "sexy" then boring
    > VisualStudio help ;-)






  • 5.  RE: [docbook-apps] Ideas for GSoC 2011

    Posted 02-10-2011 23:12
    I think that's a great idea. It would also be helpful to extend it to
    work as a component in a TomCat environment where Lucene could replace
    the search engine (for larger help environments).

    Larry Rowland




  • 6.  RE: [docbook-apps] Ideas for GSoC 2011

    Posted 02-10-2011 23:26
    Indeed, that's on the list for WebHelp: "Add an option to use Lucene for server-side searches with table of contents state persisted on the server."
    http://wiki.docbook.org/topic/WebHelpGsoc2011

    It would be good for situations where running Eclipse as a war is too heavy and presumably simpler to get working in a variety of app servers than an eclipse.war is.

    David




  • 7.  AW: [docbook-apps] Ideas for GSoC 2011

    Posted 02-11-2011 07:33
    I have to admit the packaging idea for many applications is much cooler than just plain old Visual Studio help. I just thought about the MS help viewer because we use a lot of Microsoft products and, so, there are some good possibilities to do easy integration between our TFS and Share Point. I guess I am a little bit personally motivated.

    Two other reasons why I found Help 3 a good idea is because there is a trend here to use MAML (XML documentation comments) to write real documentation (not just create reference documentation), which I would like to break, and because the package doesn't look too hard to output. So maybe this could be one of the packages in the list even if it is a little bit on the boring side...

    As for the other formats, wrap them up, I'll take them!

    Greetings,
    Scott

    -----Ursprüngliche Nachricht-----
    Von: Cramer, David W (David) [mailto:dcramer@motive.com]
    Gesendet: Freitag, 11. Februar 2011 00:26
    An: Rowland, Larry; Jirka Kosek; denis.bradford@verizon.net
    Cc: docbook-apps@lists.oasis-open.org
    Betreff: RE: [docbook-apps] Ideas for GSoC 2011

    Indeed, that's on the list for WebHelp: "Add an option to use Lucene for server-side searches with table of contents state persisted on the server."
    http://wiki.docbook.org/topic/WebHelpGsoc2011

    It would be good for situations where running Eclipse as a war is too heavy and presumably simpler to get working in a variety of app servers than an eclipse.war is.

    David




  • 8.  Re: [docbook-apps] Ideas for GSoC 2011

    Posted 02-11-2011 09:09
    IMO, I think it's better you add the idea to the ideas page. Because if
    there's a student with relevant skills may grab the idea willing to
    implement it this summer. Whether the idea get through depends on no. of
    factors such as the importance of the project idea, whether there's a mentor
    willing to contribute, and of course the quality of the student proposals
    submitted etc. etc.. Last year, I've got to know from other participants
    that some valuable project ideas didn't get selected because there were no
    mentors available for that particular time. So, your idea may get selected,
    though the priority for this idea seems to be less. I was a GSoC participant
    under DocBook contributing to WebHelp last year.

    On 02/10/2011 10:45 AM, Jirka Kosek wrote:

    > or... of WebHelp
    > output.Almost any platform now supports applications written purely in
    > HTML, CSS and Javascript and packaged for easy installation. This is
    > something worth to explore. And it is more "sexy" then boring
    > VisualStudio help ;-)
    >

    Of course. I'm willing to continue the work from previous year on WebHelp
    under GSoC with my mentor from past year, David. If there's any further
    features/additions you'd like to see in WebHelp, please fill the
    WebHelpGsoc2011 page David provided, in a separate section. The feature
    additions needs to be prioritized based on what needs the most.

    Regards,
    --Kasun

    ~~~*******'''''''''''''*******~~~
    Kasun Gajasinghe,
    University of Moratuwa,
    Sri Lanka.
    Blog: http://kasunbg.blogspot.com
    Twitter: http://twitter.com/kasunbg

    On Fri, Feb 11, 2011 at 1:02 PM, Speights, Scott <
    Scott.Speights@haufe-lexware.com> wrote:

    > I have to admit the packaging idea for many applications is much cooler
    > than just plain old Visual Studio help. I just thought about the MS help
    > viewer because we use a lot of Microsoft products and, so, there are some
    > good possibilities to do easy integration between our TFS and Share Point. I
    > guess I am a little bit personally motivated.
    >
    > Two other reasons why I found Help 3 a good idea is because there is a
    > trend here to use MAML (XML documentation comments) to write real
    > documentation (not just create reference documentation), which I would like
    > to break, and because the package doesn't look too hard to output. So maybe
    > this could be one of the packages in the list even if it is a little bit on
    > the boring side...
    >
    > As for the other formats, wrap them up, I'll take them!
    >
    > Greetings,
    > Scott
    >
    > -----Ursprüngliche Nachricht-----
    > Von: Cramer, David W (David) [mailto:dcramer@motive.com]
    > Gesendet: Freitag, 11. Februar 2011 00:26
    > An: Rowland, Larry; Jirka Kosek; denis.bradford@verizon.net
    > Cc: docbook-apps@lists.oasis-open.org
    > Betreff: RE: [docbook-apps] Ideas for GSoC 2011
    >
    > Indeed, that's on the list for WebHelp: "Add an option to use Lucene for
    > server-side searches with table of contents state persisted on the server."
    > http://wiki.docbook.org/topic/WebHelpGsoc2011
    >
    > It would be good for situations where running Eclipse as a war is too heavy
    > and presumably simpler to get working in a variety of app servers than an
    > eclipse.war is.
    >
    > David
    >
    >