В этом разделе приведены некоторые рекомендации по установке и настройке BoostBook и Quickbook под несколькими операционными системами. Перед установкой вам понадобится локальная копия бустера и установить версию<bjam>, которая поставляется с ним (или более поздней версией).
Самый простой способ установки на OS X — использование macports. Если вы не хотите использовать macports и используете Snow Leopard или позже, есть инструкциипозже. Более ранние версии OS X должны использовать что-то вроде macports для установки<xsltproc>, потому что версия, с которой они поставляются, очень старая и не имеет достаточно хорошей поддержки XSL для таблиц стилей.
sudo port install libxslt docbook-xsl docbook-xml-4.2
Затем нам нужно настроить Boost Build для компиляции файлов BoostBook. Добавьте следующее в свой<user-config.jam>файл, который должен быть в вашем домашнем каталоге. Если у вас его нет, создайте файл, содержащий этот текст. Для получения дополнительной информации о настройке<user-config.jam>см. документациюBoost Build.
using xsltproc
: /opt/local/bin/xsltproc
;
using boostbook
: /opt/local/share/xsl/docbook-xsl/
: /opt/local/share/xml/docbook/4.2
;
Вышеперечисленных шагов достаточно, чтобы получить функциональную настройку BoostBook. Quickbook будет автоматически создаваться по мере необходимости. Если вы хотите избежать этих изменений:
Перейдите в каталог источников Quickbook<BOOST_ROOT/tools/quickbook>.
Постройте утилиту, выдав<bjam>.
Копируйте полученный<quickbook>двоичный<BOOST_ROOT/dist/bin>в безопасное место. Традиционное месторасположение</usr/local/bin>.
Добавьте в свой<user-config.jam>файл следующее, используя полный путь исполняемого файла быстрой книги:
<
using quickbook
: /usr/local/bin/quickbook
;
>
Если вам нужно создать документацию, которая использует Doxygen, вам нужно будет установить его:
sudo port install doxygen
Добавьте к этому<user-config.jam>:
using doxygen ;
Кроме того, вы можете установить официальный доксиген<dmg>. Об этом говорится вконце следующего раздела.
В приведенном ниже тексте предполагается, что вы хотите установить все необходимые утилиты в общесистемном месте, что позволит любому пользователю в машине иметь к ним доступ. Поэтому все файлы будут помещены в иерархию</usr/local>. Если вы не хотите этого, вы можете выбрать любой другой префикс, такой как<~/Applications>для установки с одним пользователем.
Snow Leopard поставляется с предустановленными<xsltproc>и всеми связанными библиотеками, поэтому вам не нужно предпринимать никаких дополнительных шагов для их настройки. Вполне вероятно, что будущие версии также будут включать их, но эти инструкции могут не относиться к более старым версиям.
Чтобы начать:
СкачатьDocbook XML 4.2и распаковать его внутри</usr/local/share/xml/docbook/4.2>.
Скачать последнюю версиюDocbook XSLи распаковать ее. Будьте осторожны при загрузке правильного файла, иногда ссылка «Поиск последней версии» часто ссылается на другой файл. Имя должно иметь форму<docbook-xsl-1.nn.n.tar.bz2>, без суффикса<-ns.tar.bz2>или<-doc.tar.bz2>. Поместите результаты в</usr/local/share/xsl/docbook>, таким образом эффективно удалив номер версии из названия каталога (для простоты).
Добавьте следующее в свой<user-config.jam>файл, который должен жить в домашнем каталоге</Users/<your_username>>. Вы должны уже иметь его где-то или иначе вы не могли бы строить Boost (т.е. отсутствующая конфигурация инструментов).
<
using xsltproc ;
using boostbook
: "/usr/local/share/xsl/docbook"
: "/usr/local/share/xml/docbook/4.2"
;
>
Вышеперечисленных шагов достаточно, чтобы получить функциональную настройку BoostBook. Quickbook будет автоматически создаваться по мере необходимости. Если вы хотите избежать этих перестроек и вместо этого установить системный Quickbook:
Перейдите в каталог источников Quickbook<BOOST_ROOT/tools/quickbook>.
Постройте утилиту, выдав<bjam>.
Копируйте полученный<quickbook>двоичный<BOOST_ROOT/dist/bin>в безопасное место. Следуя нашему предыдущему примеру, вы можете установить его в:</usr/local/bin>.
Добавьте следующее в свой<user-config.jam>файл:
<
using quickbook
: "/usr/local/bin/quickbook" ;
;
>
Кроме того, если вам нужно создать документацию, в которой используетсяДоксиген, вам также необходимо установить его:
Перейдите в разделзагрузкии получите изображение диска<dmg>для Mac OS X.
Откройте изображение диска и перетащите приложение Doxygen в папку<Applications>, чтобы установить его.
Добавьте в свой<user-config.jam>файл следующее:
<
using doxygen
: /Applications/Doxygen.app/Contents/Resources/doxygen
;
Следующие инструкции применяются к любой системе Windows на основе Windows 2000, включая Windows XP, Windows 2003 Server, Windows Vista и Windows 7. Пути, показанные ниже, взяты из машины Windows Vista; вам нужно будет настроить их в соответствии с вашей системой, если вы используете более старую версию.
Прежде всего, вам нужно иметь копию<xsltproc>для Windows. Есть много способов получить этот инструмент, но чтобы все было просто, используйтебинарные пакеты, сделанные Игорем Златковичем. По крайней мере, вам нужно загрузить следующие пакеты:<iconv>,<zlib>,<libxml2>и<libxslt>.
Распакуйте все эти пакеты в одном каталоге, чтобы получить уникальные каталоги<bin>,<include>и<lib>в иерархии. Эти инструкции используют<C:\Users\example\Documents\boost\xml>в качестве корня для всех файлов.
Из командной строки перейдите в каталог<bin>и запустите<xsltproc.exe>, чтобы убедиться, что он работает. Вы должны получить информацию об использовании на экране.
ЗагрузитеDocbook XML 4.2и распакуйте его в том же каталоге, который использовался выше. То есть:<C:\Users\example\Documents\boost\xml\docbook-xml>.
Загрузите последнюю версиюDocbook XSLи распакуйте ее снова в том же каталоге, который использовался ранее. Будьте осторожны при загрузке правильного файла, иногда ссылка «Поиск последней версии» часто ссылается на другой файл. Имя должно иметь форму<docbook-xsl-1.nn.n.tar.bz2>, без суффикса<-ns.tar.bz2>или<-doc.tar.bz2>. Чтобы упростить задачу, переименуйте каталог, созданный во время извлечения, в<docbook-xsl>(в обход названия версии):<C:\Users\example\Documents\boost\xml\docbook-xsl>.
Добавьте следующее в свой<user-config.jam>файл, который должен жить в домашнем каталоге<%HOMEDRIVE%%HOMEPATH%>. Вы должны уже иметь его где-то или иначе вы не могли бы строить Boost (т.е. отсутствующая конфигурация инструментов).
<
using xsltproc
: "C:/Users/example/Documents/boost/xml/bin/xsltproc.exe"
;
using boostbook
: "C:/Users/example/Documents/boost/xml/docbook-xsl"
: "C:/Users/example/Documents/boost/xml/docbook-xml"
;
>
Вышеперечисленных шагов достаточно, чтобы получить функциональную настройку BoostBook. Quickbook будет автоматически создаваться по мере необходимости. Если вы хотите избежать этих изменений:
Перейдите в каталог источников Quickbook<BOOST_ROOT\tools\quickbook>.
Постройте утилиту, выдав<bjam>.
Копируйте полученный двоичный код<quickbook.exe>(расположенный на<BOOST_ROOT\dist\bin>) в безопасное место. Следуя нашему предыдущему примеру, вы можете установить его в:<C:\Users\example\Documents\boost\xml\bin>.
Добавьте в файл<user-config.jam>следующее:
<
using quickbook
: "C:/Users/example/Documents/boost/xml/bin/quickbook.exe"
;
Следующие инструкции относятся к Debian и его производным. Они основаны на установке Ubuntu Edgy, но должны работать на других системах на основе Debian. Они предполагают, что вы уже установили соответствующую версию<bjam>для своей копии ускорения.
Первыми устанавливают<xsltproc>,<docbook-xsl>и<docbook-xml>пакеты. Например, используя<apt-get>:
Если вы планируете создать дополнительную документацию, вам также необходимо установить пакет<doxygen>.
Затем нам нужно настроить Boost Build для компиляции файлов BoostBook. Добавьте следующее в свой<user-config.jam>файл, который должен быть в вашем домашнем каталоге. Если у вас его нет, создайте файл, содержащий этот текст. Для получения дополнительной информации о настройке<user-config.jam>см. документациюBoost Build.
using xsltproc ;
using boostbook
: /usr/share/xml/docbook/stylesheet/nwalsh
: /usr/share/xml/docbook/schema/dtd/4.2
;
# Remove this line if you're not using doxygen
using doxygen ;
Вышеперечисленных шагов достаточно, чтобы получить функциональную настройку BoostBook. Quickbook будет автоматически создаваться по мере необходимости. Если вы хотите избежать этих изменений:
Перейдите в каталог источников Quickbook<BOOST_ROOT/tools/quickbook>.
Постройте утилиту, выдав<bjam>.
Копируйте полученный<quickbook>двоичный<BOOST_ROOT/dist/bin>в безопасное место. Традиционное месторасположение</usr/local/bin>.
Добавьте в свой<user-config.jam>файл следующее, используя полный путь исполняемого файла быстрой книги:
<
using quickbook
: /usr/local/bin/quickbook
;
>
Статья Installation and configuration раздела The Boost C++ Libraries BoostBook Documentation Subset Chapter 47. Quickbook 1.6 может быть полезна для разработчиков на c++ и boost.
