Re: using markup inside title elements

Norm Tovey-Walsh <[email protected]> Wed, 23 Sep 2020 13:05:01 +0100

Newsgroups	gmane.text.docbook.apps
Message-ID	<[email protected]>

Peter Eisentraut <[email protected]> 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 <[email protected]>
https://nwalsh.com/

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

signature.asc (application/pgp-signature, 832 B)