docbook-apps

  • 1.  Re: [docbook-apps] manpage/docbook.xsl generated code broken for nroff

    Posted 02-03-2009 21:16
    I don't have a system with plain nroff to test this on, so I'm not clear on
    what exactly the problem is or how to fix it.

    Do you know if the issue is the use of macro
    names longer than two characters, or the use of built-in groff instructions
    that don't work with plain nroff? If it is the former, then it could be
    easily fixed by renaming defined macros, but if it is the latter,
    then it will be harder.

    If you manage to get a new 'define.macros' working, you could submit it for
    inclusion and we could add it to the stylesheet with an option parameter to
    turn it on.

    Bob Stayton
    Sagehill Enterprises
    bobs@sagehill.net





  • 2.  Re: [docbook-apps] manpage/docbook.xsl generated code broken for nroff

    Posted 02-03-2009 21:35

    Am 03.02.2009 um 22:16 schrieb Bob Stayton:

    > I don't have a system with plain nroff to test this on, so I'm not
    > clear on
    > what exactly the problem is or how to fix it.

    If you like I could provide you shell access to a Opensolaris 11/08
    machine.

    > Do you know if the issue is the use of macro
    > names longer than two characters, or the use of built-in groff
    > instructions
    > that don't work with plain nroff?

    The latter. Running `checknr` (a nroff syntax checker) bails out
    numerous times.

    > If it is the former, then it could be
    > easily fixed by renaming defined macros, but if it is the latter,
    > then it will be harder.
    >
    > If you manage to get a new 'define.macros' working, you could submit
    > it for
    > inclusion and we could add it to the stylesheet with an option
    > parameter to
    > turn it on.

    I got one working by completly removing the 4 mentioned macros:
    toupper, SH-xref, SH, SS. See:

    <http://netatalk.cvs.sourceforge.net/viewvc/netatalk/netatalk-docs/manual/man.xsl?revision=1.3&view=markup
    >

    Thanks for helping!

    Regards
    -Ralph


  • 3.  Re: [docbook-apps] manpage/docbook.xsl generated code broken for nroff

    Posted 02-08-2009 08:27
    Ralph Böhme <ralph@rsrc.de>, 2009-02-03 22:34 +0100:

    > Am 03.02.2009 um 22:16 schrieb Bob Stayton:
    > > I don't have a system with plain nroff to test this on, so I'm not clear on
    > > what exactly the problem is or how to fix it.
    >
    > If you like I could provide you shell access to a Opensolaris 11/08 machine.

    That would help me. We have open bugs on this that are assigned to
    me, and I am hoping to get some fixes made and checked in
    relatively soon, and then do a 1.75.0 release after that.

    > > Do you know if the issue is the use of macro
    > > names longer than two characters, or the use of built-in groff instructions
    > > that don't work with plain nroff?
    >
    > The latter. Running `checknr` (a nroff syntax checker) bails out numerous
    > times.

    I hadn't know about that tool. It would be great to have shell
    access to a system where I can run it myself directly, so I can
    test changes and make sure my fixes will working.

    >
    > > If it is the former, then it could be
    > > easily fixed by renaming defined macros, but if it is the latter,
    > > then it will be harder.
    > >
    > > If you manage to get a new 'define.macros' working, you could submit it for
    > > inclusion and we could add it to the stylesheet with an option parameter to
    > > turn it on.
    >
    > I got one working by completly removing the 4 mentioned macros: toupper,
    > SH-xref, SH, SS. See:
    >
    > <http://netatalk.cvs.sourceforge.net/viewvc/netatalk/netatalk-docs/manual/man.xsl?revision=1.3&view=markup>

    So, what I'll probably end up doing is to create a new parameter
    named "man.custom.macros.enabled" (or something) and have it set
    to on by default. Setting it to off will cause the custom macros
    to not be used.

    --Mike

    --
    Michael(tm) Smith
    http://people.w3.org/mike/



  • 4.  Re: [docbook-apps] manpage/docbook.xsl generated code broken for nroff

    Posted 02-08-2009 09:29
    Hi,

    Am 08.02.2009 um 09:27 schrieb Michael(tm) Smith:

    > Ralph Bö?me <ralph@rsrc.de>, 2009-02-03 22:34 +0100:
    >
    >> Am 03.02.2009 um 22:16 schrieb Bob Stayton:
    >>> I don't have a system with plain nroff to test this on, so I'm not
    >>> clear on
    >>> what exactly the problem is or how to fix it.
    >>
    >> If you like I could provide you shell access to a Opensolaris 11/08
    >> machine.
    >
    > That would help me. We have open bugs on this that are assigned to
    > me, and I am hoping to get some fixes made and checked in
    > relatively soon, and then do a 1.75.0 release after that.

    OK. Please send me your ssh pubkey. Login will be then:
    `ssh -p 20024 msmith@85.183.11.35`

    That host is generally not up 24x7 so if you can please tell me at
    what times you're
    gonna be working on this and your TZ.


    >>> Do you know if the issue is the use of macro
    >>> names longer than two characters, or the use of built-in groff
    >>> instructions
    >>> that don't work with plain nroff?
    >>
    >> The latter. Running `checknr` (a nroff syntax checker) bails out
    >> numerous
    >> times.
    >
    > I hadn't know about that tool.

    Well, I'm not sure if it will be useful in the end: it bails out on
    `checknr /usr/share/man/man1/ls.1`
    too. ;o) And it doesn't know the man macros.

    >>> If it is the former, then it could be
    >>> easily fixed by renaming defined macros, but if it is the latter,
    >>> then it will be harder.
    >>>
    >>> If you manage to get a new 'define.macros' working, you could
    >>> submit it for
    >>> inclusion and we could add it to the stylesheet with an option
    >>> parameter to
    >>> turn it on.
    >>
    >> I got one working by completly removing the 4 mentioned macros:
    >> toupper,
    >> SH-xref, SH, SS. See:
    >>
    >> <http://netatalk.cvs.sourceforge.net/viewvc/netatalk/netatalk-docs/manual/man.xsl?revision=1.3&view=markup
    >> >
    >
    > So, what I'll probably end up doing is to create a new parameter
    > named "man.custom.macros.enabled" (or something) and have it set
    > to on by default. Setting it to off will cause the custom macros
    > to not be used.

    What was worrying me is if the generated *roff code relies on and uses
    these macros ? I.e. if I just remove them via a custom XSLT stylesheet
    or if you provide a parameter to turn it off, will the the generated
    *roff code use this macros defitions for its output ? Or are these
    just re-definitions ?

    Regards
    -Ralph





  • 5.  Re: [docbook-apps] manpage/docbook.xsl generated code broken for nroff

    Posted 02-08-2009 09:56
    Ralph Böhme <ralph@rsrc.de>, 2009-02-08 10:29 +0100:

    > OK. Please send me your ssh pubkey. Login will be then:
    > `ssh -p 20024 msmith@85.183.11.35`

    OK, I'll send it shortly.

    > That host is generally not up 24x7 so if you can please tell me
    > at what times you're gonna be working on this and your TZ.

    OK

    > >> I got one working by completly removing the 4 mentioned macros: toupper,
    > >> SH-xref, SH, SS. See:
    > >>
    > >> <http://netatalk.cvs.sourceforge.net/viewvc/netatalk/netatalk-docs/manual/man.xsl?revision=1.3&view=markup>
    >
    > What was worrying me is if the generated *roff code relies on and uses these
    > macros ? I.e. if I just remove them via a custom XSLT stylesheet or if you
    > provide a parameter to turn it off, will the the generated *roff code use
    > this macros defitions for its output ? Or are these just re-definitions ?

    The SH and SS macros are re-definitions. The SH-xref macro is new.
    So there is a call to it in manpages/refentry.xsl that I will need
    to wrap in a conditional. The toupper macro is also new, but it's
    only called by the re-defined SH and SH-xref macros, so simply
    conditionally suppressing those will be enough.

    I'll try to get the changes made and checked in. As soon as I do,
    I'll let you know.

    --Mike

    --
    Michael(tm) Smith
    http://people.w3.org/mike/



  • 6.  Docbook AIR Help

    Posted 02-03-2009 22:39
    Hi all,

    Just wondering if anyone is developing anything for Adobe Air?

    I currently administer both Docbook and DITA projects, and have been following the development of a DITA plugin for creating "AIR Help" with great interest. Adapting the DITA project to provide online, cross-platform help for my Docbook projects is one of my current priorities and I was wondering if anyone else is looking at the same thing.

    For those who have never heard of "AIR Help", it's based on the Adobe AIR platform (which is on its way to being open-sourced). AIR provides the kind of open-ended power to create interactive tools that (IMHO) we're going to need going forward. Even in it's current pre-beta state, Scott Prentice's airhelp app is still far superior to JavaHelp.

    Anyhoo, just wondered: people interested in the Airhelp project could go to:

    http://tech.groups.yahoo.com/group/AIR_Help/

    and

    http://www.leximation.com/airhelp/

    for more information.

    Cheers,
    Jeff.