doc: start to integrate images. figs/*.pdf -> images/.png converted.
authorng0 <ng0@infotropique.org>
Sun, 10 Sep 2017 17:27:31 +0000 (17:27 +0000)
committerng0 <ng0@infotropique.org>
Sun, 10 Sep 2017 17:27:31 +0000 (17:27 +0000)
contrib/packages/guix/gnunet-doc.scm [new file with mode: 0644]
doc/Makefile.am
doc/figs/Service.pdf [deleted file]
doc/figs/System.pdf [deleted file]
doc/gnunet-c-tutorial.texi
doc/images/gnunet-tutorial-service.png [new file with mode: 0644]
doc/images/gnunet-tutorial-system.png [new file with mode: 0644]

diff --git a/contrib/packages/guix/gnunet-doc.scm b/contrib/packages/guix/gnunet-doc.scm
new file mode 100644 (file)
index 0000000..a2a9a23
--- /dev/null
@@ -0,0 +1,165 @@
+;;; This file is part of GNUnet.
+;;; Copyright (C) 2016, 2017 GNUnet e.V.
+;;;
+;;; GNUnet is free software; you can redistribute it and/or modify
+;;; it under the terms of the GNU General Public License as published
+;;; by the Free Software Foundation; either version 3, or (at your
+;;; option) any later version.
+;;;
+;;; GNUnet is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;;; General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNUnet; see the file COPYING.  If not, write to the
+;;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;;; Boston, MA 02110-1301, USA.
+;;;
+
+(use-modules
+ (ice-9 popen)
+ (ice-9 match)
+ (ice-9 rdelim)
+ (guix packages)
+ (guix build-system gnu)
+ (guix gexp)
+ ((guix build utils) #:select (with-directory-excursion))
+ (guix git-download)
+ (guix utils) ; current-source-directory
+ (gnu packages)
+ (gnu packages aidc)
+ (gnu packages autotools)
+ (gnu packages backup)
+ (gnu packages base)
+ (gnu packages compression)
+ (gnu packages curl)
+ (gnu packages databases)
+ (gnu packages file)
+ (gnu packages gettext)
+ (gnu packages glib)
+ (gnu packages gnome)
+ (gnu packages gnunet)
+ (gnu packages gnupg)
+ (gnu packages gnuzilla)
+ (gnu packages groff)
+ (gnu packages gstreamer)
+ (gnu packages gtk)
+ (gnu packages guile)
+ (gnu packages image)
+ (gnu packages image-viewers)
+ (gnu packages libidn)
+ (gnu packages libunistring)
+ (gnu packages linux)
+ (gnu packages maths)
+ (gnu packages multiprecision)
+ (gnu packages perl)
+ (gnu packages pkg-config)
+ (gnu packages pulseaudio)
+ (gnu packages python)
+ (gnu packages tex)
+ (gnu packages texinfo)
+ (gnu packages tex)
+ (gnu packages tls)
+ (gnu packages video)
+ (gnu packages web)
+ (gnu packages xiph)
+ ((guix licenses) #:prefix license:))
+
+(define %source-dir (string-append (current-source-directory)
+                                   "/../../../"))
+
+(define gnunet-doc
+  (let* ((revision "1")
+         (select? (delay (or (git-predicate
+                              (string-append (current-source-directory)
+                                             "/../../../"))
+                             source-file?))))
+      (package
+      (name "gnunet-doc")
+      (version (string-append "0.10.1-" revision "." "dev"))
+      (source
+       (local-file ;;"../../.."
+                   ;;%source-dir
+                   ;;(string-append (getcwd) "/../../../")
+                   (string-append (getcwd)) ;drrty hack and this assumes one static position FIXME!
+                   #:recursive? #t))
+                   ;;#:select? (git-predicate %source-dir)))
+                   ;;#:select? (force select?)))
+      (build-system gnu-build-system)
+      (inputs
+       `(("glpk" ,glpk)
+         ("gnurl" ,gnurl)
+         ("gstreamer" ,gstreamer)
+         ("gst-plugins-base" ,gst-plugins-base)
+         ("gnutls" ,gnutls) ;Change to gnutls/dane once it is merged.
+         ("libextractor" ,libextractor)
+         ("libgcrypt" ,libgcrypt)
+         ("libidn" ,libidn)
+         ("libmicrohttpd" ,libmicrohttpd)
+         ("libltdl" ,libltdl)
+         ("libunistring" ,libunistring)
+         ("openssl" ,openssl)
+         ("opus" ,opus)
+         ("pulseaudio" ,pulseaudio)
+         ("sqlite" ,sqlite)
+         ("postgresql" ,postgresql)
+         ("mysql" ,mysql)
+         ("zlib" ,zlib)
+         ("perl" ,perl)
+         ("python" ,python) ; tests and gnunet-qr
+         ("jansson" ,jansson)
+         ("nss" ,nss)
+         ("glib" ,glib "bin")
+         ("gmp" ,gmp)
+         ("bluez" ,bluez) ; for optional bluetooth feature
+         ("glib" ,glib)
+         ;;("texlive-minimal" ,texlive-minimal) ; optional.
+         ("texlive" ,texlive)
+         ("libogg" ,libogg)))
+      (native-inputs
+       `(("pkg-config" ,pkg-config)
+         ("autoconf" ,autoconf)
+         ("automake" ,automake)
+         ("gnu-gettext" ,gnu-gettext)
+         ("texinfo" ,texinfo)
+         ("libtool" ,libtool)))
+      (arguments
+       `(#:tests? #f ;Don't run tests
+         #:phases
+         (modify-phases %standard-phases
+           (add-after 'unpack 'autoconf
+             (lambda _
+               (substitute* "bootstrap"
+                 (("contrib/pogen.sh") "sh contrib/pogen.sh"))
+               (for-each (lambda (f) (chmod f #o755))
+                         (find-files "po" ""))
+               (zero? (system* "sh" "bootstrap"))))
+           (replace 'build
+             (lambda _
+               (chdir "doc")
+               (zero? (system* "make" "doc-all-give-me-the-noise"))))
+           (replace 'install
+             (lambda* (#:key outputs #:allow-other-keys)
+               (let* ((out (assoc-ref outputs "out"))
+                      (doc (string-append out "/share/doc/gnunet")))
+                 (mkdir-p doc)
+                 (mkdir-p (string-append doc "/gnunet"))
+                 (install-file "gnunet.pdf" doc)
+                 (install-file "gnunet.info" doc)
+                 (copy-recursively "gnunet"
+                                   (string-append doc
+                                                  "/gnunet"))
+                 (install-file "gnunet-c-tutorial.pdf" doc)
+                 (install-file "gnunet-c-tutorial.info" doc)
+                 (copy-recursively "gnunet-c-tutorial"
+                                   (string-append doc
+                                                  "/gnunet-c-tutorial")))
+               #t)))))
+      (synopsis "Documentation of GNUnet")
+      (description
+       "GNUnet documentation build")
+      (license (list license:fdl1.3+ license:gpl3+))
+      (home-page "https://gnunet.org/"))))
+
+gnunet-doc
index c97e0f6d9fa21c3878ac2cb4ae48c44afa209484..8463c7129584c5d772a4a48d05479d4cdbbdc2d1 100644 (file)
@@ -3,34 +3,38 @@ SUBDIRS = man doxygen
 
 docdir = $(datadir)/doc/gnunet/
 
-gnunet_doc_images = \
-       images/gnunet-gtk-0-10-gns-a-done.png \
-       images/gnunet-gtk-0-10-gns-a.png \
-       images/daemon_lego_block.png \
-       images/gnunet-gtk-0-10-gns.png \
-       images/gnunet-0-10-peerinfo.png \
-       images/gnunet-gtk-0-10-identity.png \
-       images/gnunet-fs-gtk-0-10-star-tab.png \
-       images/gnunet-gtk-0-10.png \
-       images/gnunet-gtk-0-10-download-area.png \
-       images/gnunet-gtk-0-10-search-selected.png \
-       images/gnunet-gtk-0-10-fs-menu.png \
-       images/gnunet-gtk-0-10-traffic.png \
-       images/gnunet-gtk-0-10-fs.png \
-       images/gnunet-namestore-gtk-phone.png \
-       images/gnunet-gtk-0-10-fs-publish-editing.png \
-       images/gnunet-namestore-gtk-vpn.png \
-       images/gnunet-gtk-0-10-fs-published.png \
-       images/gnunet-setup-exit.png \
-       images/gnunet-gtk-0-10-fs-publish.png \
-       images/iceweasel-preferences.png \
-       images/gnunet-gtk-0-10-fs-publish-select.png \
-       images/iceweasel-proxy.png \
-       images/gnunet-gtk-0-10-fs-publish-with-file_0.png \
-       images/service_lego_block.png \
-       images/gnunet-gtk-0-10-fs-publish-with-file.png \
-       images/service_stack.png \
-       images/gnunet-gtk-0-10-fs-search.png
+infoimagedir = $(infodir)/images
+
+dist_infoimage_DATA =                                          \
+       %D%/images/gnunet-gtk-0-10-gns-a-done.png               \
+       %D%/images/gnunet-gtk-0-10-gns-a.png                    \
+       %D%/images/daemon_lego_block.png                        \
+       %D%/images/gnunet-gtk-0-10-gns.png                      \
+       %D%/images/gnunet-0-10-peerinfo.png                     \
+       %D%/images/gnunet-gtk-0-10-identity.png                 \
+       %D%/images/gnunet-fs-gtk-0-10-star-tab.png              \
+       %D%/images/gnunet-gtk-0-10.png                          \
+       %D%/images/gnunet-gtk-0-10-download-area.png            \
+       %D%/images/gnunet-gtk-0-10-search-selected.png          \
+       %D%/images/gnunet-gtk-0-10-fs-menu.png                  \
+       %D%/images/gnunet-gtk-0-10-traffic.png                  \
+       %D%/images/gnunet-gtk-0-10-fs.png                       \
+       %D%/images/gnunet-namestore-gtk-phone.png               \
+       %D%/images/gnunet-gtk-0-10-fs-publish-editing.png       \
+       %D%/images/gnunet-namestore-gtk-vpn.png                 \
+       %D%/images/gnunet-gtk-0-10-fs-published.png             \
+       %D%/images/gnunet-setup-exit.png                        \
+       %D%/images/gnunet-gtk-0-10-fs-publish.png               \
+       %D%/images/iceweasel-preferences.png                    \
+       %D%/images/gnunet-gtk-0-10-fs-publish-select.png        \
+       %D%/images/iceweasel-proxy.png                          \
+       %D%/images/gnunet-gtk-0-10-fs-publish-with-file_0.png   \
+       %D%/images/service_lego_block.png                       \
+       %D%/images/gnunet-gtk-0-10-fs-publish-with-file.png     \
+       %D%/images/service_stack.png                            \
+       %D%/images/gnunet-gtk-0-10-fs-search.png                \
+       %D%/images/gnunet-tutorial-service.png                  \
+       %D%/images/gnunet-tutorial-system.png
 
 gnunet_tutorial_examples =                                     \
        001.c                                                   \
@@ -74,7 +78,6 @@ gnunet_TEXINFOS = \
 
 EXTRA_DIST = \
        $(gnunet_TEXINFOS) \
-       $(gnunet_doc_images) \
        $(gnunet_tutorial_examples) \
        outdated-and-old-installation-instructions.txt \
        gnunet-c-tutorial-v1.pdf \
diff --git a/doc/figs/Service.pdf b/doc/figs/Service.pdf
deleted file mode 100644 (file)
index e9569cc..0000000
Binary files a/doc/figs/Service.pdf and /dev/null differ
diff --git a/doc/figs/System.pdf b/doc/figs/System.pdf
deleted file mode 100644 (file)
index 70dc6ff..0000000
Binary files a/doc/figs/System.pdf and /dev/null differ
index 2e4bd9a45ee083e01138879e7bbc8edbfa2cfb91..4f56ae5c4971f81fb24684ed35abea3f3cb55fd0 100644 (file)
@@ -228,6 +228,12 @@ a DHT).
 @c** FXIME: See comment above.
 @c** See figure ~\ref{fig:interaction} for an illustration of this approach.
 
+@c ** @image{filename[, width[, height[, alttext[, extension]]]]}
+
+@image{images/gnunet-tutorial-service,,5in,Service with API and network protocol,.png}
+
+@image{images/gnunet-tutorial-system,,5in,The layered system architecture of GNUnet,.png}
+
 @c \begin{figure}[!h]
 @c   \begin{center}
 @c %  \begin{subfigure}
diff --git a/doc/images/gnunet-tutorial-service.png b/doc/images/gnunet-tutorial-service.png
new file mode 100644 (file)
index 0000000..6daed2f
Binary files /dev/null and b/doc/images/gnunet-tutorial-service.png differ
diff --git a/doc/images/gnunet-tutorial-system.png b/doc/images/gnunet-tutorial-system.png
new file mode 100644 (file)
index 0000000..8b54e16
Binary files /dev/null and b/doc/images/gnunet-tutorial-system.png differ