[jackhill/guix/guix.git] / gnu / packages / documentation.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014, 2018 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2014, 2016 Andreas Enge <andreas@enge.fr>
;;; Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
;;; Copyright © 2016 Roel Janssen <roel@gnu.org>
;;; Copyright © 2016 Thomas Danckaert <post@thomasdanckaert.be>
;;; Copyright © 2017 Kei Kebreau <kkebreau@posteo.net>
;;; Copyright © 2017 Efraim Flashner <efraim@flashner.co.il>
;;; Copyright © 2018 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2019 Mathieu Othacehe <m.othacehe@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix 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 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix 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 GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages documentation)
  #:use-module (guix licenses)
  #:use-module (guix packages)
  #:use-module (guix download)
  #:use-module (guix build-system gnu)
  #:use-module (guix build-system cmake)
  #:use-module (gnu packages)
  #:use-module (gnu packages autotools)
  #:use-module (gnu packages base)
  #:use-module (gnu packages bash)
  #:use-module (gnu packages python)
  #:use-module (gnu packages bison)
  #:use-module (gnu packages docbook)
  #:use-module (gnu packages flex)
  #:use-module (gnu packages graphviz)
  #:use-module (gnu packages gettext)
  #:use-module (gnu packages glib)
  #:use-module (gnu packages perl)
  #:use-module (gnu packages xml))

