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

Writing Documentation for Boost - HTML Design

Boost , ,

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

Writing Documentation for Boost

HTML Design

Introduction
Common Pages Included in HTML Documentation
Index
Overview
Definitions
Rationale
Configuration Information
Frequently Asked Questions
Bibliography
Acknowledgment
Header Reference
Layout
Page Banner
Page Index
Documentation Content
Footnotes
Revision Information
Copyright Information
Format
Cascading Style Sheets
Boost Style Sheet
Templates
Index Page Template
Overview Page Template
Definitions Page Template
Rationale Page Template
Configuration Page Template
FAQ (Frequently Asked Questions) Page Template
Bibliography Page Template
Acknowledgments Page Template
Header Page Template

Introduction

Boost не предъявляет никаких требований к дизайну HTML-документации для библиотечных пользователей. Если вы отправляете библиотеку, для которой документация уже существует в HTML или в форме, легко конвертируемой в HTML, вам не нужно читать этот документ. Однако, если вы еще не написали документацию, или если вы ожидаете, что вам придется перевести документацию, написанную в формате, который нелегко конвертировать в HTML, этот документ может дать вам много информации о том, как писать документацию в HTML.

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

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

Common Pages Included in HTML Documentation

Большинство проектов HTML-документации содержат несколько общих страниц. Общие руководящие принципы для этих общих страниц приведены ниже.

Index

Страница индекса - это первая страница, представленная пользователю при просмотре документации. Как правило, эта страница не должна содержать какой-либо фактический контент, а вместо этого содержит список ссылок на конкретный контент. Этот список должен содержать ссылку на каждую HTML-страницу, содержащуюся в документации. По желанию, подсписки могут быть предоставлены для отдельных страниц, ссылающихся на конкретные темы на странице. Эти подсписки должны формировать иерархию «дерево» на основе уровня тега заголовка, используемого для конкретной темы. Включение таких подсписков для каждой страницы может сделать индекс довольно длинным, и поскольку каждая страница должна включать свой собственныйPage Index, это может облегчить навигацию по документации, если таких подсписков избежать. Однако в этом руководстве есть одно исключение: справочная документация должна содержать ссылку на каждый файл заголовка в библиотеке и подсписок со ссылкой на каждый макрос, значение, тип, класс, функцию и объект (см.Структура документации), найденный в заголовке. Пользователи не всегда уверены, в каком файле заголовка может содержаться любой из них, поэтому эта структура в индексе позволяет легко перемещаться по справочной документации.

