README-SGML revision ffb47c916a32684adbd031c0bacdd0d11ff33e3a
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntCopyright (C) 2004, 2015 Internet Systems Consortium, Inc. ("ISC")
499b34cea04a46823d003d4c0520c8b03e8513cbBrian WellingtonCopyright (C) 2000, 2001 Internet Software Consortium.
cffe50abf66495ee08084f8e1081278a9b589985Brian WellingtonSee COPYRIGHT in the source root or http://isc.org/copyright.html for terms.
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntThe BIND v9 ARM master document is now kept in DocBook 5 XML format.
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntMost of the ARM is in the single file "Bv9ARM-book.xml", with certain
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntother files included into it:
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Hunt - BIND man pages
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntAll of the published ARM formats - HTML, PDF, etc - are generated from
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntthis master source.
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntThe file "notes.xml" contains the release notes for the current release. In
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntaddition to being included in the ARM as an appendix, it is also built into
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Hunta stand-alone document: "notes.pdf" and "notes.html".
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntBuilding these these files requires DocBook 5 and dblatex. These are
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntavailable as packages in many OS distributes; in debian, for example:
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Hunt $ sudo apt-get install docbook5-xml docbook-xml docbook-xsl-ns \
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Hunt docbook-utils dblatex
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntTo build all documentation, run "make doc".
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntWhen committing changes or submitting patches, it is only necessary to
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntedit the XML source (i.e., the files with ".docbook" or ".xml" suffixes);
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntthe files in HTML and man page format are built from the XML source by a
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntIf you are familiar with SGML or HTML, editing the DocBook XML is quite
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntstraightforward. You only need to know what the tags are and how to use
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntthem. You can find a good resource either for this either online or in
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan Huntprinted form:
01f8e2b2bf6cc60b806984e2bf860221d5988e53Andreas Gustafsson DocBook: The Definitive Guide
01f8e2b2bf6cc60b806984e2bf860221d5988e53Andreas Gustafsson By Norman Walsh and Leonard Muellner
01f8e2b2bf6cc60b806984e2bf860221d5988e53Andreas Gustafsson ISBN: 156592-580-7
01f8e2b2bf6cc60b806984e2bf860221d5988e53Andreas Gustafsson 1st Edition, October 1999
01f8e2b2bf6cc60b806984e2bf860221d5988e53Andreas Gustafsson Copyright (C) 1999 by O'Reilly & Associates, Inc. All rights reserved.
55c73d07349b0be7d800f39fcc30eba6ab760129Eric LuceThe book is available online in HTML format:
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntAfter editing documentation, it is useful to check the correctness of the
ffb47c916a32684adbd031c0bacdd0d11ff33e3aEvan HuntXML; this can be done using the "xmllint" utility.