Фэндом

Smalltalk по-русски

Соглашения по оформлению документации

239статей на
этой вики
Добавить новую страницу
Обсуждение0 Поделиться

Замечания Править

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

Соглашения о структуре и о именовании страниц Править

Каждое руководство представляется в виде набора страниц.

Заглавная страница Править

Заглавная страница называется по названию руководства. При этом, если в названии руководства отсутствует название диалекта (например, VisualWorks), то оно добавляется в название заглавной страницы, заключённое в скобки. Заглавная страниц содержит оглавление руководства. Если количество разделов в руководстве велико, то заглавная страница содержит только краткое оглавление (разделы верхнего уровня), глубина оглавления определяется исходя из количества разделов. Ориентироваться надо на примерно такой объём текста, чтобы он занимал не больше двух экранов.

Оглавления разделов Править

Если всё оглавление не влезло на заглавную страницу, то создаются страницы разделов руководства (на которые есть ссылки с заглавной страницы), содержащие оглавления разделов. Страницы разделов называются по такой схеме: "Название руководства/Название раздела" (т.е. имитируют подстраницы). Категории для разделов не прописываются. Для ссылок на заглавную страницу и на следующий/предыдущий разделы руководства используется шаблон "navigation". В зависимости от величины оглавления раздела ссылки могут идти как на непосредственно текст руководства, так и на оглавления подразделов. Все правила, относящиеся к разделам, относятся и к подразделам. Страницы подразделов называются по схеме: "Название руководства/Название раздела/Название подраздела" (т.е. опять-таки имитируют подстраницы).

Текст разделов руководства Править

Текст переписывается максимально близко к оригиналу (для документации по VisualWorks - pdf-кам, идущим в дистрибутиве VisualWorks 7.4 NC). Оформление текста сохраняется максимально близко к оригиналу. Для ссылок на другие разделы руководства используется шаблон "navlink", при этом из ссылок убирается информация о номерах страниц руководства. Вообще, вся информация о номерах страниц максимально заменяется wiki-ссылками. Если общий объём раздела не превышает двух экранов (вместе с оглавлением), то можно весь раздел оформить как одну wiki-страницу (без выделения отдельной страницы под оглавление).

Шаблоны Править

navigation Править

Используется следующим образом:

{{navigation|
  toc=Название руководства|
  up=Название раздела|
  back=Название предыдущей страницы|
  forward=Название следующей страницы}}

Результат будет выглядеть так (пример приведён для страницы подраздела "Audience" раздела "About This Book" руководства "Application Developer's Guide (VisualWorks)"):


Оглавление
Назад | Вверх | Вперёд


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

Любые параметры, кроме toc (названия руководства), могут быть опущены, например:

{{navigation|
  toc=Название руководства|
  forward=Название следующей страницы}}

или

{{navigation|
  toc=Название руководства|
  up=Название раздела|
  back=Название предыдущей страницы}}

Параметр "up" (название раздела) предлагается опускать, если уровнем выше находится только заглавная страница руководства (т.е. мы находимся на странице раздела первого уровня вложенности).

Параметр "back" (название предыдущей страницы) предлагается опускать, если мы находимся на первой странице данного раздела (подраздела).

Соответственно, параметр "forward" (название следующей страницы) предлагается опускать, если мы находимся на последней странице данного раздела (подраздела).

navlink Править

Предназначен для ссылок на страницы руководств.

Используется следующим образом:

{{navlink|Название руководства/Название раздела|Название страницы}}

Пример (для ссылки на "Application Developer's Guide (VisualWorks)/About This Book/Additional Sources of Information"):

{{navlink|Application Developer's Guide (VisualWorks)/About This Book|Additional Sources of Information}}

Результат: Additional Sources of Information.


Может использоваться в виде

{{navlink|Название руководства|Название раздела}}

Пример:

{{navlink|Application Developer's Guide (VisualWorks)|About This Book}}

Результат: About This Book.


Также может использоваться в виде

{{navlink|Название руководства/Название раздела/Название подраздела|Название страницы}}

(и далее любого уровня вложенности).

Обнаружено использование расширения AdBlock.


Викия — это свободный ресурс, который существует и развивается за счёт рекламы. Для блокирующих рекламу пользователей мы предоставляем модифицированную версию сайта.

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

Также на Фэндоме

Случайная вики