Список индексов, как правило, должен быть построен с использованием HTML-списка определения (

и
теги). Список определений не имеет пуль или упорядоченных спецификаций и производит более чистую компоновку, чем неупорядоченный список (
    и
  • теги) или упорядоченный список (
      и
    1. теги). Если вы решите использовать общийBoost Style Sheet, вы должны добавить пару атрибутов / значений<class="index">к тегу
      .

      Для использования предусмотрена страница индексашаблон.

      Overview

      Страница обзора используется для ознакомления читателя с библиотекой. Он должен дать высокоуровневый обзор цели библиотеки и познакомить читателя с любыми понятиями, с которыми он может быть незнаком. Это также может быть подходящим местом для некоторого «легкого» обоснования, хотя более тщательное изложение любого обоснования было бы лучше размещено наРациональной странице.

      Как и большинство страниц контента, страница обзора должна включать индекс страницы.

      Для использования предусмотрена страница обзорашаблон.

      Definitions

      Страница определений используется для предоставления списка определений терминов, с которыми пользователь может быть незнаком.

      Список определений, как правило, должен быть построен с использованием HTML «список определений» (

      и
      теги). Список определений не имеет пуль или упорядоченных спецификаций и производит более чистую компоновку, чем неупорядоченный список (
        и
      • теги) или упорядоченный список (
          и
        1. теги). Если вы решите использовать общийBoost Style Sheet, вы должны добавить пару атрибутов / значений<class="definition">к тегу
          .

          Поскольку содержание этой страницы должно содержать только список определений, она не должна иметь индекс страницы.

          Для использования предусмотрен шаблон страницы определений.

          Rationale

          Страница Rationale используется для предоставления длинных описаний обоснования дизайна библиотеки. Эта информация помогает пользователям понять, почему библиотека была разработана именно так, и может уменьшить частоту часто задаваемых вопросов. Для лучшего описания того, почему рациональное обоснование важно см.Рациональное обоснованиев общих руководящих принципах представления.

          Как и большинство страниц контента, страница Rationale должна включать индекс страницы.

          Для этого используется шаблон Rationale.

          Configuration Information

          Страница Configuration Information используется для документирования макросов конфигурации, используемых библиотекой. Такие макросы относятся к одной из трех групп: макросы, используемые библиотечными усилителями, определенными в<<boost/config.hpp>>, макросы, используемые пользователями библиотеки для обнаружения информации о конфигурации платформы, и макросы, определенные пользователями библиотеки для настройки поведения библиотеки.

          Как и большинство страниц контента, страница обзора должна включать индекс страницы.

          Для использования предусмотрен шаблон страницыконфигурации.

          Frequently Asked Questions

          По мере взросления библиотеки у пользователей возникают вопросы об использовании библиотеки. Часто пользователи задают одни и те же вопросы снова и снова. Вместо того, чтобы иметь дело с ответом на вопрос каждый раз, когда его задают, часто задаваемые вопросы (обычно известные как часто задаваемые вопросы) можно использовать для документирования вопросов и ответов. Это настолько ценная документация не только для пользователей, но и для тех, кто ее обслуживает, что страница часто задаваемых вопросов должна быть предоставлена с самого начала. Если нет вопросов, которые, очевидно, станут FAQ, начальная страница может просто указать, что FAQ еще нет. Этот пустой держатель места помогает указать пользователям, что вы планируете обращаться к любым часто задаваемым вопросам по мере их возникновения.

          Page Indexдля страницы FAQ должен содержать список всех вопросов, содержащихся в документе. Фактические записи вопросов должны быть отформатированы с вопросом в теге заголовка и ответами в стандартном формате абзаца. Это обеспечивает чистую презентацию, которую легко читать.

          Для часто задаваемых вопросов используется шаблон.

          Bibliography

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

          Поскольку страница библиографии должна содержать только библиографическую информацию, нет необходимости в индексе страницы.

          Для использования предусмотрена страница библиографиишаблон.

          Acknowledgment

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

          Поскольку страница подтверждения должна содержать только список подтверждения, нет необходимости в индексе страницы.

          Для ознакомления предлагается страницашаблон.

          Header Reference

          Справочные страницы заголовка являются наиболее важными страницами в вашей документации. Они документируют все заголовки библиотек, включая все макросы, значения, типы, классы, функции и объекты, определенные в них. В целом, при написании контента для этих страниц может оказаться полезным следовать рекомендациямСтруктура документации.

          Как и большинство страниц контента, эталонные страницы заголовка должны включать индекс страницы.

          Для использования предусмотрен шаблон заголовка.

          Layout

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

          Page Banner

          Баннер страниц расположен в самом верху страницы и предоставляет быструю информацию о содержании страницы. Это включает в себя логотип Boost, который указывает читателю, что эта страница является частью веб-сайта Boost, заголовок для документации (обычно название библиотеки) и заголовок страницы. Логотип Boost должен иметь гиперссылку на домашнюю страницу Boost на странице индекса и на страницу индекса на всех других страницах. Это позволяет пользователю легко перемещаться по сайту Boost и по документации. Тегдля страницы HTML должен состоять из заголовка документации и заголовка страницы, разделенного дефисом.<!-- [TR_END] --><!-- [ORIG_BEGIN]The Page Banner is located at the very top of a page and provides quick information about the page contents. This includes the Boost logo, which indicates to the reader that this page is part of the Boost web site, a title for the documentation (generally the library name) and the page title. The Boost logo should hyper link to the Boost home page on the index page and to the index page on all other pages. This allows the user to easily navigate through the Boost web site and through the documentation. The <title> tag for the HTML page should consist of the documentation title and the page title separated by a hyphen.[ORIG_END] --></p> <p><!--[TR_BEGIN]-->Баннер страницы должен быть отделен от остальной части страницы с помощью тега<hr>. Это помогает четко отделить фактический контент от информации о заголовке и создает более чистый текст.<!-- [TR_END] --><!-- [ORIG_BEGIN]The Page Banner should be separated from the rest of the page by the use of an <hr> tag. This helps to clearly separate the actual content from the title information and produces cleaner text.[ORIG_END] --></p> <h3><a name="page-index" id="page-index"></a>Page Index</h3> <p><!--[TR_BEGIN]-->Индекс страницы используется для быстрой навигации по различным разделам документации на странице, а при наличии должен располагаться чуть ниже баннера страницы.<!-- [TR_END] --><!-- [ORIG_BEGIN]The page index is used to quickly navigate to the various sections of the documentation on the page, and when present should be located just below the Page Banner.[ORIG_END] --></p> <p><!--[TR_BEGIN]-->Список индексов, как правило, должен быть построен с использованием HTML-списка определения (<dl>и<DT>теги). Список определений не имеет пуль или упорядоченных спецификаций и производит более чистую компоновку, чем неупорядоченный список (<UL>и<li>теги) или упорядоченный список (<ol>и<li>теги). Если вы решите использовать таблицу стилей Boost, вы должны добавить пару атрибутов / значений<<code>class="page-index"</code>>в тег<dl>.<!-- [TR_END] --><!-- [ORIG_BEGIN]The index list should generally be constructed using an HTML "definition list" (<dl> and <DT> tags). A definition list has no bullets or ordered specifications and produces a cleaner layout then an unordered list (<UL> and <li> tags) or an ordered list (<ol> and <li> tags). If you choose to use the Boost Style Sheet you should add a <code>class="page-index"</code> attribute/value pair to the <dl> tag.[ORIG_END] --></p> <p><!--[TR_BEGIN]-->Большинство страниц должны содержать индекс страницы.<!-- [TR_END] --><!-- [ORIG_BEGIN]Most pages should include a Page Index.[ORIG_END] --></p> <h3><a name="content" id="content"></a>Documentation Content</h3> <p><!--[TR_BEGIN]-->Фактическое содержание документации страницы будет отформатировано в соответствии с конкретными потребностями отдельных страниц и должно быть размещено сразу после индекса страницы, если он присутствует, или после баннера страницы, если нет. В целом содержание документации будет принимать форму текста абзаца, содержащегося под заголовками разделов.<!-- [TR_END] --><!-- [ORIG_BEGIN]The page's actual documentation content will be formatted according to the specific needs of individual pages, and should be placed right after the Page Index if present, or after the Page Banner if not. In general the documentation content will take the form of paragraph text contained underneath section headings.[ORIG_END] --></p> <h3><a name="doc-footnotes" id="doc-footnotes"></a>Footnotes</h3> <p><!--[TR_BEGIN]-->Сноски могут использоваться в документации страницы. В содержании документации ссылка на сноску должна иметь форму номера сноски в скобках (скобки облегчают читателю переход по гиперссылке), гиперссылки на фактическую сноску в нижней части содержимого документации страницы. Вы можете использовать тег<sup>для форматирования таких номеров сносок, или, предпочтительно, вы можете использовать класс стилей CSS, чтобы различать номер как сноску, а не как часть фактического текста. Если вы решили использовать общий<a href="?tid=18502#boost-style-sheet">Повысить таблицу стилей</a>, для этой цели определен класс<<code>footnote</code>>.<!-- [TR_END] --><!-- [ORIG_BEGIN]Footnotes may be used within a page's documentation. Within the documentation content a footnote reference should take the form of a footnote number in parentheses (the parentheses make it easier for the reader to click on the hyper link) hyper linking to the actual footnote at the bottom of the page's documentation content. You may either use the <sup> tag to format such footnote numbers, or, preferably, you can use a CSS style class in order to distinguish the number as a footnote instead of as part of the actual text. If you choose to use the common <a href="?tid=18502#boost-style-sheet">Boost Style Sheet</a>, a <code>footnote</code> class is defined for this purpose.[ORIG_END] --></p> <h3><a name="revision-info" id="revision-info"></a>Revision Information</h3> <p><!--[TR_BEGIN]-->В нижней части каждой страницы должна быть некоторая информация о пересмотре, указывающая, когда страница была в последний раз пересмотрена. Эта информация должна быть отделена от остальной части страницы выше тегом<hr>. Для отслеживания этой информации о пересмотре можно использовать следующий фрагмент HTML-кода (этот код использует некоторые серверные компоненты, которые существуют на веб-сайте Boost, чтобы автоматически отслеживать даты пересмотра без необходимости ручного редактирования текста даты):<!-- [TR_END] --><!-- [ORIG_BEGIN]At the bottom of every page should be some revision information indicating when the page was last revised. This information should be separated from the rest of the page above by an <hr> tag. The following HTML code snippet can be used to track this revision information (this code uses some server components that exist on the Boost web site to automatically track revision dates with out the need for hand editing the date text):[ORIG_END] --></p> <pre> <hr> <p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> 01 January, 2001 <!--webbot bot="Timestamp" endspan i-checksum="39359" --> </p> </pre> <h3><a name="copyright" id="copyright"></a>Copyright Information</h3> <p><!--[TR_BEGIN]-->Нижняя часть страницы должна содержать любую информацию об авторских правах, которая относится к документу.<!-- [TR_END] --><!-- [ORIG_BEGIN]The very bottom of the page should contain any copyright information that applies to the document.[ORIG_END] --></p> <h2><a name="format" id="format"></a>Format</h2> <p><!--[TR_BEGIN]-->В этом разделе приведены общие рекомендации по форматированию документации с использованием HTML. В описании различных "общих страниц" приводятся конкретные детали форматирования конкретных разделов документации, которые должны отменять эти руководящие принципы.<!-- [TR_END] --><!-- [ORIG_BEGIN]This section provides general guidelines for formatting documentation using HTML. The description of the various "common pages" gave specific details for formatting specific sections of the documentation, which should override these guidelines.[ORIG_END] --></p> <h3><a name="code-format" id="code-format"></a>Code</h3> <p><!--[TR_BEGIN]-->Код в документации должен быть размещен в тегах<code></code>или<pre></pre>. Для кода, который размещен в соответствии с другим текстом, вы используете теги<code>/code>, в то время как теги<pre></pre>используются для кодовых «блоков». Если для определения форматирования этих тегов используется каскадная таблица стилей, следует использовать шрифт с фиксированной шириной без засечек. Это гарантирует, что код легко отличим от остальной части текста. Также может быть полезно установить стиль для тегов<pre></pre>, чтобы помочь отделить блоки кода от других структурных блоков HTML.<a href= "?tid=18502#boost-style-sheet">Повышенная таблица стилей</a>определяет форматирование для этих тегов.<!-- [TR_END] --><!-- [ORIG_BEGIN]Code within the documentation should be placed within either <code></code> or <pre></pre> tags. For code that's placed inline with other text you use <code></code> tags, while <pre></pre> tags are used for code "blocks". If a cascading style sheet is used to specify formatting for these tags, a fixed width sans serif font should be used. This insures that the code is easily distinguishable from the rest of the text. It may also be beneficial to set the style for <pre></pre> tags to indent the text, to help separate code blocks from other structural HTML blocks. The <a href= "?tid=18502#boost-style-sheet">Boost Style Sheet</a> specifies formatting for these tags.[ORIG_END] --></p> <p><!--[TR_BEGIN]--><b>Примечание:</b>"Код" включает в себя имена переменных, имена функций и т.д.<!-- [TR_END] --><!-- [ORIG_BEGIN]<b>Note:</b> "Code" includes variable names, function names, etc.[ORIG_END] --></p> <h3><a name="lists" id="lists"></a>Lists</h3> <p><!--[TR_BEGIN]-->Списки должны быть построены как неупорядоченные (<UL>и<li>теги), упорядоченные (<ol>и<li>теги) или списки определений (<dl>и<DT>теги) в HTML. Вы используете неупорядоченный список, когда вам нужна коллекция элементов, которые не имеют логического порядка, например, список типов данных, которые определены библиотекой и могут быть использованы для аргумента шаблона. Вы используете упорядоченный список, когда набор элементов должен быть сгруппирован в логическом порядке, например, при перечислении шагов, которые логически выполняет действие. Вы используете список определений, когда список состоит не только из элементов, которые не имеют логического упорядочения, но также содержит определения / описания / и т. д. элементов. Хорошим примером этого являются спецификации функций, описанные в<a href= "?tid=18501">Структура документации</a>.<!-- [TR_END] --><!-- [ORIG_BEGIN]Lists should be constructed as unordered (<UL> and <li> tags), ordered (<ol> and <li> tags) or definition (<dl> and <DT> tags) lists in HTML. You use an unordered list when you need a collection of items that don't have any kind of logical ordering, such as a list of data types that are defined by the library and can be used for a template argument. You use an ordered list when the collection of items must be grouped in a logical ordering, such as when enumerating the steps that an action logically performs. You use a definition list when the list consists of not only items that have no logical ordering, but also contains definitions/descriptions/etc. of the items. A good example of this is the function specifications as described in <a href= "?tid=18501">Documentation Structure</a>.[ORIG_END] --></p> <h3><a name="graphics" id="graphics"></a>Graphics</h3> <p><!--[TR_BEGIN]-->Графика должна использоваться очень экономно, если вообще. Графические изображения значительно влияют на время загрузки для многих людей, что может помешать пользователям читать документацию. Если вам нужны графические изображения, чтобы проиллюстрировать что-то в вашей документации, подумайте о том, чтобы предоставить только ссылку на изображение в документации, а не вставлять его непосредственно в текст. Если изображение будет включено в текст документа, вы должны указать размер изображения в теге<img>, чтобы браузер пользователя мог оптимизировать форматирование текста до загрузки изображения.<!-- [TR_END] --><!-- [ORIG_BEGIN]Graphics should be used very sparingly, if at all. Graphic images greatly effect the download time for many people, which can discourage users from reading the documentation. If you need graphic images to help illustrate something in your documentation consider supplying only a link to the image within the documentation, instead of embedding it directly in the text. If an image is going to be included in the text of the document you should specify the image's size in the <img> tag, in order to allow the user's browser to optimize the formatting of the text before the image is loaded.[ORIG_END] --></p> <h3><a name="non-breaking-spaces" id="non-breaking-spaces"></a>Non-breaking Spaces</h3> <p><!--[TR_BEGIN]-->Неразрывных пространств ( ) следует избегать в тексте HTML. Как правило, существуют более подходящие способы форматирования документа, такие как использование конструкций списков или указание отступов в качестве атрибута стиля или в каскадных таблицах стилей.<!-- [TR_END] --><!-- [ORIG_BEGIN]Non-breaking spaces (&nbsp;) should be avoided in HTML text. Generally there are more appropriate ways to format the document, such as using list constructs or specifying indentation as a style attribute or in cascading style sheets.[ORIG_END] --></p> <h3><a name="style-sheets" id="style-sheets"></a>Cascading Style Sheets</h3> <p><!--[TR_BEGIN]-->Каскадные таблицы стилей позволяют применять некоторые продвинутые стили форматирования к HTML-документу. Что еще более важно, они позволяют изменять форматирование в одном файле и влиять на все страницы с помощью таблицы стилей. Вместо того, чтобы пытаться создать определенный формат в HTML, часто проще и гибче указать форматирование в таблице стилей.<!-- [TR_END] --><!-- [ORIG_BEGIN]Cascading style sheets allow you to apply some advanced formatting styles to an HTML document. More importantly, they allow you to change the formatting in a single file and effect all pages using the style sheet. Instead of struggling to produce a specific format in HTML it's often easier and more flexible to specify the formatting in a style sheet.[ORIG_END] --></p> <h4><a name="boost-style-sheet" id="boost-style-sheet"></a>Boost Style Sheet</h4> <p><!--[TR_BEGIN]-->Концепция использования каскадных таблиц стилей для форматирования HTML настолько хороша, что может быть полезно применить ее на всем сайте Boost. Конечно, мы не можем требовать этого (если бы Boost требовали таких мелочей для представлений, вполне вероятно, что многие программисты были бы лишены возможности внести свой вклад). Тем не менее, стандартная таблица стилей Boost (http://www.boost.org/boost.css) предоставляется в любом случае, так что вкладчик может быстро и легко создать четкую и последовательную документацию, которая отражает «бренд Boost», если они того пожелают. Если позже будет принято решение об обновлении «бренда Boost», это может быть сделано в этом файле, и все документы, использующие таблицу стилей, будут автоматически обновлены.<!-- [TR_END] --><!-- [ORIG_BEGIN]The concept of using cascading style sheets to format HTML is such a good idea that it can be beneficial to apply this across the entire Boost site. Of course we can't require this (if Boost were to require such trivia for submissions it's likely that many programmers would be discouraged from contributing). However, a "standard" Boost style sheet (http://www.boost.org/boost.css) is supplied anyway, so that a contributer can quickly and easily produce clear and consistent documentation that reflects a Boost "brand" if they so choose. If, at a later date, it's decided to update the Boost "brand", it may be done in this single file and all documents using the style sheet will automatically be updated.[ORIG_END] --></p> <p><!--[TR_BEGIN]-->Поставляемый Boost стильный лист не только определяет стили для многих стандартных тегов, но и определяет несколько стилей «классов». Класс определяется для данного тега вместо того, чтобы применяться ко всем экземплярам данного типа тега. Ниже приведен список классов, указанных в таблице стилей Boost, и описание того, когда их использовать:<!-- [TR_END] --><!-- [ORIG_BEGIN]The Boost supplied style sheet not only specifies styles for many standard tags, it also specifies several style "classes". A class is specified for a given tag instead of being applied to all instances of a given tag type. Below is a list of the classes specified in the Boost style sheet and a description of when to use them:[ORIG_END] --></p> <dl> <dt><b>index</b> Used for <dl> tags when writing index lists.</dt> <dt><b>page-index</b> Used for <dl> tags when writing page index lists.</dt> <dt><b>Footnote</b> Used when writing Footnote numbers.</dt> <dt><b>function-semantics</b> Used for <dl> tags when writing function semantic lists.</dt> </dl> <h2><a name="templates" id="templates"></a>Templates</h2> <p><!--[TR_BEGIN]-->Вместо ручного кодирования каждой HTML-страницы можно использовать HTML-шаблоны. В приведенном ниже списке приведены ссылки на шаблоны, которые могут использоваться при написании документации для вклада в Boost. Ссылки, представленные в этих шаблонах, предполагают, что файлы будут находиться в «традиционной» иерархии каталогов<i>boost/libs/library/doc</i>. Им может потребоваться исправление, если файл будет находиться в другом месте.<!-- [TR_END] --><!-- [ORIG_BEGIN]Instead of hand coding every HTML page, HTML "templates" can be used instead. The list below provides links to templates that may be used when writing documentation for a contribution to Boost. Links provided in these templates assume the files will reside in the "traditional" directory hierarchy of <i>boost/libs/library/doc</i>. They may need correcting if the file will reside in some other location.[ORIG_END] --></p> <p><!--[TR_BEGIN]--><b>Примечание:</b>Поскольку эти «шаблоны» — это просто HTML-страницы, просто нажав на ссылки ниже, вы загрузите шаблон в свой браузер. Вам нужно будет использовать определенный браузерный метод для загрузки файлов вместо их загрузки в браузер (например, в большинстве браузеров Windows вы можете щелкнуть по ссылке и выбрать соответствующую команду из контекстно-чувствительного меню).<!-- [TR_END] --><!-- [ORIG_BEGIN]<b>Note:</b> Since these "templates" are just HTML pages simply clicking on the links below will load the template in your browser. You will need to use a browser specific method to download the files instead of loading them into the browser (for instance, on most Windows browsers you can right click on the link and select the appropriate command from the context sensitive menu).[ORIG_END] --></p> <ul> <li><a name="index-template" id="index-template"></a><a href= "template/index.html">Index Page Template</a></li> <li><!--[TR_BEGIN]--><a name="overview-template" id="overview-template"></a><a href= "template/overview.html">Шаблон обзора страницы</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="overview-template" id="overview-template"></a><a href= "template/overview.html">Overview Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="definitions-template" id="definitions-template"></a><a href= "template/definitions.html">Определения шаблона страницы</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="definitions-template" id="definitions-template"></a><a href= "template/definitions.html">Definitions Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="rationale-template" id="rationale-template"></a><a href= "template/rationale.html">Рациональный шаблон страницы</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="rationale-template" id="rationale-template"></a><a href= "template/rationale.html">Rationale Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="configuration-template" id= "configuration-template"></a><a href= "template/configuration.html">Шаблон страницы конфигурации</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="configuration-template" id= "configuration-template"></a><a href= "template/configuration.html">Configuration Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="faq-template" id="faq-template"></a><a href= "template/faq.html">FAQ (Часто задаваемые вопросы) Шаблон страницы</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="faq-template" id="faq-template"></a><a href= "template/faq.html">FAQ (Frequently Asked Questions) Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="bibliography-template" id= "bibliography-template"></a><a href= "template/bibliography.html">Библиографический шаблон страницы</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="bibliography-template" id= "bibliography-template"></a><a href= "template/bibliography.html">Bibliography Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="acknowledgements-template" id= "acknowledgements-template"></a><a href= "template/acknowledgments.html">Признательные страницы Шаблон</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="acknowledgements-template" id= "acknowledgements-template"></a><a href= "template/acknowledgments.html">Acknowledgments Page Template</a>[ORIG_END] --></li> <li><!--[TR_BEGIN]--><a name="header-template" id="header-template"></a><a href= "template/header.html">Шаблон заголовка страницы</a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a name="header-template" id="header-template"></a><a href= "template/header.html">Header Page Template</a>[ORIG_END] --></li> </ul> <hr> <p><!--[TR_BEGIN]--><a href="http://validator.w3.org/check?uri=referer"><img border="0" src= "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional" height="31" width="88"></a><!-- [TR_END] --><!-- [ORIG_BEGIN]<a href="http://validator.w3.org/check?uri=referer"><img border="0" src= "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional" height="31" width="88"></a>[ORIG_END] --></p> <p><!--[TR_BEGIN]-->Пересмотрено<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04 Декабря 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --><!-- [TR_END] --><!-- [ORIG_BEGIN]Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" -->[ORIG_END] --></p> <p><!--[TR_BEGIN]--><i>Авторское право и копия; 2001<a href= "mailto:williamkempf@hotmail.com">Уильям Э. Кемпф</a></i><!-- [TR_END] --><!-- [ORIG_BEGIN]<i>Copyright © 2001 <a href= "mailto:williamkempf@hotmail.com">William E. Kempf</a></i>[ORIG_END] --></p> <p><!--[TR_BEGIN]--><i>Распространяется в соответствии с лицензией Boost Software License, Version 1.0. (См. сопроводительный файл<a href="?tid=3">LICENSE_1_0.txt</a>или копию по адресу<a href= "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt)</a></i><!-- [TR_END] --><!-- [ORIG_BEGIN]<i>Distributed under the Boost Software License, Version 1.0. (See accompanying file <a href="?tid=3">LICENSE_1_0.txt</a> or copy at <a href= "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i>[ORIG_END] --></p> <p>Статья <strong>Writing Documentation for Boost - HTML Design</strong> раздела <a href = "/?did=0"></a> может быть полезна для разработчиков на c++ и boost.</p><noindex><br><br><br><p class="copyrighttext">Материалы статей собраны из открытых источников, владелец сайта не претендует на авторство. Там где авторство установить не удалось, материал подаётся без имени автора. В случае если Вы считаете, что Ваши права нарушены, пожалуйста, свяжитесь с владельцем сайта.</p><br> </noindex><hr><p align="center">:: <a href="/">Главная</a> :: <a href = "/?did=0"></a> :: </p><hr><table class="orangetable" width="99%" border="0" cellpadding="4" cellspacing="2"><tr><td class="orangeheader"><p class="smalltext">реклама</p></td></tr> <tr><td class="copyrighttext"> <!-- SAPE RTB DIV 600x340 --> <div id="SRTB_907055"></div> <!-- SAPE RTB END --> </td></tr></table> <hr> <div align="center"> <form action="/index.php?do=find" method="post" enctype="application/x-www-form-urlencoded" name="form1"> <input name="find" type="text" id="find" size="45"> <input type="submit" name="Submit" value="Поиск по сайту"> </form> </div> </td> <td width="20"> </td></tr> <tr><td Height="13" colspan="3" class="copyrighttext"><div align="center"> ©KANSoftWare (<em><a href="https://www.kansoftware.ru/">разработка программного обеспечения</a>, <a href="https://www.kansoftware.ru/">создание программ</a>, <a href="https://www.kansoftware.ru/">создание интерактивных сайтов</a></em>), 2007<br> <noindex> <!-- Top.Mail.Ru counter --> <script type="text/javascript"> var _tmr = window._tmr || (window._tmr = []); _tmr.push({id: "662961", type: "pageView", start: (new Date()).getTime()}); (function (d, w, id) { if (d.getElementById(id)) return; var ts = d.createElement("script"); ts.type = "text/javascript"; ts.async = true; ts.id = id; ts.src = "https://top-fwz1.mail.ru/js/code.js"; var f = function () {var s = d.getElementsByTagName("script")[0]; s.parentNode.insertBefore(ts, s);}; if (w.opera == "[object Opera]") { d.addEventListener("DOMContentLoaded", f, false); } else { f(); } })(document, window, "tmr-code"); </script> <noscript><div><img src="https://top-fwz1.mail.ru/counter?id=662961;js=na" style="position:absolute;left:-9999px;" alt="Top.Mail.Ru" /></div></noscript> <!-- /Top.Mail.Ru counter --> <!-- Top.Mail.Ru logo --> <a href="https://top-fwz1.mail.ru/jump?from=662961"> <img src="https://top-fwz1.mail.ru/counter?id=662961;t=472;l=1" height="31" width="88" alt="Top.Mail.Ru" style="border:0;" /></a> <!-- /Top.Mail.Ru logo --> </noindex> </div></td><td> </td></tr> </table> </body> </html> <p>Время компиляции файла: 2024-08-30 11:47:00<br>2025-05-20 08:30:58/0.0120530128479/0</p>