Horton

Re: Add A Glossary

Fabien COELHO <coelho@cri.ensmp.fr>

View thread View on postgr.es
From: Fabien COELHO <coelho@cri.ensmp.fr>
To: Justin Pryzby <pryzby@telsasoft.com>
Cc: Alvaro Herrera <alvherre@2ndquadrant.com>, Erik Rijkers <er@xs4all.nl>, Corey Huinker <corey.huinker@gmail.com>, Jürgen Purtz <juergen@purtz.de>, Roger Harkavy <rogerharkavy@gmail.com>, pgsql-hackers@postgresql.org, Michael Paquier <michael@paquier.xyz>
Date: 2020-04-04T06:55:05Z
Lists: pgsql-hackers, pgsql-docs 
> BTW it's now visible at:
> https://www.postgresql.org/docs/devel/glossary.html

Awesome! Linking beetween defs and to relevant sections is great.

BTW, I'm in favor of "an SQL" because I pronounce it "ess-kew-el", but I 
guess that people who say "sequel" would prefer "a SQL". Failing that, I'm 
fine with some heterogeneity, life is diverse!

ISTM that occurrences of these words elsewhere in the documentation should 
link to the glossary definitions?

As the definitions are short and to the point, maybe the HTML display 
could (also) "hover" the definitions when the mouse passes over the word, 
using the "title" attribute?

"ACID" does not appear as an entry, nor in the acronyms sections. Also no 
DCL, although DML & DDL are in acronyms.

Entries could link to relevant wikipedia pages, like the acronyms section 
does?

-- 
Fabien.

Commits

  1. Glossary: Add term "base backup"

  2. Minor glossary tweaks

  3. Adjust some glossary terms

  4. Fix more typos and grammar problems in the glossary

  5. Review of the glossary

  6. Add a glossary to the documentation