First SVG graphic - Jürgen Purtz

public inbox for [email protected]  
help / color / mirror / Atom feed

From: Jürgen Purtz <[email protected]>
To: [email protected]
Subject: First SVG graphic
Date: Wed, 21 Nov 2018 13:28:07 +0100
Message-ID: <[email protected]> (raw)

Please find in the attachment a SVG file which shows the internal 
structure of PG's pages and a patch to insert it to "storage.sgml". 
Because this is the first graphic for our documentation many additional 
work must be done. SvgHandling.pdf explains how to create graphics and 
integrate them into the textual description, which definitions are 
actually missing (style guide?), and what problems may occur.

We shall create two new directories: doc/src/sgml/svg (as source 
directory for all svg files) and doc/src/sgml/html/svg. The patch for 
Makefile is also attached - HTML, PDF, and EPUB are tested. There is a 
conceptual problem with single-page HTML. The SVG files keep separate 
and I don't know how to include them into the generated single file 
"postgres.html".

@Committers: If you tend to accept this patch, I will start to create 
wiki-pages and additional documentation pages to describe the 
proceeding. If you reject the patch, please give me a justification.

Kind regards

Jürgen Purtz






diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile
index 74aac01c39..1fb90cc3f3 100644
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -131,10 +131,11 @@ endif
 
 html: html-stamp
 
-html-stamp: stylesheet.xsl postgres.sgml $(ALLSGML)
+html-stamp: stylesheet.xsl postgres.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) $(wordlist 1,2,$^)
 	cp $(srcdir)/stylesheet.css html/
+	cp $(srcdir)/svg/*.svg html/svg/
 	touch $@
 
 htmlhelp: stylesheet-hh.xsl postgres.sgml $(ALLSGML)
@@ -142,7 +143,7 @@ htmlhelp: stylesheet-hh.xsl postgres.sgml $(ALLSGML)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(wordlist 1,2,$^)
 
 # single-page HTML
-postgres.html: stylesheet-html-nochunk.xsl postgres.sgml $(ALLSGML)
+postgres.html: stylesheet-html-nochunk.xsl postgres.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) -o $@ $(wordlist 1,2,$^)
 
@@ -158,11 +159,11 @@ postgres.txt: postgres.html
 postgres.pdf:
 	$(error Invalid target;  use postgres-A4.pdf or postgres-US.pdf as targets)
 
-%-A4.fo: stylesheet-fo.xsl %.sgml $(ALLSGML)
+%-A4.fo: stylesheet-fo.xsl %.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --stringparam paper.type A4 -o $@ $(wordlist 1,2,$^)
 
-%-US.fo: stylesheet-fo.xsl %.sgml $(ALLSGML)
+%-US.fo: stylesheet-fo.xsl %.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --stringparam paper.type USletter -o $@ $(wordlist 1,2,$^)
 
@@ -175,7 +176,7 @@ postgres.pdf:
 ##
 
 epub: postgres.epub
-postgres.epub: postgres.sgml $(ALLSGML)
+postgres.epub: postgres.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) --noout --valid $<
 	$(DBTOEPUB) $<
 
diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml
index 8ef2ac8010..676bb6ecf4 100644
--- a/doc/src/sgml/storage.sgml
+++ b/doc/src/sgml/storage.sgml
@@ -775,6 +775,18 @@ data. Empty in ordinary tables.</entry>
 </tgroup>
 </table>
 
+
+ <para>
+  <mediaobject id="PageLayoutSVG">
+   <imageobject role="html">
+    <imagedata fileref="svg/PageLayout.svg" format="SVG" align="center" />
+   </imageobject>
+   <imageobject role="fo">
+    <imagedata fileref="svg/PageLayout.svg" format="SVG" scale="70" />
+   </imageobject>
+  </mediaobject>
+ </para>
+
  <para>
 
   The first 24 bytes of each page consists of a page header


Attachments:

  [image/svg+xml] PageLayout.svg (3.1K, 2-PageLayout.svg)
  download | view image

  [text/plain] patch.txt (2.5K, 3-patch.txt)
  download | inline diff:
diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile
index 74aac01c39..1fb90cc3f3 100644
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -131,10 +131,11 @@ endif
 
 html: html-stamp
 
-html-stamp: stylesheet.xsl postgres.sgml $(ALLSGML)
+html-stamp: stylesheet.xsl postgres.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) $(wordlist 1,2,$^)
 	cp $(srcdir)/stylesheet.css html/
+	cp $(srcdir)/svg/*.svg html/svg/
 	touch $@
 
 htmlhelp: stylesheet-hh.xsl postgres.sgml $(ALLSGML)
@@ -142,7 +143,7 @@ htmlhelp: stylesheet-hh.xsl postgres.sgml $(ALLSGML)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(wordlist 1,2,$^)
 
 # single-page HTML
-postgres.html: stylesheet-html-nochunk.xsl postgres.sgml $(ALLSGML)
+postgres.html: stylesheet-html-nochunk.xsl postgres.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) -o $@ $(wordlist 1,2,$^)
 
@@ -158,11 +159,11 @@ postgres.txt: postgres.html
 postgres.pdf:
 	$(error Invalid target;  use postgres-A4.pdf or postgres-US.pdf as targets)
 
-%-A4.fo: stylesheet-fo.xsl %.sgml $(ALLSGML)
+%-A4.fo: stylesheet-fo.xsl %.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --stringparam paper.type A4 -o $@ $(wordlist 1,2,$^)
 
-%-US.fo: stylesheet-fo.xsl %.sgml $(ALLSGML)
+%-US.fo: stylesheet-fo.xsl %.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
 	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --stringparam paper.type USletter -o $@ $(wordlist 1,2,$^)
 
@@ -175,7 +176,7 @@ postgres.pdf:
 ##
 
 epub: postgres.epub
-postgres.epub: postgres.sgml $(ALLSGML)
+postgres.epub: postgres.sgml $(ALLSGML) svg/*.svg
 	$(XMLLINT) --noout --valid $<
 	$(DBTOEPUB) $<
 
diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml
index 8ef2ac8010..676bb6ecf4 100644
--- a/doc/src/sgml/storage.sgml
+++ b/doc/src/sgml/storage.sgml
@@ -775,6 +775,18 @@ data. Empty in ordinary tables.</entry>
 </tgroup>
 </table>
 
+
+ <para>
+  <mediaobject id="PageLayoutSVG">
+   <imageobject role="html">
+    <imagedata fileref="svg/PageLayout.svg" format="SVG" align="center" />
+   </imageobject>
+   <imageobject role="fo">
+    <imagedata fileref="svg/PageLayout.svg" format="SVG" scale="70" />
+   </imageobject>
+  </mediaobject>
+ </para>
+
  <para>
 
   The first 24 bytes of each page consists of a page header


  [application/pdf] SvgHandling.pdf (216.9K, 4-SvgHandling.pdf)
  download

  [image/png] ScreenshotPDF.png (76.7K, 5-ScreenshotPDF.png)
  download | view image

view thread (64+ 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: First SVG graphic
  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