Это создает фразу из книги с атрибутом<role>, который можно использовать для классификации фразы. Это может быть использовано для обозначения текста для использования, которое не покрыто в другом месте. Docbook<role>будет генерировать html-класс, который можно использовать для стилистики текста. И таблицы стилей xsl могут быть настроены для обработки определенных ролей специально при создании pdf.

В бустерной книге css таблицы стилей и xsl таблицы стилей содержат поддержку ограниченного числа цветов, которые могут быть использованы с<role>. Например, если вы пишете:

[role red Text content]

Вы получите красный текст, если используете boostbook css (для html) или boostbook xsl для создания pdfs.

Полный список цветов, которые будут доступны:

Наложение кода в абзацах довольно распространено при написании документации на C++. Мы предоставляем очень простую разметку для этого. Например, это:

This text has inlined code `int main() { return 0; }` in it.

будет генерировать:

Этот текст содержит код<int main() { return 0; }>. Код будет выделен синтаксисом.

	Note
	Мы просто прилагаем код клещом:<"`">, а не единственной цитатой:<"'">. Также обратите внимание, что<`some code`>предпочтительнее<[^some code]>.

Преформатированный код просто начинается с пробела или вкладки (см.Код). Однако такой простой синтаксис не может использоваться в качестве элементов фразы в списках (см.). Упорядоченные спискииНеупорядоченные списки, таблицы (см.Таблицы) и т.д. Встроенный код (см. выше) может. Проблема в том, что встроенный код не позволяет форматировать новые линии, пробелы и вкладки. Они потеряны.

Мы предоставляем разметку уровня фразы, которая является смесью между ними. Используя двойной или тройной тик, вместо одного тика, мы советуем QuickBook использовать предварительно отформатированные блоки кода. Пример:

``
    #include <iostream>
    int main()
    {
        std::cout << "Hello, World!" << std::endl;
        return 0;
    }
``

или:

```
    #include <iostream>
    int main()
    {
        std::cout << "Hello, World!" << std::endl;
        return 0;
    }
```

будет генерировать:

#include <iostream>
int main()
{
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

Если документ содержит более одного типа исходного кода, то режим источника может динамически изменяться по мере обработки документа. Все документы QuickBook изначально находятся в режиме C++ по умолчанию, хотя альтернативное начальное значение может быть установлено в разделеДокумент.

Чтобы изменить режим источника, используйте разметку<[source-mode]>, где<source-mode>является одним из поддерживаемых режимов. Например, это:

Python's [python] `import` is rather like C++'s [c++] `#include`. A
C++ comment `// looks like this` whereas a Python comment [python]
`# looks like this`.

будет генерировать:

Python<import>похож на C++<#include>. Комментарий на C++<// looks like this>, а комментарий на Python<#looks like this>.

	Note
	Строки исходного режима являются нижними.

[br]

	Warning
	<[br]>Создает недействительный документ. В основном это работает нормально, но могут возникнуть проблемы, особенно при использовании альтернативного процессора.

[#named_anchor]

Именованный якорь - это крюк, на который можно ссылаться по ссылке в другом месте документа. Затем вы можете ссылаться на якорь с<[link named_anchor Some link text]>. СмотриЯкорные ссылки,РазделиЗаголовок.

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

[@http://www.boost.org this is [*boost's] website....]

будет генерировать:

этоповышениеWEB

URL-ссылки, где текст ссылки является самой ссылкой, являются общими. Пример:

see http://spirit.sourceforge.net/

Таким образом, когда текст отсутствует в разметке ссылки, предполагается URL. Пример:

see [@http://spirit.sourceforge.net/]

будет генерировать:

см.http://spirit.sourceforge.net/

Boostbook также поддерживает пользовательскую схему URL для ссылки на файлы в дистрибутиве повышения:

[@boost:/libs/spirit/index.html the Boost.Spirit documentation]

Повысить. Духовная документация

Обратите внимание, что это доступно только при использовании BoostBook, и только для ссылок - его нельзя использовать для изображений.

Вы можете связать в документе, используя:

[link document_id.section_id.normalized_header_text The link text]

См. разделыРазделиЗаголовокдля получения дополнительной информации.

Кроме того, вы можете связать внутренне с XML-защитой, например:

[link xml.refentry The link text]

В результате этого<<link linkend="xml.refentry">The link text</link>>.

Как и URL, текст ссылки является необязательным. Если этого нет, текст ссылки автоматически будет ребентом. Пример:

[link xml.refentry]

В этом случае он превращается в<<link linkend="xml.refentry">xml.refentry</link>>.

Если вы хотите связать с функцией, классом, членом, перечислением, концепцией, глобальным или заголовком в справочном разделе, вы можете использовать:

[funcref fully::qualified::function_name The link text]
[classref fully::qualified::class_name The link text]
[memberref fully::qualified::member_name The link text]
[enumref fully::qualified::enum_name The link text]
[macroref MACRO_NAME The link text]
[conceptref ConceptName The link text]
[headerref path/to/header.hpp The link text]
[globalref fully::qualified::global The link text]

Опять же, текст ссылки является необязательным. Если этого нет, текст ссылки автоматически будет функцией, классом, членом, перечнем, макросом, концепцией, глобальным именем или именем заголовка. Пример:

[classref boost::bar::baz]

В качестве текста ссылки будет использоваться «boost::bar::baz».

Разметка побега используется, когда мы не хотим делать какую-либо обработку.

'''
escape (no processing/formatting)
'''

Escaping позволяет нам передавать разметку XML вBoostBookилиDocBook. Например:

'''
<emphasis role="bold">This is direct XML markup</emphasis>
'''

Это прямая разметка XML

	Important
	Будьте осторожны при использовании побега. Текст должен соответствовать синтаксисуBoostBook/DocBook.

Задняя косая черта может быть использована, чтобы избежать одного знака препинания. Пунктуация сразу же после обратной ударной волны проходит без какой-либо обработки. Это полезно, когда нам нужно избежать таких пунктуаций QuickBook, как<[>и<]>. Например, как избежать тройной цитаты? Просто:<\'\'\'>

<\n>имеет особое значение. Используется для генерации разрывов линий.

	Warning
	<\n>теперь обесценивается, вместо этого используйте<[br]>. Хотя используйте его экономно, так как он может генерировать недействительный документ.

Сбежавшее пространство:<\>также имеет особое значение. Сбежавшее пространство удаляется с выхода.

Вы можете ввести любой 16-битный символ уникода, используя<\u>, за которым следует его 4-значный шестнадцатеричный код, или 32-битный символ, используя<\U>, за которым следует 8-значный шестнадцатеричный код. Например.

\u03B1 + \u03B2

будет генерировать:

[$image.jpg]

Из версии 1.5 также можно использовать атрибуты изображенийDocBook:

[$image.jpg [width 200in] [height 200in]]