Syntax diagrams in user documentation

Поиск
Список
Период
Сортировка
От Peter Geoghegan
Тема Syntax diagrams in user documentation
Дата
Msg-id CAH2-Wzmfc+P3pC_u1DsgM3LawURzKx5PqZmxtGLgSXBf8gFs8A@mail.gmail.com
обсуждение исходный текст
Ответы Re: Syntax diagrams in user documentation  (Alvaro Herrera <alvherre@2ndquadrant.com>)
Re: Syntax diagrams in user documentation  (Christopher Browne <cbbrowne@gmail.com>)
Re: Syntax diagrams in user documentation  (Jeremy Schneider <schnjere@amazon.com>)
Re: Syntax diagrams in user documentation  (Chapman Flack <chap@anastigmatix.net>)
Список pgsql-hackers
SQLite has a bubble generator tool that they use to generate syntax
diagrams for their documentation:

https://www.sqlite.org/docsrc/doc/tip/art/syntax/bubble-generator.tcl?mimetype=text/plain

I think that the results are rather good. See, for example, the INSERT
documentation:

https://www.sqlite.org/lang_insert.html

Now that we have infrastructure that can add images to our
documentation, we may want to consider something like this. Note that
Bison has an option that outputs a grammar as a Graphviz dot file:

https://www.gnu.org/software/bison/manual/html_node/Graphviz.html

It's probably not possible to create a useful visualization/syntax
diagram with Bison's --graph option, but it might at least be an
interesting starting point.

I don't think that it's necessary to discuss this now. This can be a
placeholder thread that we may come back to when we're all less busy.
-- 
Peter Geoghegan



В списке pgsql-hackers по дате отправления:

Предыдущее
От: Thomas Munro
Дата:
Сообщение: Re: patch to allow disable of WAL recycling
Следующее
От: Alvaro Herrera
Дата:
Сообщение: Re: Syntax diagrams in user documentation