Re: [O] Documentation fix

[Colin Baxter]

Dear Nicolas,

>>>>> "NG" == Nicolas Goaziou <address@hidden> writes:

    NG> Hello, Colin Baxter <address@hidden> writes:

    >> I've appended (inline) the warnings associated with the
    >> documentation output of 'make all', removing extraneous output.
    >> 
    >> ---- Begin -------- org-version: 9.0.7
    >> (release_9.0.7-478-g30ceb5) makeinfo --no-split org.texi -o org
    >> makeinfo --html --number-sections --no-split -o org.html org.texi
    >> texi2pdf --batch --clean --expand org.texi -:1267: warning:
    >> @itemx should not begin @table -:1345: warning: @table has text
    >> but no @item

    NG> [...]

    >> 
    >> The 'make all' process continues satisfactorily to its
    >> conclusion.

    NG> These are innocuous warnings.

    >> Deleting the 'x' from 'itemx' in org.texi at the lines
    >> corresponding to the warnings '@itemx should not begin @table',
    >> that is, at lines 1267, 7819, 10342, removes those
    >> warnings. That's all the patch did.

    NG> This would be wrong. The @orgcmd macro above already introduces
    NG> @item, so the second one really needs to be @itemx.

Yes, I see that.

    NG> One solution would be to replace the @itemx ... with @xorgkey,
    NG> @xorgcmd, or @xorgcmdnki depending on the needs. But then, it
    NG> would fall-back to the other warning, i.e., a @table without any
    NG> @item (all are @orgsomething macros).

    NG> I'm no Texinfo expert, so I'm not sure what is the best way to
    NG> handle this. Maybe also create a special macro that would create
    NG> a table. It sounds convoluted, though.

I'll look at this more carefully and see what I can do - if anything. It
will have to wait until I have the time, though.

Best wishes,

Colin.

-- 
--
Colin Baxter
address@hidden
GnuPG fingerprint: 68A8 799C 0230 16E7 BF68  2A27 BBFA 2492 91F5 41C8