| From: | Karen Jex <karenhjex(at)gmail(dot)com> |
|---|---|
| To: | Daniel Gustafsson <daniel(at)yesql(dot)se> |
| Cc: | Peter Eisentraut <peter(at)eisentraut(dot)org>, "David E(dot) Wheeler" <david(at)justatheory(dot)com>, "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>, xavier_fischer(at)hotmail(dot)fr |
| Subject: | Re: Good beginner doc-hacking task: clear-text vs. cleartext vs. clear text vs. plaintext etc.. |
| Date: | 2026-11-12 16:24:36 |
| Message-ID: | CAOpR_fbWwC9=ni0k1d8_pVDo-uLRSUhaTXsCqS0Pzj=OjTVzTw@mail.gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-docs |
> > Instead, I propose the following glossary
> > entries to define the way in which we're using the terms:
> >
> > plain text
> > Unformatted, human-readable text that consists of a sequence of
> > printable characters in a character encoding such as UTF-8.
> >
> > cleartext
> > Unencrypted data; data that exists in an unprotected, readable format
> > during storage or transmission. Sometimes used as a synonym for
> > plaintext; the input to an encryption algorithm.
>
> Sounds good. I was trying to make the cleartext entry specify that it is
> generally data which is intended as input to processing, but I wasn't
> particularly successful in creating anything which reads better than what you
> have above.
I've created a V2 patch (attached) including the glossary terms, and
with a verbose commit message as suggested by Laurenz.
> I ran a grep on the docs and found the same occurences. I agree with your changes Karen.
Thank you for the review, Xavier.
And thank you, all, for the helpful discussion and suggestions.
Regards,
--
Karen
| Attachment | Content-Type | Size |
|---|---|---|
| v2-0001-Doc-standardise-cleartext-and-plain-text-terms.patch | application/octet-stream | 22.7 KB |
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Karen Jex | 2026-11-12 16:37:25 | Re: Good beginner doc-hacking task: clear-text vs. cleartext vs. clear text vs. plaintext etc.. |
| Previous Message | Daniel Gustafsson | 2026-11-12 12:33:27 | Re: Introductory docs-hacking task: Example markup |