(define-public asciidoc
  (package
    (name "asciidoc")
    (version "8.6.10")
    (source (origin
              (method url-fetch)
              (uri (string-append "https://github.com/asciidoc/asciidoc/"
                                  "archive/" version ".tar.gz"))
              (file-name (string-append name "-" version ".tar.gz"))
              (sha256
               (base32
                "10xrl1iwyvs8aqm0vzkvs3dnsn93wyk942kk4ppyl6w9imbzhlly"))))
    (build-system gnu-build-system)
    (arguments
     `(#:tests? #f                     ; no 'check' target
       #:phases
       (modify-phases %standard-phases
         (replace 'bootstrap
           (lambda _
             (invoke "autoconf")))
         ;; Some XML-related binaries are required for asciidoc's proper usage.
         ;; Without these, asciidoc fails when parsing XML documents, either
         ;; reporting a missing "xmllint" binary or, when passed the
         ;; "--no-xmllint" option, a missing "xsltproc" binary.
         ;; The following phase enables asciidoc to find some of them.
         (add-before 'configure 'set-xml-binary-paths
                     (lambda* (#:key inputs #:allow-other-keys)
                       (let* ((libxml2 (assoc-ref inputs "libxml2"))
                              (xmllint (string-append libxml2 "/bin/xmllint"))
                              (libxslt (assoc-ref inputs "libxslt"))
                              (xsltproc (string-append libxslt "/bin/xsltproc")))
                         (substitute* "a2x.py"
                           (("XMLLINT = 'xmllint'")
                            (string-append "XMLLINT = '" xmllint "'"))
                           (("XSLTPROC = 'xsltproc'")
                            (string-append "XSLTPROC = '" xsltproc "'")))
                         #t)))
         ;; Make asciidoc use the local docbook-xsl package instead of fetching
         ;; it from the internet at run-time.
         (add-before 'install 'make-local-docbook-xsl
                     (lambda* (#:key inputs #:allow-other-keys)
                       (substitute* (find-files "docbook-xsl" ".*\\.xsl$")
                         (("xsl:import href=\"http://docbook.sourceforge.net/\
release/xsl/current")
                          (string-append
                           "xsl:import href=\""
                           (string-append (assoc-ref inputs "docbook-xsl")
                                          "/xml/xsl/docbook-xsl-"
                                          ,(package-version docbook-xsl)))))
                       #t))
         ;; Do the same for docbook-xml.
         (add-before 'install 'make-local-docbook-xml
                     (lambda* (#:key inputs #:allow-other-keys)
                       (substitute* "docbook45.conf"
                         (("http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd")
                          (string-append (assoc-ref inputs "docbook-xml")
                                         "/xml/dtd/docbook/docbookx.dtd")))
                       #t)))))
    (native-inputs
     `(("autoconf" ,autoconf)))
    (inputs `(("python" ,python-2)
              ("docbook-xml" ,docbook-xml)
              ("docbook-xsl" ,docbook-xsl)
              ("libxml2" ,libxml2)
              ("libxslt" ,libxslt)))
    (home-page "http://asciidoc.org/")
    (synopsis "Text-based document generation system")
    (description
     "AsciiDoc is a text document format for writing notes, documentation,
articles, books, ebooks, slideshows, web pages, man pages and blogs.
AsciiDoc files can be translated to many formats including HTML, PDF,
EPUB, man page.

AsciiDoc is highly configurable: both the AsciiDoc source file syntax and
the backend output markups (which can be almost any type of SGML/XML
markup) can be customized and extended by the user.")
    (license gpl2+)))

(define-public doxygen
  (package
    (name "doxygen")
    (version "1.8.17")
    (home-page "http://www.doxygen.nl/")
    (source (origin
             (method url-fetch)
             (uri (list (string-append home-page "files/doxygen-"
                                       version ".src.tar.gz")
                        (string-append "mirror://sourceforge/doxygen/rel-"
                                       version "/doxygen-" version
                                       ".src.tar.gz")))
             (sha256
              (base32
               "16dmv0gm1x8rvbm82fmjvi213q8fxqxinm75pcf595flya59ific"))
             (patches (search-patches "doxygen-test.patch"
                                      "doxygen-1.8.17-runtests.patch"))))
    (build-system cmake-build-system)
    (native-inputs
     `(("bison" ,bison)
       ("flex" ,flex)
       ("libxml2" ,libxml2)             ;provides xmllint for the tests
       ("python" ,python)))             ;for creating the documentation
    (inputs
     `(("bash" ,bash-minimal)))
    (arguments
     ;; Force cmake to use iconv header from cross-libc instead of the one
     ;; from native libc.
     `(,@(if (%current-target-system)
             '(#:configure-flags
               (list (string-append "-DICONV_INCLUDE_DIR="
                                    (assoc-ref %build-inputs "cross-libc")
                                    "/include")))
             '())
       #:test-target "tests"
       #:phases (modify-phases %standard-phases
                  (add-before 'configure 'patch-sh
                              (lambda* (#:key inputs #:allow-other-keys)
                                (substitute* "src/portable.cpp"
                                  (("/bin/sh")
                                   (string-append
                                    (assoc-ref inputs "bash") "/bin/sh")))
                                #t)))))
    (synopsis "Generate documentation from annotated sources")
    (description "Doxygen is the de facto standard tool for generating
documentation from annotated C++ sources, but it also supports other popular
programming languages such as C, Objective-C, C#, PHP, Java, Python,
IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
and to some extent D.")
    (license gpl3+)))

(define-public doc++
  (package
    (name "doc++")
    (version "3.4.10")
    (source (origin
              (method url-fetch)
              (uri (string-append "https://sourceforge.net/projects/docpp/"
                                  "files/doc++-" version ".tar.gz"))
              (sha256
               (base32
                "0i37zlxl8g352s4hzpdx0657k5x3czh3xcsfr27irc708gb277pn"))
              (patches (search-patches "doc++-include-directives.patch"
                                       "doc++-segfault-fix.patch"))))
    (build-system gnu-build-system)
    (native-inputs
     `(("flex" ,flex)
       ("gettext" ,gettext-minimal)))
    (home-page "http://docpp.sourceforge.net/")
    (synopsis "Documentation system for C, C++, IDL, and Java")
    (description
     "DOC++ is a documentation system for C, C++, IDL, and Java.  It can
generate both TeX output for high-quality hardcopies or HTML output for online
brwosing.  The documentation is extracted directly from the C/C++/IDL source
or Java class files.")
    (license gpl2+)))

(define-public scrollkeeper
  (package
    (name "scrollkeeper")
    (version "0.3.14")
    (source
     (origin
       (method url-fetch)
       (uri (string-append "mirror://sourceforge/scrollkeeper/scrollkeeper/"
                           version "/scrollkeeper-" version ".tar.gz"))
       (sha256
        (base32 "1bfxwxc1ngh11v36z899sz9qam366r050fhkyb5adv65lb1x62sa"))))
    (build-system gnu-build-system)
    (arguments
     `(#:configure-flags
       (list (string-append "--with-xml-catalog="
                            (assoc-ref %build-inputs "docbook-xml")
                            "/xml/dtd/docbook/catalog.xml"))))
    (inputs
     `(("perl" ,perl)
       ("libxml2" ,libxml2)
       ("libxslt" ,libxslt)
       ;; The configure script checks for either version 4.2 or 4.1.2.
       ("docbook-xml" ,docbook-xml-4.2)))
    (native-inputs
     `(("intltool" ,intltool)))
    (home-page "http://scrollkeeper.sourceforge.net/")
    (synopsis "Open Documentation Cataloging Project")
    (description "ScrollKeeper is a cataloging system for documentation on open
systems.  It manages documentation metadata as specified by the Open Source
Metadata Framework and provides a simple API to allow help browsers to find,
sort, and search the document catalog.  It will also be able to communicate
with catalog servers on the Net to search for documents which are not on the
local system.")
    (license lgpl2.1+)))
Commit	Line	Data
436d4d1f	1	;;; GNU Guix --- Functional package management for GNU
189be331	2	;;; Copyright © 2014, 2018 Ludovic Courtès <ludo@gnu.org>
7c853c02	3	;;; Copyright © 2014, 2016 Andreas Enge <andreas@enge.fr>
b4e655e5	4	;;; Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
fa8af53e	5	;;; Copyright © 2016 Roel Janssen <roel@gnu.org>
603308ee	6	;;; Copyright © 2016 Thomas Danckaert <post@thomasdanckaert.be>
3c8ba11a	7	;;; Copyright © 2017 Kei Kebreau <kkebreau@posteo.net>
738d0cd6	8	;;; Copyright © 2017 Efraim Flashner <efraim@flashner.co.il>
ccfe4aa1	9	;;; Copyright © 2018 Tobias Geerinckx-Rice <me@tobias.gr>
21b0ed1f	10	;;; Copyright © 2019 Mathieu Othacehe <m.othacehe@gmail.com>
436d4d1f AE	11	;;;
	12	;;; This file is part of GNU Guix.
	13	;;;
	14	;;; GNU Guix is free software; you can redistribute it and/or modify it
	15	;;; under the terms of the GNU General Public License as published by
	16	;;; the Free Software Foundation; either version 3 of the License, or (at
	17	;;; your option) any later version.
	18	;;;
	19	;;; GNU Guix is distributed in the hope that it will be useful, but
	20	;;; WITHOUT ANY WARRANTY; without even the implied warranty of
	21	;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	22	;;; GNU General Public License for more details.
	23	;;;
	24	;;; You should have received a copy of the GNU General Public License
	25	;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
	26
0573a923 EB	27	(define-module (gnu packages documentation)
0573a923 EB	28	#:use-module (guix licenses)
436d4d1f AE	29	#:use-module (guix packages)
436d4d1f AE	30	#:use-module (guix download)
0573a923	31	#:use-module (guix build-system gnu)
7c853c02	32	#:use-module (guix build-system cmake)
436d4d1f	33	#:use-module (gnu packages)
ccfe4aa1	34	#:use-module (gnu packages autotools)
21b0ed1f	35	#:use-module (gnu packages base)
603308ee	36	#:use-module (gnu packages bash)
0573a923	37	#:use-module (gnu packages python)
436d4d1f	38	#:use-module (gnu packages bison)
fa8af53e	39	#:use-module (gnu packages docbook)
436d4d1f	40	#:use-module (gnu packages flex)
9e57c1b5	41	#:use-module (gnu packages graphviz)
b4e655e5	42	#:use-module (gnu packages gettext)
fa8af53e	43	#:use-module (gnu packages glib)
436d4d1f	44	#:use-module (gnu packages perl)
148585c2	45	#:use-module (gnu packages xml))
0573a923 EB	46
	47	(define-public asciidoc
	48	(package
	49	(name "asciidoc")
ccfe4aa1	50	(version "8.6.10")
0573a923 EB	51	(source (origin
0573a923 EB	52	(method url-fetch)
ccfe4aa1 TGR	53	(uri (string-append "https://github.com/asciidoc/asciidoc/"
	54	"archive/" version ".tar.gz"))
	55	(file-name (string-append name "-" version ".tar.gz"))
0573a923 EB	56	(sha256
0573a923 EB	57	(base32
ccfe4aa1	58	"10xrl1iwyvs8aqm0vzkvs3dnsn93wyk942kk4ppyl6w9imbzhlly"))))
0573a923	59	(build-system gnu-build-system)
dd10ba63 TČ	60	(arguments
	61	`(#:tests? #f ; no 'check' target
	62	#:phases
	63	(modify-phases %standard-phases
8a442e5d MW	64	(replace 'bootstrap
	65	(lambda _
	66	(invoke "autoconf")))
9099a457 KK	67	;; Some XML-related binaries are required for asciidoc's proper usage.
	68	;; Without these, asciidoc fails when parsing XML documents, either
	69	;; reporting a missing "xmllint" binary or, when passed the
	70	;; "--no-xmllint" option, a missing "xsltproc" binary.
	71	;; The following phase enables asciidoc to find some of them.
	72	(add-before 'configure 'set-xml-binary-paths
	73	(lambda* (#:key inputs #:allow-other-keys)
	74	(let* ((libxml2 (assoc-ref inputs "libxml2"))
	75	(xmllint (string-append libxml2 "/bin/xmllint"))
	76	(libxslt (assoc-ref inputs "libxslt"))
	77	(xsltproc (string-append libxslt "/bin/xsltproc")))
	78	(substitute* "a2x.py"
	79	(("XMLLINT = 'xmllint'")
	80	(string-append "XMLLINT = '" xmllint "'"))
	81	(("XSLTPROC = 'xsltproc'")
	82	(string-append "XSLTPROC = '" xsltproc "'")))
	83	#t)))
dd10ba63 TČ	84	;; Make asciidoc use the local docbook-xsl package instead of fetching
	85	;; it from the internet at run-time.
	86	(add-before 'install 'make-local-docbook-xsl
	87	(lambda* (#:key inputs #:allow-other-keys)
	88	(substitute* (find-files "docbook-xsl" ".*\\.xsl$")
	89	(("xsl:import href=\"http://docbook.sourceforge.net/\
	90	release/xsl/current")
	91	(string-append
	92	"xsl:import href=\""
	93	(string-append (assoc-ref inputs "docbook-xsl")
	94	"/xml/xsl/docbook-xsl-"
	95	,(package-version docbook-xsl)))))
3078821d KK	96	#t))
	97	;; Do the same for docbook-xml.
	98	(add-before 'install 'make-local-docbook-xml
	99	(lambda* (#:key inputs #:allow-other-keys)
	100	(substitute* "docbook45.conf"
	101	(("http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd")
	102	(string-append (assoc-ref inputs "docbook-xml")
	103	"/xml/dtd/docbook/docbookx.dtd")))
dd10ba63	104	#t)))))
ccfe4aa1 TGR	105	(native-inputs
ccfe4aa1 TGR	106	`(("autoconf" ,autoconf)))
dd10ba63	107	(inputs `(("python" ,python-2)
3078821d	108	("docbook-xml" ,docbook-xml)
9099a457 KK	109	("docbook-xsl" ,docbook-xsl)
	110	("libxml2" ,libxml2)
	111	("libxslt" ,libxslt)))
ccfe4aa1	112	(home-page "http://asciidoc.org/")
0573a923 EB	113	(synopsis "Text-based document generation system")
	114	(description
	115	"AsciiDoc is a text document format for writing notes, documentation,
	116	articles, books, ebooks, slideshows, web pages, man pages and blogs.
	117	AsciiDoc files can be translated to many formats including HTML, PDF,
	118	EPUB, man page.
	119
	120	AsciiDoc is highly configurable: both the AsciiDoc source file syntax and
	121	the backend output markups (which can be almost any type of SGML/XML
	122	markup) can be customized and extended by the user.")
	123	(license gpl2+)))
436d4d1f AE	124
	125	(define-public doxygen
	126	(package
	127	(name "doxygen")
b34c1258	128	(version "1.8.17")
58c6a93d	129	(home-page "http://www.doxygen.nl/")
436d4d1f AE	130	(source (origin
436d4d1f AE	131	(method url-fetch)
58c6a93d MB	132	(uri (list (string-append home-page "files/doxygen-"
	133	version ".src.tar.gz")
	134	(string-append "mirror://sourceforge/doxygen/rel-"
	135	version "/doxygen-" version
	136	".src.tar.gz")))
436d4d1f AE	137	(sha256
436d4d1f AE	138	(base32
b34c1258 MB	139	"16dmv0gm1x8rvbm82fmjvi213q8fxqxinm75pcf595flya59ific"))
	140	(patches (search-patches "doxygen-test.patch"
	141	"doxygen-1.8.17-runtests.patch"))))
7c853c02	142	(build-system cmake-build-system)
436d4d1f AE	143	(native-inputs
436d4d1f AE	144	`(("bison" ,bison)
ff685049	145	("flex" ,flex)
f826ac47 MB	146	("libxml2" ,libxml2) ;provides xmllint for the tests
f826ac47 MB	147	("python" ,python))) ;for creating the documentation
603308ee	148	(inputs
fb76ef84	149	`(("bash" ,bash-minimal)))
436d4d1f	150	(arguments
21b0ed1f MO	151	;; Force cmake to use iconv header from cross-libc instead of the one
	152	;; from native libc.
	153	`(,@(if (%current-target-system)
	154	'(#:configure-flags
	155	(list (string-append "-DICONV_INCLUDE_DIR="
	156	(assoc-ref %build-inputs "cross-libc")
	157	"/include")))
	158	'())
	159	#:test-target "tests"
603308ee TD	160	#:phases (modify-phases %standard-phases
	161	(add-before 'configure 'patch-sh
	162	(lambda* (#:key inputs #:allow-other-keys)
	163	(substitute* "src/portable.cpp"
	164	(("/bin/sh")
	165	(string-append
	166	(assoc-ref inputs "bash") "/bin/sh")))
	167	#t)))))
35b9e423	168	(synopsis "Generate documentation from annotated sources")
436d4d1f AE	169	(description "Doxygen is the de facto standard tool for generating
	170	documentation from annotated C++ sources, but it also supports other popular
	171	programming languages such as C, Objective-C, C#, PHP, Java, Python,
	172	IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
	173	and to some extent D.")
	174	(license gpl3+)))
b4e655e5 EB	175
	176	(define-public doc++
	177	(package
	178	(name "doc++")
	179	(version "3.4.10")
	180	(source (origin
	181	(method url-fetch)
	182	(uri (string-append "https://sourceforge.net/projects/docpp/"
	183	"files/doc++-" version ".tar.gz"))
	184	(sha256
	185	(base32
	186	"0i37zlxl8g352s4hzpdx0657k5x3czh3xcsfr27irc708gb277pn"))
	187	(patches (search-patches "doc++-include-directives.patch"
	188	"doc++-segfault-fix.patch"))))
	189	(build-system gnu-build-system)
	190	(native-inputs
	191	`(("flex" ,flex)
b94a6ca0	192	("gettext" ,gettext-minimal)))
b4e655e5 EB	193	(home-page "http://docpp.sourceforge.net/")
	194	(synopsis "Documentation system for C, C++, IDL, and Java")
	195	(description
	196	"DOC++ is a documentation system for C, C++, IDL, and Java. It can
	197	generate both TeX output for high-quality hardcopies or HTML output for online
	198	brwosing. The documentation is extracted directly from the C/C++/IDL source
	199	or Java class files.")
	200	(license gpl2+)))
fa8af53e RJ	201
	202	(define-public scrollkeeper
	203	(package
	204	(name "scrollkeeper")
	205	(version "0.3.14")
	206	(source
	207	(origin
	208	(method url-fetch)
de67e922 LF	209	(uri (string-append "mirror://sourceforge/scrollkeeper/scrollkeeper/"
de67e922 LF	210	version "/scrollkeeper-" version ".tar.gz"))
fa8af53e RJ	211	(sha256
	212	(base32 "1bfxwxc1ngh11v36z899sz9qam366r050fhkyb5adv65lb1x62sa"))))
	213	(build-system gnu-build-system)
	214	(arguments
	215	`(#:configure-flags
	216	(list (string-append "--with-xml-catalog="
	217	(assoc-ref %build-inputs "docbook-xml")
	218	"/xml/dtd/docbook/catalog.xml"))))
	219	(inputs
	220	`(("perl" ,perl)
	221	("libxml2" ,libxml2)
	222	("libxslt" ,libxslt)
	223	;; The configure script checks for either version 4.2 or 4.1.2.
	224	("docbook-xml" ,docbook-xml-4.2)))
	225	(native-inputs
	226	`(("intltool" ,intltool)))
	227	(home-page "http://scrollkeeper.sourceforge.net/")
	228	(synopsis "Open Documentation Cataloging Project")
	229	(description "ScrollKeeper is a cataloging system for documentation on open
	230	systems. It manages documentation metadata as specified by the Open Source
	231	Metadata Framework and provides a simple API to allow help browsers to find,
	232	sort, and search the document catalog. It will also be able to communicate
	233	with catalog servers on the Net to search for documents which are not on the
	234	local system.")
	235	(license lgpl2.1+)))