README-SGML revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCopyright (C) 2000, 2001, 2004, 2015, 2016 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark AndrewsThis Source Code Form is subject to the terms of the Mozilla Public
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinLicense, v. 2.0. If a copy of the MPL was not distributed with this
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinfile, You can obtain one at http://mozilla.org/MPL/2.0/.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThe BIND v9 ARM master document is now kept in DocBook 5 XML format.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinMost of the ARM is in the single file "Bv9ARM-book.xml", with certain
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinother files included into it:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - BIND man pages
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinAll of the published ARM formats - HTML, PDF, etc - are generated from
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrewsthis master source.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThe file "notes.xml" contains the release notes for the current release. In
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinaddition to being included in the ARM as an appendix, it is also built into
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeina stand-alone document: "notes.pdf" and "notes.html".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinBuilding these these files requires DocBook 5 and dblatex. These are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinavailable as packages in many OS distributes; in debian, for example:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein $ sudo apt-get install docbook5-xml docbook-xml docbook-xsl-ns \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein docbook-utils dblatex
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinTo build all documentation, run "make doc".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinWhen committing changes or submitting patches, it is only necessary to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinedit the XML source (i.e., the files with ".docbook" or ".xml" suffixes);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinthe files in HTML and man page format are built from the XML source by a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinIf you are familiar with SGML or HTML, editing the DocBook XML is quite
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstraightforward. You only need to know what the tags are and how to use
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinthem. You can find a good resource either for this either online or in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinprinted form:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DocBook: The Definitive Guide
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein By Norman Walsh and Leonard Muellner
bddb70a27123e31020438cff811d898d44b42c71Mark Andrews ISBN: 156592-580-7
bddb70a27123e31020438cff811d898d44b42c71Mark Andrews 1st Edition, October 1999
bddb70a27123e31020438cff811d898d44b42c71Mark Andrews Copyright (C) 1999 by O'Reilly & Associates, Inc. All rights reserved.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThe book is available online in HTML format:
bddb70a27123e31020438cff811d898d44b42c71Mark AndrewsAfter editing documentation, it is useful to check the correctness of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinXML; this can be done using the "xmllint" utility.