README-SGML revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
98N/ACopyright (C) 2000, 2001, 2004, 2015, 2016 Internet Systems Consortium, Inc. ("ISC")
98N/A
98N/AThis Source Code Form is subject to the terms of the Mozilla Public
98N/ALicense, v. 2.0. If a copy of the MPL was not distributed with this
98N/Afile, You can obtain one at http://mozilla.org/MPL/2.0/.
98N/A
98N/AThe BIND v9 ARM master document is now kept in DocBook 5 XML format.
98N/A
98N/AMost of the ARM is in the single file "Bv9ARM-book.xml", with certain
98N/Aother files included into it:
98N/A
98N/A - dlz.xml
98N/A - dnssec.xml
98N/A - libdns.xml
98N/A - logging-categories.xml
98N/A - managed-keys.xml
98N/A - notes.xml
98N/A - pkcs11.xml
98N/A - BIND man pages
98N/A
98N/AAll of the published ARM formats - HTML, PDF, etc - are generated from
98N/Athis master source.
98N/A
98N/AThe file "notes.xml" contains the release notes for the current release. In
98N/Aaddition to being included in the ARM as an appendix, it is also built into
98N/Aa stand-alone document: "notes.pdf" and "notes.html".
98N/A
98N/ABuilding these these files requires DocBook 5 and dblatex. These are
98N/Aavailable as packages in many OS distributes; in debian, for example:
98N/A
98N/A $ sudo apt-get install docbook5-xml docbook-xml docbook-xsl-ns \
98N/A docbook-utils dblatex
343N/A
98N/ATo build all documentation, run "make doc".
98N/A
235N/AWhen committing changes or submitting patches, it is only necessary to
156N/Aedit the XML source (i.e., the files with ".docbook" or ".xml" suffixes);
156N/Athe files in HTML and man page format are built from the XML source by a
156N/Acron job.
156N/A
98N/AIf you are familiar with SGML or HTML, editing the DocBook XML is quite
98N/Astraightforward. You only need to know what the tags are and how to use
98N/Athem. You can find a good resource either for this either online or in
98N/Aprinted form:
235N/A
235N/A DocBook: The Definitive Guide
98N/A By Norman Walsh and Leonard Muellner
98N/A ISBN: 156592-580-7
98N/A 1st Edition, October 1999
156N/A Copyright (C) 1999 by O'Reilly & Associates, Inc. All rights reserved.
98N/A
98N/AThe book is available online in HTML format:
235N/A
261N/A http://docbook.org/
98N/A
98N/AAfter editing documentation, it is useful to check the correctness of the
98N/AXML; this can be done using the "xmllint" utility.
98N/A