Карта сайта Kansoftware
НОВОСТИУСЛУГИРЕШЕНИЯКОНТАКТЫ
Разработка программного обеспечения

Bringing Together a BoostBook Document

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Chapter 44. The BoostBook Documentation Format

Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext

Bringing Together a BoostBook Document

Linking in BoostBook

То, как один связывается с другим элементом в BoostBook, во многом зависит от природы связанного элемента и того, как должно появиться ссылка. Есть три общих связующих элемента: , и . Кроме того, есть связующие элементы для обозначения конкретных типов объектов, таких как классы (), функции (< functionname>), или библиотеки ().

Элемент ссылается на элементы, которые имеют атрибут id и заголовок. Фактический текст ссылки состоит из заголовка и типа ссылки элемента. Чтобы связать с конкретным идентификатором, создайте элемент с атрибутом linkend, установленным для идентификации предполагаемой цели. Например, ID этого раздела является boostbook.linking, поэтому мы создаем ссылку на него с , которая будет выглядеть так в тексте: раздел, называемый “Linking in BoostBook”.

Элемент ссылается на идентификатор так же, как и , за исключением того, что не генерирует никакого текста для ссылки, поэтому текст должен быть поставлен в элементе. Например, мы можем снова ссылаться на эту главу, но на этот раз укажите наш собственный текст с подобный этому. Эта отметка приведет к ссылке на эту главу, которая выглядит , как это.

Элемент ссылается на URL, который находится за пределами документа DocBook. Атрибут url содержит ссылку на URL, а данные элемента предоставляют текст ссылки. Например, мы можем ссылаться на сайт Boost с Boost, Боост.

В BoostBook поддерживает пользовательскую схему URL-адресов для подключения к файлам в диапазоне импульсов. Это формируется путем установки атрибута url на boost:, за которым следует путь файла. Например, мы можем связываться с библиотекой флайф-веса с Boost.Flyweight, которая будет выглядеть так: Boost.Flyweight. Эта схема поддерживается только для элементов BoostBook . Он не доступен для других элементов или в Docbook.

, < functionname>, и ссылаются соответственно на классы, функции, методы и библиотеки. Текст каждого элемента дает как название элемента для ссылки, так и текст ссылки. Например, мы можем связать с библиотекой функционала Function, что приводит к следующему: Function. В тех случаях, когда отображаемый текст отличается от фактического имени, можно указать атрибут alt. Например, следующий элемент XML ссылается на boost:: function шаблон класса, но отображает текст функция: <libraryname>Function</libraryname>, which results in the following: Function. In cases where the displayed text is different from the actual name, the alt attribute can be specified. For instance, the following XML element references the boost::function class template but displays the text function: <classname alt="boost::function">function</classname>.[ORIG_END] -->


PrevUpHomeNext

Статья Bringing Together a BoostBook Document раздела The Boost C++ Libraries BoostBook Documentation Subset Chapter 44. The BoostBook Documentation Format может быть полезна для разработчиков на c++ и boost.




Материалы статей собраны из открытых источников, владелец сайта не претендует на авторство. Там где авторство установить не удалось, материал подаётся без имени автора. В случае если Вы считаете, что Ваши права нарушены, пожалуйста, свяжитесь с владельцем сайта.



:: Главная :: Chapter 44. The BoostBook Documentation Format ::


реклама


©KANSoftWare (разработка программного обеспечения, создание программ, создание интерактивных сайтов), 2007
Top.Mail.Ru

Время компиляции файла: 2024-08-30 11:47:00
2025-05-19 21:33:43/0.0066041946411133/0