Re: An XSLT example script

From: Jürgen Purtz <juergen(at)purtz(dot)de>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: An XSLT example script
Date: 2020-04-21 19:23:33
Message-ID: 70b3d49f-0a27-852d-8eef-b0f9fd5dac66@purtz.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On 21.04.20 20:10, Peter Eisentraut wrote:
> On 2020-04-14 10:03, Jürgen Purtz wrote:
>> The example "XSLT Stylesheet for Converting SQL/XML Output to HTML" is
>> tagged as <figure>, but it isn't a figure, it's an example script.
>
> It's not an example, it's an actual script that you are supposed to use.
>
>> The
>> PDF output contains lists for examples, figures and tables and shows it
>> in the wrong list. We should change the tagging.
>
> Why is it wrong to make this a figure?
>
Sorry, I don't understand. Do we speak about the same position in the
documentation?

https://www.postgresql.org/docs/12/functions-xml.html#XSLT-XML-HTML

Scripts usually are tagged as "screen", "programmlisting", "example",
"synopsis/function" (for functions) - but never as a figure. The
introductory text explicitly says "As an example ...". Therefor
"example" seems to be appropriate. IMO "programmlisting" is also possible.

And: there is no single graphical element like a line, a circle, a
color, or an UML-symbol.

--

Jürgen Purtz

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Rui Hai Jiang 2020-04-22 07:52:39 Document format issues: characters are overlapping in the header of some tables
Previous Message Bruce Momjian 2020-04-21 19:04:55 Re: An XSLT example script