|
Правила логического и физического оформления документов |
В данном документе описаны правила оформления документов, обязательные для выполнения участниками проекта.
Документы, предназначенные для включения в общий свод документации 3ОС, и соответственно, размещению на сайте, должны использовать CSS 3OSDoc.css.
Ниже приведены правила логического оформления документов, принятые в проекте. Это значит, что все документы, составляемые участниками проекта, должны иметь общую логическую структуру. Руководствуюсь, изложенными правилами, вы сможете легко придерживаться такой структуры и создавать переносимые в рамках проекта документы.
Любой документ проекта делиться на разделы. Первый раздел документа обязательно должен называться "Что в этом документе" и содержать краткую аннотацию текста. Остальные разделы именуются в зависимости от содержимого и могут содержать любое количество подразделов.
В случае необходимости, документ может делиться на части. Часть является своего рода самостоятельным документов в документе. Число частей в документе не ограничивается, но не рекомендуется злоупотреблять данной возможностью.
При наличии примечаний, в конец документа добавляется раздел "Примечания". Кроме этого, каждый документ должен содержать заголовок с названием документы и эмблему проекта.
Как уже было сказано выше, часть является, по сути, отдельным документом в документе. Таким образом, ее структура полностью совпадает со структурой документа в целом, с той лишь разницей, что раздел "Что в этом документе?" отсутствует. Если имеется описание части, оно дается в ее начале и выделяется курсивом.
Если позволяет содержание документа, каждая часть должна быть оснащена выводами, которые располагаются в конце части.
Раздел представляет собой самостоятельный блок текста в документе, имеющий заголовок и тело. Заголовок должен выражать основную мысль, описываемую в разделе.
Раздел также может иметь подразделы, степень вложенности которых ограничивается только здравым рассудком составителя документа. Структура подраздела полностью совпадает со структурой раздела.
Все заголовки заключаются только в теги <Hn></Hn>. При этом:
Запрещается явно указывать шрифт, цвет и стиль выравнивания заголовков.
Текст заключается между тегами <p></p>. Явно указывать цвет и шрифт текста запрещается.
Код в документах заключается в теги <pre> и </pre>. Как и прежде, размер шрифта и цвет текста указывать запрещено.
Выделение понятий и логическое ударение может осуществляться:
Ссылки, как обычно, обрамляются тегами <a href="ссылка">текст ссылки</a>. Ссылки между документами 3ОС обязательно должны быть относительными. Абсолютными могут быть только ссылки на документы, располагающиеся вне сайта 3ОС, где-либо в Интернете.
В большинстве случаев, если порядок следования объектов перечисления не регламентирован, нужно пользоваться маркированными списками.
Нумерованные списки нужны в том случае, если порядок следования объектов перечисления жестко закреплен, или имеются ссылки на порядковый номер одного из объектов (например, пункт 2 или второй пункт).
Формулы оформляются отдельным абзацем с выравниванием по центру: <p align="center">Формула</p>
Следование приведенным выше правилам позволит вам создавать переносимые в рамках 3ОС документы. В случаях, не описываемых правилами, следует придерживаться стандартов W3C.
Также запрещается использовать специфические возможности конкретного браузера, либо другого интерпретатора HTML.