public inbox for [email protected]
help / color / mirror / Atom feedFrom: Jürgen Purtz <[email protected]>
To: [email protected]
Subject: Re: Images in the official documentation
Date: Sun, 25 Feb 2018 18:00:30 +0600
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
As an addition to my mail from January 2016 concerning graphics
(https://www.postgresql.org/message-id/568A9148.30303%40purtz.de) I
propose to use SVG (after switching to XML) - but not an SVG which is
generated by Inkscape or similar tools. Those editors generate very ugly
and chatty commands. This form is not easy to read or understand.
Therefore we shall use nothing but a simple text editor and write every
line by our self. The process is divided into two parts:
As a basis we shall develop an SVG library containing a bunch of
"atomic" symbols of simple graphical elements (rectangle, arrow, ...) up
to complex elements (magnetic disc, laptop, cloud, UML-elements, ...).
The SVG routines creating those symbols shall accept parameters for
position, size, rotation, colour, ... . This library shortens the
individual SVG files, it ensures a consistent rendering of common
graphical elements, it is diff-able, and it will reach a stable state -
some day.
The real graphics shall use the elements of the library and add
individual SVG elements. The rules for this part are the same as above:
create SVG commands with vi (or similar), store it in git.
If such an approach works (we must distribute the docs across a wide
range of different systems, a proof-of-system is necessary) and the
community accepts my proposal, I would like to work on the library-part
- starting after finishing my actual project in about 6 weeks from now.
The attached file contains a very first draft as of Jan. 2016.
Kind regards
Jürgen Purtz
On 23.02.2018 22:14, Daniel Westermann wrote:
> Hi %,
>
> I am working with PostgreSQL documentation quite a few years now and I
> am almost happy. What I think is completely missing (especially if you
> compare to commercial product documentation) are pictures that
> illustrate a topic, e.g. the relation of
> instance->database->user/role->schema->objects.
>
> Is there an agreement not to include that pictures for any reason? I
> can not promise that I find time for that in the near future but if
> that will be appreciated I am willing to spend time on that to make
> the documentation even better.
>
> Regards
> Daniel
Attachments:
[image/svg+xml] pg_lib_basic_objects.svg (1.7K, 3-pg_lib_basic_objects.svg)
download | view image
view thread (23+ messages) latest in thread
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected]
Subject: Re: Images in the official documentation
In-Reply-To: <[email protected]>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox