Template:Text-mdf/doc

From Wikisource
Jump to navigation Jump to search

ru:

Шаблон предназначен для оформления страниц текстов Мокшанской Викитеки, и позволяет включить применение средств форматирования к нужному блоку текста на странице. Форматирование позаимствовано из Русской Викитеки — частично скопировано из css-стилей которые применяются при включении текста в блок <div class='text'>, но в то же время расширено параметрами для возможности доп. настройки.

Параметры:

  • w (необязательный): сокращение от "wide" ("широкий")
  • если установлен в 1 то используется "широкое" форматирование — "margin-right:3.5em;margin-left:3.5em;" (по умолчанию размер полей 3.5em, если нужно, можно указать другой — см. ниже параметр margin)
  • иначе используется "узкое" фoрматирование — текст идёт в виде полосы посередине страницы, с ограниченной шириной, установленной: "width: 84ex; margin: 0px auto;". Этот вариант используется также и по умолчанию (когда параметр не указан).
  • noindent (необязательный):
  • если установлен в значение не равное 0, то абзацы текста оформляются без отступов
  • иначе — используется (как и в Русской ВТ) отступ: "text-indent: 1.6em;". Данный вариант используется также и по умолчанию (когда параметр не указан).
  • margin (необязательный): используется при "широком" форматировании (когда w установлен в 1)
  • если установлен в значение 0, то поля не добавляются;
  • если любое другое значение — то добавляются поля указанного размера;
  • если не указать данный параметр — то по умолчанию добавляются поля размером 3.5em.

Использование: Вызов шаблона нужно вставить перед нужным блоком текста, прописав нужные значения параметров (или оставив незаполненными если нужно поведение по умолчанию). В конце блока текста нужно поместить вызов шаблона Template:Text-mdf-end, который "отключает" форматирование для последующего текста.

Пример:

{{text-mdf|w=1|noindent=1}}
Текст
{{text-mdf-end}}

en:

This template is for using as a formatting tool in the pages (of the main namespace) of the Mokshan Wikisource. It applies some properties (font, margins etc.) to a text where it is included. It has been designed based on the formating which is commonly used in the Russian Wikisource (on its own subdomain) and turned there on via <div class='text'>, and is similar to that one providing some additions.

Actually, this template merely inserts tag div supplied with style parameter assigned to required formatting values.

Parameters:

  • w (optional): abbreviation of "wide"
  • if it is set to 1 then "wide" text is used — "margin-right:3.5em;margin-left:3.5em;" (margins' size defaults to 3.5em, if other size is required — see the parameter margin below)
  • otherwise "narrow" (similar to standard in the Russian WS) is used — "width: 84ex; margin: 0px auto;". This option is also used as default (when the parameter is omitted).
  • noindent (optional):
  • if is set to any value different from 0 then no indentation of the paragraphs is set in the text
  • otherwise (when the parameter is omitted or explicitly set to 0) — set "text-indent: 1.6em;"
  • margin (optional): used when "wide" formatting is enabled (when "w" is set to 1)
  • if set to 0, then margins are not applied;
  • if set to any other value, then margins are set to that value;
  • if parameter is omitted, then, by default, margins of 3.5em are used.

Usage: A template call should be inserted (provided parameters' values if needed) before a block of text the formatting is needed to be applied to. It pairs with Template:Text-mdf-end which is merely the closing </div> tag and should be put at the end of the text which is formatted.

Example:

{{text-mdf|w=1|noindent=1}}
Текст
{{text-mdf-end}}