summaryrefslogtreecommitdiff
path: root/doc/guide
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2016-06-11 18:14:42 +0000
committerrillig <rillig@pkgsrc.org>2016-06-11 18:14:42 +0000
commit231ab25ccebd52538779646f190bab59a178acd4 (patch)
tree3bb62b215c8f64a05956d3bc0c6b155923b778e4 /doc/guide
parent4da4aca5a4425c5e55d62c8aee822d22194ed9a9 (diff)
downloadpkgsrc-231ab25ccebd52538779646f190bab59a178acd4.tar.gz
Migrated the pkgsrc guide to DocBook 4.5.
This allows the use of the <code> element instead of <literal>, and several other enhancements. The formatting specification in default.dsl is necessary because DSSSL does not recognize the <code> element and therefore formats it in red by default.
Diffstat (limited to 'doc/guide')
-rw-r--r--doc/guide/Makefile8
-rw-r--r--doc/guide/Makefile.common6
-rw-r--r--doc/guide/files/Makefile7
-rw-r--r--doc/guide/files/devfaq.xml20
-rw-r--r--doc/guide/files/pkgsrc.xml6
-rw-r--r--doc/guide/files/share/default.dsl6
6 files changed, 32 insertions, 21 deletions
diff --git a/doc/guide/Makefile b/doc/guide/Makefile
index 6607d7229b1..6eeb91dd220 100644
--- a/doc/guide/Makefile
+++ b/doc/guide/Makefile
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.39 2012/10/31 11:25:50 asau Exp $
+# $NetBSD: Makefile,v 1.40 2016/06/11 18:14:42 rillig Exp $
#
DISTNAME= pkgsrc-guide-${PKGVERSION}
@@ -31,6 +31,12 @@ OUTPUTS?= lint html html-split ascii pdf
INSTALLATION_DIRS= ${DOCDIR}
+SUBST_CLASSES+= docbook45
+SUBST_STAGE.docbook45= pre-configure
+SUBST_FILES.docbook45= ${WRKDIR}/htdocs/share/xml/*
+SUBST_SED.docbook45= -e 's,V4\.2,V4.5,'
+SUBST_SED.docbook45+= -e 's,/4\.2/,/4.5/,'
+
.if defined(OUTPUTS)
. if !empty(OUTPUTS:Mascii)
# the html is needed to build the ascii version.
diff --git a/doc/guide/Makefile.common b/doc/guide/Makefile.common
index c25bde72e19..8780f969da2 100644
--- a/doc/guide/Makefile.common
+++ b/doc/guide/Makefile.common
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile.common,v 1.5 2014/10/05 16:41:06 wiz Exp $
+# $NetBSD: Makefile.common,v 1.6 2016/06/11 18:14:42 rillig Exp $
#
# This is included by doc/guide and meta-pkgs/pkgsrc-guide-tools.
#
@@ -13,8 +13,8 @@ _GUIDE_DEPTYPE?= build
_GUIDE_OUTPUTS?= lint html html-split ascii pdf
# html output
-_GUIDE_DEPENDS+= docbook>=4.0:../../textproc/docbook
-_GUIDE_DEPENDS+= docbook-xml>=4.0:../../textproc/docbook-xml
+_GUIDE_DEPENDS+= docbook>=4.5:../../textproc/docbook
+_GUIDE_DEPENDS+= docbook-xml>=4.5:../../textproc/docbook-xml
_GUIDE_DEPENDS+= docbook-xsl>=1.62.4:../../textproc/docbook-xsl
_GUIDE_DEPENDS+= dsssl-docbook-modular>=1.54:../../textproc/dsssl-docbook-modular
_GUIDE_DEPENDS+= opensp>=1.5:../../textproc/opensp
diff --git a/doc/guide/files/Makefile b/doc/guide/files/Makefile
index dda790c78ec..2ccf735abc4 100644
--- a/doc/guide/files/Makefile
+++ b/doc/guide/files/Makefile
@@ -1,6 +1,9 @@
-# $NetBSD: Makefile,v 1.16 2008/02/19 17:21:42 weinem Exp $
+# $NetBSD: Makefile,v 1.17 2016/06/11 18:14:42 rillig Exp $
-WEB_PREFIX?= ${.CURDIR}/../htdocs
+WEB_PREFIX?= ${.CURDIR}/../htdocs
+DBX_XML_CATALOG?= ${SGML_PREFIX}/docbook/4.5/catalog.xml
+DBX_XML_DTD?= ${XML_PREFIX}/docbook/4.5/docbookx.dtd
+DBX_SGML_CATALOG?= ${SGML_PREFIX}/docbook/4.5/catalog
DOC= pkgsrc
diff --git a/doc/guide/files/devfaq.xml b/doc/guide/files/devfaq.xml
index 45788053b93..9066bef2ad7 100644
--- a/doc/guide/files/devfaq.xml
+++ b/doc/guide/files/devfaq.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: devfaq.xml,v 1.13 2014/07/26 11:52:12 wiz Exp $ -->
+<!-- $NetBSD: devfaq.xml,v 1.14 2016/06/11 18:14:42 rillig Exp $ -->
<chapter id="devfaq"> <?dbhtml filename="devfaq.html"?>
<title>Frequently Asked Questions</title>
@@ -79,21 +79,21 @@
<qandaentry id="devfaq.master_sites">
<question><para>What does
- <literal>${MASTER_SITE_SOURCEFORGE:=package/}</literal> mean? I
- don't understand the <literal>:=</literal> inside
+ <code>${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
+ don't understand the <code>:=</code> inside
it.</para></question>
- <answer><para>The <literal>:=</literal> is not really an
- assignment operator, like you might expect at first sight.
+ <answer><para>The <code>:=</code> is not really an
+ assignment operator, although it looks like it.
Instead, it is a degenerate form of
- <literal>${LIST:<replaceable>old_string</replaceable>=<replaceable>new_string</replaceable>}</literal>,
- which is documented in the &man.make.1; man page and which you
- may have seen as in <literal>${SRCS:.c=.o}</literal>. In the
+ <code>${LIST:<replaceable>old_string</replaceable>=<replaceable>new_string</replaceable>}</code>,
+ which is documented in the &man.make.1; man page and which is
+ commonly used in the form <code>${SRCS:.c=.o}</code>. In the
case of <varname>MASTER_SITE_*</varname>,
<replaceable>old_string</replaceable> is the empty string and
<replaceable>new_string</replaceable> is
- <literal>package/</literal>. That's where the
- <literal>:</literal> and the <literal>=</literal> fall
+ <code>package/</code>. That's where the
+ <code>:</code> and the <code>=</code> fall
together.</para></answer>
</qandaentry>
diff --git a/doc/guide/files/pkgsrc.xml b/doc/guide/files/pkgsrc.xml
index 19edc609909..f9aa4b180a3 100644
--- a/doc/guide/files/pkgsrc.xml
+++ b/doc/guide/files/pkgsrc.xml
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
-<!-- $NetBSD: pkgsrc.xml,v 1.29 2016/05/06 17:26:34 jnemeth Exp $ -->
+<!-- $NetBSD: pkgsrc.xml,v 1.30 2016/06/11 18:14:42 rillig Exp $ -->
-<!DOCTYPE book PUBLIC "-//NetBSD//DTD DocBook XML V4.2-Based DocBook Extension//EN" [
+<!DOCTYPE book PUBLIC "-//NetBSD//DTD DocBook XML V4.5-Based DocBook Extension//EN" [
<!ENTITY % man-refs.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Manual Page Entities//EN">
%man-refs.ent;
@@ -47,7 +47,7 @@
<holder role="mailto:www@NetBSD.org">The NetBSD Foundation, Inc</holder>
</copyright>
- <pubdate>$NetBSD: pkgsrc.xml,v 1.29 2016/05/06 17:26:34 jnemeth Exp $</pubdate>
+ <pubdate>$NetBSD: pkgsrc.xml,v 1.30 2016/06/11 18:14:42 rillig Exp $</pubdate>
<abstract>
diff --git a/doc/guide/files/share/default.dsl b/doc/guide/files/share/default.dsl
index cac7e359efa..46b33d695dc 100644
--- a/doc/guide/files/share/default.dsl
+++ b/doc/guide/files/share/default.dsl
@@ -2,12 +2,14 @@
<!ENTITY netbsd.dsl PUBLIC "-//NetBSD//DOCUMENT DocBook DSSSL Stylesheet//EN" CDATA DSSSL>
]>
-<!-- $NetBSD: default.dsl,v 1.1.1.1 2004/10/21 14:27:43 grant Exp $ -->
+<!-- $NetBSD: default.dsl,v 1.2 2016/06/11 18:14:42 rillig Exp $ -->
<style-sheet>
<style-specification use="docbook">
<style-specification-body>
-
+ <![ %output.print; [
+ (element code ($mono-seq$))
+ ]]>
</style-specification-body>
</style-specification>