pkgsrc-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[pkgsrc/trunk]: pkgsrc/doc/guide Migrated the pkgsrc guide to DocBook 4.5.



details:   https://anonhg.NetBSD.org/pkgsrc/rev/dd916d976624
branches:  trunk
changeset: 348286:dd916d976624
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sat Jun 11 18:14:42 2016 +0000

description:
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:

 doc/guide/Makefile                |   8 +++++++-
 doc/guide/Makefile.common         |   6 +++---
 doc/guide/files/Makefile          |   7 +++++--
 doc/guide/files/devfaq.xml        |  20 ++++++++++----------
 doc/guide/files/pkgsrc.xml        |   6 +++---
 doc/guide/files/share/default.dsl |   6 ++++--
 6 files changed, 32 insertions(+), 21 deletions(-)

diffs (139 lines):

diff -r fec4b8a6b2f0 -r dd916d976624 doc/guide/Makefile
--- a/doc/guide/Makefile        Sat Jun 11 15:00:45 2016 +0000
+++ b/doc/guide/Makefile        Sat Jun 11 18:14:42 2016 +0000
@@ -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 @@
 
 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 -r fec4b8a6b2f0 -r dd916d976624 doc/guide/Makefile.common
--- a/doc/guide/Makefile.common Sat Jun 11 15:00:45 2016 +0000
+++ b/doc/guide/Makefile.common Sat Jun 11 18:14:42 2016 +0000
@@ -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_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 -r fec4b8a6b2f0 -r dd916d976624 doc/guide/files/Makefile
--- a/doc/guide/files/Makefile  Sat Jun 11 15:00:45 2016 +0000
+++ b/doc/guide/files/Makefile  Sat Jun 11 18:14:42 2016 +0000
@@ -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 -r fec4b8a6b2f0 -r dd916d976624 doc/guide/files/devfaq.xml
--- a/doc/guide/files/devfaq.xml        Sat Jun 11 15:00:45 2016 +0000
+++ b/doc/guide/files/devfaq.xml        Sat Jun 11 18:14:42 2016 +0000
@@ -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 -r fec4b8a6b2f0 -r dd916d976624 doc/guide/files/pkgsrc.xml
--- a/doc/guide/files/pkgsrc.xml        Sat Jun 11 15:00:45 2016 +0000
+++ b/doc/guide/files/pkgsrc.xml        Sat Jun 11 18:14:42 2016 +0000
@@ -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@localhost";>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 -r fec4b8a6b2f0 -r dd916d976624 doc/guide/files/share/default.dsl
--- a/doc/guide/files/share/default.dsl Sat Jun 11 15:00:45 2016 +0000
+++ b/doc/guide/files/share/default.dsl Sat Jun 11 18:14:42 2016 +0000
@@ -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>
 



Home | Main Index | Thread Index | Old Index