Правила разметки Textile

Материал из Энциклобогии
Перейти к: навигация, поиск

Textile — язык упрощённой разметки текста, использующийся для оформления летописи героя на странице героя и постов на форуме и позволяющий вместо кода HTML пользоваться текстовыми условными знаками. При этом в пределах Годвилля используются далеко не все стандартные функции, а лишь наиболее востребованные.


При создании нового сообщения на форуме рядом с полем ввода отображается краткая справка по форматированию с основными подсказками[1], проверить внешний вид сообщения до его отправки можно и нужно с помощью кнопки «Предварительный просмотр». [2] Летопись таким вспомогательным функционалом не обладает.


Действующие правила разметки

Одинарное нажатие кнопки Enter отображается переносом строки в поле ввода, но в конечном отображаемом результате автозамена на HTML-тег не производится, поэтому разнесённые таким образом строки будут обратно склеены в единый абзац. В случае необходимости перенести строку без формирования абзаца, можно использовать HTML-тег <br>, переносящий строку принудительно. Для формирования абзаца не только визуального, но и функционального следует выделить его из прочего текста пустыми строками (по одной и сверху, и снизу). Некоторые директивы Textile распознаются (и преобразуются в соответствующие HTML-теги), только если необходимый текст выделен описанным способом в абзац.


Форум Летопись Textile Требует
выделения
абзаца
Отображение [3]
v v _курсивный_ Это курсивный текст
v v *полужирный* Это полужирный текст
v v -зачёркнутый- Это зачёркнутый текст
v v +подчёркнутый+ Это подчёркнутый текст
v v "замещающий текст":ccылка (например, http://wiki.godville.net/Форум) Ссылка, указанная после двоеточия встраивается в выделенный синим замещающий текст
v X "Имя бога":пс Вспомогательная функция форума формирует ссылку на страницу бога автоматически из введённого имени.
v v Списки (могут быть вложенными, в том числе комбинированного типа)

Нумерованный список:
# Пункт уровня 1
# Пункт уровня 1
## Подпункт уровня 2
## Подпункт уровня 2
# Пункт уровня 1

Ненумерованный список:
* Пункт уровня 1
* Пункт уровня 1
** Подпункт уровня 2
** Подпункт уровня 2
* Пункт уровня 1


(каждый элемент должен начинаться с новой строки)

только в летописи Нумерованный список:
  1. Пункт уровня 1
  2. Пункт уровня 1
    1. Подпункт уровня 2
    2. Подпункт уровня 2
  3. Пункт уровня 1


Ненумерованный список:

  • Пункт уровня 1
  • Пункт уровня 1
    • Подпункт уровня 2
    • Подпункт уровня 2
  • Пункт уровня 1
v v bq. Цитата (либо цт. Цитата) да Выделение рамкой с зелёным фоном для приведения цитат (нет прямого аналога в энциклобогии ).
v v bc. Текст без форматирования да
Текст без форматирования 

Вставка текста без обработки разметки (теги <pre><code>).
Следует использовать с осторожностью.
Для переноса строки используется одинарное нажатие клавиши Enter.
Такой перенос работает многократно.
v v pre.Текст без форматирования да
Текст без форматирования 

Аналог bc.(только тег <pre>)
При отображении на форуме отличается размером шрифта.
v v notextile.Текст без форматирования да

Текст без форматирования. Аналог bc. Просто игнорирует разметку Textile. При отображении отличается размером шрифта и (на форуме) рамкой, которой выделен текст. Игнорирует одинарные переносы строки.

v v ^надстрочный^ Это надстрочный текст
v X ~подстрочный (на форуме)~ Это подстрочный текст
v @подстрочный@ (в летописи) Это подстрочный текст
v @моноширинный@ (на форуме) Это моноширинный текст
v v многоточие... многоточие… (три точки автоматически заменяются на единый символ)
v v короткое - тире короткое – тире (символ дефиса, окружённый пробелами, автоматически заменяется на тире)
v v длинное -- тире длинное — тире (два символа дефиса автоматически заменяются на длинное тире)
v v 2 х 2 = 4 2 × 2 = 4 (латинская буква «x» между двумя числами, отделённая отступами, автоматически заменяется знаком умножения)
v v копирайт (c) копирайт ©
v v знак правовой охраны товарного знака (r) знак правовой охраны товарного знака ®
v v товарный знак (tm) товарный знак ™
X без перехода[4] краткая сноска [1] краткая сноска [2] краткая сноска [fn 1] краткая сноска [fn 2]
X без перехода fn1. текст сноски да
  1. текст сноски 1
  2. текст сноски 2
X X !file.jpg! <img src="file.jpg" />

Не поддерживается, но подстановка пустого тега осуществляется. Поэтому, чтобы избежать неправильного отображения текста между двумя восклицательными знаками в различных кодах следует пользоваться модификаторами bc., pre. или notextile.

X X заголовки h1...h6 и некоторая другая разметка Может также не отображаться вместе с включённым в неё текстом. Приём, решающий проблему аналогичен.


Примечания

  1. Пользователи расширенного интерфейса имеют в своём распоряжении также наглядные кнопки, применяющие элементы разметки, приведённые в подсказке, к выделенному тексту.
  2. В дополнение к этому для проб и тестов работы разметки заведена специальная ветка форума.
  3. Отображение приведено условно с применением встроенных средств энциклобогии, в месте применения внешний вид результата может отличаться.
  4. Реализовано только внешнее оформление сносок, нажатие на ссылку не приводит к выравниванию экрана.