docbook-apps

  • 1.  Problem with "\" in WebHelp Search

    Posted 06-05-2013 16:31
    Hi all,

    We recently started using the DocBook WebHelp templates to create an HTML version of our manuals that includes a search function. So far, the search function works great, but we noticed the sidebar disappears if your search query includes a backslash (\). You also can't get the sidebar back unless you clear your browser cache completely and restart the browser. Has anyone encountered this problem before and, hopefully, fixed the issue?

    We're using DocBook 1.78.0. Please let me know if you need any more information.

    Regards,
    Morgan




  • 2.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 17:01
    Hi Morgan,

    What browser does this happen in? I'm not able to reproduce this issue using the 1.78.1 stylesheets. I tried in IE9 and FireFox 18.




    ---
    David Goss, M.A.
    Technical Writer, Laboratory Division
    Frontier Science & Technology Research Foundation
    4033 Maple Road
    Amherst, NY 14226
    (716) 834-0900 x7218




  • 3.  RE: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 17:29
    We’ve been testing this on Firefox 21.0. However, I just tested this in IE9 and found the sidebar disappears when you search for a backslash (/) as well. Very strange.

    Regards,
    Morgan

    From: David Goss [mailto:goss@fstrf.org]
    Sent: June-05-13 1:01 PM
    To: Morgan Hayward
    Cc: docbook-apps@lists.oasis-open.org
    Subject: Re: [docbook-apps] Problem with "\" in WebHelp Search

    Hi Morgan,

    What browser does this happen in? I'm not able to reproduce this issue using the 1.78.1 stylesheets. I tried in IE9 and FireFox 18.


    ---
    David Goss, M.A.
    Technical Writer, Laboratory Division
    Frontier Science & Technology Research Foundation
    4033 Maple Road
    Amherst, NY 14226
    (716) 834-0900 x7218

    ________________________________
    From: "Morgan Hayward" <MorganHayward@ruggedcom.com<mailto:MorganHayward@ruggedcom.com>>
    To: docbook-apps@lists.oasis-open.org<mailto:docbook-apps@lists.oasis-open.org>
    Sent: Wednesday, June 5, 2013 12:30:33 PM
    Subject: [docbook-apps] Problem with "\" in WebHelp Search
    Hi all,

    We recently started using the DocBook WebHelp templates to create an HTML version of our manuals that includes a search function. So far, the search function works great, but we noticed the sidebar disappears if your search query includes a backslash (\). You also can’t get the sidebar back unless you clear your browser cache completely and restart the browser. Has anyone encountered this problem before and, hopefully, fixed the issue?

    We’re using DocBook 1.78.0. Please let me know if you need any more information.

    Regards,
    Morgan





  • 4.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 18:31
    On 06/05/2013 12:28 PM, Morgan Hayward wrote:
    > We’ve been testing this on Firefox 21.0. However, I just tested this in
    > IE9 and found the sidebar disappears when you search for a backslash (/)
    > as well. Very strange.

    Indeed, I'm seeing that behavior in the current snapshot build:

    http://snapshots.docbook.org/xsl/webhelp/docs/?textToSearch=this+\+that#

    Should be easy enough to fix by removing / and \ from the search string.
    I'll take a look.

    David



  • 5.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 18:37
    On Wed, Jun 5, 2013 at 2:30 PM, David Cramer <david@thingbag.net> wrote:

    > On 06/05/2013 12:28 PM, Morgan Hayward wrote:
    > > We’ve been testing this on Firefox 21.0. However, I just tested this in
    > > IE9 and found the sidebar disappears when you search for a backslash (/)
    > > as well. Very strange.
    >
    > Indeed, I'm seeing that behavior in the current snapshot build:
    >
    > http://snapshots.docbook.org/xsl/webhelp/docs/?textToSearch=this+\+that#
    >
    >
    Hmm.. noticed the issue with this string. May be we are not escaping the
    characters of the search string? If not, we should. There may be other
    character than backslash where this might occur!

    Kasun


    > Should be easy enough to fix by removing / and \ from the search string.
    > I'll take a look.
    >
    > David
    >
    > ---------------------------------------------------------------------
    > To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
    > For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
    >
    >


    --
    ~~~*******'''''''''''''*******~~~
    *Kasun Gajasinghe*
    Software Engineer; WSO2 Inc.; http://wso2.com,
    *linked-in: *http://lk.linkedin.com/in/gajasinghe*
    *
    *blog: **http://blog.kasunbg.org* <http://blog.kasunbg.org/>

    *
    twitter: **http://twitter.com/kasunbg* <http://twitter.com/kasunbg>



  • 6.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 18:42

    On Wednesday, June 5, 2013 20:30 CEST, David Cramer <david@thingbag.net> wrote:

    > On 06/05/2013 12:28 PM, Morgan Hayward wrote:
    > > We’ve been testing this on Firefox 21.0. However, I just tested this in
    > > IE9 and found the sidebar disappears when you search for a backslash (/)
    > > as well. Very strange.
    >
    > Indeed, I'm seeing that behavior in the current snapshot build:
    >
    > http://snapshots.docbook.org/xsl/webhelp/docs/?textToSearch=this+\+that#
    >
    > Should be easy enough to fix by removing / and \ from the search string.
    > I'll take a look.
    >

    Sorry, but stripping the / and \ characters from the search strings means that it is not possible to search for pathnames (for example, c:\winnt, or /var/log), windows registry keys, and a bunch of other technical terms that use these characters legitimately.

    Is there a way to work around this problem, for example, by using some escaping characters?

    Robert

    > David
    >
    > ---------------------------------------------------------------------
    > To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
    > For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
    >
    >









  • 7.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 19:02
    This problem does not occur for me in docbook-xsl-ns-1.78.0. I've
    tested my own output in Firefox 21.0 and Chrome 27.0.1453.110 m. Seems
    unlikely that it's a namespace/non-namespace thing.

    About technical terms like /var/log, the search indexer will strip
    most punctuation characters by default, it seems to be stripping / and
    \ from my search strings. Since I'm almost writing about file paths,
    code syntax, and other topics in which punctuation is a crucial part
    of search strings I need the search function to *not* strip
    punctuation. The solution I've used is to customize the Java indexer
    so that it indexes all the content twice, once with the default
    punctuation-stripping behavior, and then again with the punctuation in
    place. As a result, I can find strings like "/var/log" by searching
    for "/var/log," "var," or "log." I think this would make a good
    feature for webhelp but it does require a corresponding customization
    to the JavaScript search UI. It's not a quick change.

    But I don't want to hijack the discussion here.

    Peter

    On Wed, Jun 5, 2013 at 2:42 PM, Fekete Róbert <frobert@balabit.com> wrote:
    >
    > On Wednesday, June 5, 2013 20:30 CEST, David Cramer <david@thingbag.net> wrote:
    >
    >> On 06/05/2013 12:28 PM, Morgan Hayward wrote:
    >> > We’ve been testing this on Firefox 21.0. However, I just tested this in
    >> > IE9 and found the sidebar disappears when you search for a backslash (/)
    >> > as well. Very strange.
    >>
    >> Indeed, I'm seeing that behavior in the current snapshot build:
    >>
    >> http://snapshots.docbook.org/xsl/webhelp/docs/?textToSearch=this+\+that#
    >>
    >> Should be easy enough to fix by removing / and \ from the search string.
    >> I'll take a look.
    >>
    >
    > Sorry, but stripping the / and \ characters from the search strings means that it is not possible to search for pathnames (for example, c:\winnt, or /var/log), windows registry keys, and a bunch of other technical terms that use these characters legitimately.
    >
    > Is there a way to work around this problem, for example, by using some escaping characters?
    >
    > Robert
    >
    >> David
    >>
    >> ---------------------------------------------------------------------
    >> To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
    >> For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
    >>
    >>
    >
    >
    >
    >
    >
    >
    >
    > ---------------------------------------------------------------------
    > To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
    > For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
    >



  • 8.  RE: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 19:40
    Hi Peter,

    If you could share with us what you did, even some breadcrumbs, I would certainly appreciate it. I am far from proficient in Java and would accept any help I can get.

    Regards,
    Morgan




  • 9.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 19:55
    Yeah, I'd be happy to merge in Peter's changes.

    David

    On 06/05/2013 02:40 PM, Morgan Hayward wrote:
    > Hi Peter,
    >
    > If you could share with us what you did, even some breadcrumbs, I would certainly appreciate it. I am far from proficient in Java and would accept any help I can get.
    >
    > Regards,
    > Morgan
    >
    >


  • 10.  Re: [docbook-apps] Problem with "\" in WebHelp Search

    Posted 06-05-2013 19:58
    I'll package the changes I made and share them as soon as I can.

    Peter

    On Wed, Jun 5, 2013 at 3:54 PM, David Cramer <david@thingbag.net> wrote:
    > Yeah, I'd be happy to merge in Peter's changes.
    >
    > David
    >
    > On 06/05/2013 02:40 PM, Morgan Hayward wrote:
    >> Hi Peter,
    >>
    >> If you could share with us what you did, even some breadcrumbs, I would certainly appreciate it. I am far from proficient in Java and would accept any help I can get.
    >>
    >> Regards,
    >> Morgan
    >>
    >>