Re: [docbook-apps] using markup inside title elements

From
Norm Tovey-Walsh <>
Date
2020-09-23T12:05:10+00:00
ID
Thread
Re: [docbook-apps] using markup inside title elements
Peter Eisentraut <> writes:
> I have a question whether markup inside title elements is recommended
> practice.

Itâs definitely one of those edge cases that probably depends a lot on
your specific processing expectations. I donât think thereâs anything
wrong with markup in titles, in principle, but youâd want to nail down
all of the rules with care and write tests for them.

> For example, consider text like
>
>     You can use commands <command>foo</command> or
>     <command>bar</command> for this.
>
> Let's say we have a refentry for "foo", so it would be nice to write
>
>     You can use commands <xref linkend="foo-refentry"/> or
>     <command>bar</command> for this.

Iâd probably do this:

    You can use commands <command linkend="foo-refentry"/> or
    <command>bar</command> for this.

                                        Be seeing you,
                                          norm

--
Norman Tovey-Walsh <>
https://nwalsh.com/

> A conservative is a man who believes that nothing should be done for
> the first time.--Alfred E. Wiggam