Об оформлении текстов

» опубликован
» категория: Справочные статьи
» является статьей справочного раздела: Да
Специально для XGM был разработан новый формат разметки текста - txt2, заменивший используемые ранее BB-коды. Важно помнить, что BB коды больше не поддерживаются.
Новый формат относится к так называемым легковесным языкам разметки и обладает следующими преимуществами по сравнению с BB-кодами:
  1. проще набирать, во многих случаях не требуется переключать раскладку, отпадает необходимость во вспомогательных панелях редактирования;
  2. многие конструкции (выделение слов через *, цитаты через >) являются привычными для тех, кто часто пользуется email или мессенджерами типа Jabber или ICQ;
  3. текст хорошо читается даже в исходном виде без обработки, что облегчает цитирование и редактирование сообщений;
  4. новые возможности - вставка изображений сбоку от текста, вставка таблиц.

Базовое форматирование

Следует напомнить, что использование средств форматирования не для смыслового выделения, а в целях "украшательства" является нарушением п1.4 правил пользования сайтом, особенно это касается изменения цвета текста.
эффекткодрезультат
полужирный*слово*, **несколько слов**слово, несколько слов
курсив_слово_, __несколько слов__слово, несколько слов
зачеркивание-слово-, --несколько слов--слово, несколько слов
выделение красным!слово!, !!несколько слов!!слово, несколько слов
выделение зеленым+слово+, ++несколько слов++слово, несколько слов
выделение синим?слово?, ??несколько слов??слово, несколько слов
моноширинный шрифт""monospaced font""monospaced font
оффтопик// оффтоп //, // оффтопоффтоп
отключение форматирования{{*текст*}}*текст*
ссылкаhttp://xgm.guruxgm.guru
ссылка с текстомXGM (http://xgm.guru)XGM
ссылка из нескольких слов__сайт XGM__ (http://xgm.guru)сайт XGM
ссылка на пользователя~ZlaYa1000, ~~Q w e r t y~~ZlaYa1000, Q w e r t y
Комбинации из одного знака (*, _, -, !, +,?) действуют только на одно слово и не могут выделять часть слова. Комбинации из двух знаков действуют на любое количество символов в пределах одной строки. Комбинации из трех и более знаков не обрабатываются.

Популярные ссылки

Для часто используемых ссылок можно использовать на месте URL в любом из трех описанных выше форматов ссылок следующие сокращения:
w:Wikipedia - Wikipedia
в:Википедия - Википедия
g:Google - Google
я:Яндекс - Яндекс
s:поиск+по+сайту - поиск по сайту
При запросах из нескольких слов пробелы следует заменять на символ + (в случае Википедии - на _)

Расширенное форматирование

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

Изображения

Для вставки изображения следует вставить в текст прямую ссылку на него на отдельной строке - в этом случае будет вставлена полноразмерная картинка.
Ссылки на полную и уменьшенную версию (превью) определяются автоматически.
Вставка изображений внутри строки, а также изображений со сторонних хостингов изображений, не поддерживается и не рекомендуется.
Пример:
http://xgm.guru/pics/article/22468_1t.png
Результат:
Для вставки сбоку от текста либо по центру следует дописать перед ссылкой один из следующих префиксов (в этом случае будет вставлена миниатюра изображения с увеличением по клику): "->" - справа от текста, "<-" - слева от текста и "<>" - по центру.
Пример:
-> http://xgm.guru/pics/article/25886_1.png - справа от текста
<- http://xgm.guru/pics/article/25886_1.png - слева от текста
<> http://xgm.guru/pics/article/25886_1.png - по центру
Для вставки нескольких изображений подряд каждую ссылку с соответствующим префиксом следует разместить на отдельной строке.
Можно добавлять описания изображениям после ссылки через " - ".
Результат:
Для создания галереи изображений используется следующий формат:
((галерея
http://xgm.guru/pics/article/22468_1t.png - картинка 1
http://xgm.guru/pics/article/22468_1t.png - картинка 2
http://xgm.guru/pics/article/22468_1t.png - картинка 3
))
Результат:
Две и более идущие подряд ссылки на изображения без выравнивания автоматически преобразуются в галерею. Если это преобразование нежелательно, можно вставить пустые строки между ссылками.
Можно вставлять также ряд изображений-ссылок (при нажатии на изображение пользователя переносит на определенную ссылку). Работает только с двумя и более изображениями.
Пример:
http://xgm.guru/pics/article/22468_1t.png (http://xgm.guru/p/help/txt2)
http://xgm.guru/pics/article/22468_1t.png (http://xgm.guru/p/help/txt2)
Результат:
Каждый ресурс может иметь свой уникальный аватар в кратком описании (иконка ресурса в ленте). Для этого нужно в начале первой строки краткого описания разместить следующего вида ссылку:
Пример:
<- http://xgm.guru/pics/article/25886_1.png

Видео

Для вставки видеоролика следует вставить на отдельной строке ссылку на страницу с роликом.
В настоящий момент поддерживаются следующие хостинги видео:

Музыкальный проигрыватель

Чтобы вставить плеер со звуковым файлом, необходимо сначала прикрепить желаемый аудиофайл к посту, а затем нажать "Файлы ресурса" - "вставить ссылку на файл". После сохранения на месте ссылки будет отображен плеер.
Выглядит это примерно так:

Unity Web Player

Чтобы вставить плеер кнопку запуска веб приложений написанных с использованием Unity3D, необходимо сначала прикрепить желаемое приложение к посту, а затем нажать "Файлы ресурса" - "вставить ссылку на файл". После сохранения на месте ссылки будет отображаться кнопка для запуска этого приложения.
Выглядит это примерно так:
Unity Logo Запустить плеер:
web_test.unity3d

Заголовки

Для разных уровней задаются знаки "равно":
  • На новой строке;
  • Перед и после имени;
  • Только перед именем.
Количество знаков "=" - произвольное.
Предусмотрены ссылки на ресурсы с переходом сразу на конкретный заголовок. Для этого к ссылке необходимо прибавить #hn, где n - номер заголовка. Форматы номера:
h1 - первый заголовок первого уровня
h1.1 - первый заголовок второго уровня под первым заголовком первого уровня
h1.1.1 - первый заголовок третьего уровня под первым второго и первого уровней
Пример:
Заголовок первого уровня
=

=== Заголовок второго уровня ===
=== Заголовок третьего уровня

http://xgm.guru/p/help/txt2#h5 - ссылка ведёт на данную главу
http://xgm.guru/p/help/txt2#h15.3 - ссылка ведёт на 3 подзаголовок 15 заголовка
» Результат (кликнуть)

Заголовок первого уровня

Заголовок второго уровня

Заголовок третьего уровня

Цитаты

Пример:
> цитата
> возможно, многострочная
>
> символ > ставится на каждой строке
> пробел после > *обязателен* даже для пустых строк
> > цитаты могут быть вложенными
ответ на цитату - простой перевод строки
> при этом ответ может не отделяться пустой строкой от цитируемого текста
Результат:
цитата
возможно, многострочная
символ > ставится на каждой строке
пробел после > обязателен даже для пустых строк
цитаты могут быть вложенными
ответ на цитату - простой перевод строки
при этом ответ может не отделяться пустой строкой от цитируемого текста
Альтернативный вариант:
((цитата
многострочная цитата
без выделения каждой строки
))

Разделитель страницы

Один или более знаков "-" на отдельной строке заменяет их на горизонтальную линию по ширине страницы.
Пример:
--
Результат:

Выравнивание

Если надо центрировать блок текста, и тег заголовка для этого не подходит, это можно сделать так:
((центр
текст по центру
))
Для выравнивания по правому краю используется аналогичный формат:
((вправо
текст по правому краю
))

Каты (спойлеры, скрытый текст)

Пример:
>> смотреть сюда
текст под катом
<<
Результат:
» смотреть сюда
текст под катом
Альтернативный вариант (можно использовать для создания вложенных катов):
((кат смотреть сюда
текст под катом
))
Результат:
» смотреть сюда
текст под катом

Блоки кода

Начинаются с "" на отдельной строке, заканчиваются "" на отдельной строке.
Если надо внутри такого блока вставить "" на отдельной строке, следует поставить лишний пробел в конце такой строки.
Пример:
""
function H2I takes handle h returns integer
return h
return 0
endfunction
""
Результат:
function H2I takes handle h returns integer
	return h
	return 0
endfunction

Альтернативный вариант:
Пример:
((код jass
function H2I takes handle h returns integer
...
))
Результат:
function H2I takes handle h returns integer
...
endfunction

Блоки кода с подписью
Такое возможно только с помощью альтернативного способа.
Пример:
((код jass - Простой пример функции на Jass
function H2I takes handle h returns integer
...
endfunction
))
Результат:

Простой пример функции на Jass

function H2I takes handle h returns integer
...
endfunction
Язык (perl, php, css, xml, html, javascript, java, cpp, delphi, sql, jass) можно указать, если автоматическое определение срабатывает некорректно.

Отключение форматирования

Начинается с {{ на отдельной строке, заканчивается }} на отдельной строке.
Если надо внутри такого блока вставить }} на отдельной строке, следует поставить лишний пробел в конце такой строки.
Блоки кода также отключают форматирование.
Пример:
{{
> *здесь* не действуют никакие правила форматирования
}}
Результат:
> *здесь* не действуют никакие правила форматирования

Списки

Пример:
- первый пункт
- второй пункт
 1. подпункт два-один
   * подпункт два-один-один
   * подпункт два-один-два
 2. подпункт два-два
- третий пункт
Результат:
  • первый пункт
  • второй пункт
    1. подпункт два-один
      • подпункт два-один-один
      • подпункт два-один-два
    2. подпункт два-два
  • третий пункт
Количество пробелов произвольное, но все маркеры одного списка должны иметь одинаковый отступ (пробелами либо табуляциями), и строки между маркерами должны иметь больший отступ.
* и - полностью взаимозаменяемы, для нумерованных списков также распознается формат со скобкой и пробелом после числа - 1) , 2) и т.д.

Полоса прогресса

Пример:
[ 5%]
[ 10% ] - элементарный вариант
[ 2 / 5 ] - расширенный
[ 4 / 3 - 19 ] - профессиональный, где 4 - текущее значение, 3 - минимальное значение, 19 - максимальное значение
[ 28.11.2015 / 27.11.2016 ] - обратный отсчёт, где первое значение - дата старта, второе - дата финиша
Результат:
5%
10% - элементарный вариант
2 / 5 (40%) - расширенный
6% - профессиональный, где 4 - текущее значение, 3 - минимальное значение, 19 - максимальное значение
Осталось 0 дней (100%) - обратный отсчёт, где первое значение - дата старта, второе - дата финиша

Таблицы

Пример:
столбец1|столбец2|столбец3
--------------------------
1-1 | 1-2 | 1-3
2-1 | 2-2 | 2-3
Результат:
столбец1столбец2столбец3
1-1 1-2 1-3
2-1 2-2 2-3
Перед таблицей обязательно наличие пустой строки.
Вместо | могут использоваться символы табуляции, для вставки из Word или других страниц.
Если строк в таблице 3 и более, заголовок можно опустить.

Расширенные примеры

Исходный код таблицы базового форматирования

» Открыть
эффект	код	результат
-
полужирный	{{*слово*, **несколько слов**}}	*слово*, **несколько слов**
курсив	{{_слово_, __несколько слов__}}	_слово_, __несколько слов__
зачеркивание	{{-слово-, --несколько слов--}}	-слово-, --несколько слов--
выделение красным	{{!слово!, !!несколько слов!!}}	!слово!, !!несколько слов!!
выделение зеленым	{{+слово+, ++несколько слов++}}	+слово+, ++несколько слов++
выделение синим	{{?слово?, ??несколько слов??}}	?слово?, ??несколько слов??  
моноширинный шрифт	{{""monospaced font""}}	""monospaced font""
оффтопик	{{// оффтоп //,  // оффтоп}}	// оффтоп
отключение форматирования	{{{{*текст*}}}}	{{*текст*}}
ссылка	{{http://xgm.guru}}	http://xgm.guru
ссылка с текстом	{{XGM (http://xgm.guru)}}	XGM (http://xgm.guru)
ссылка из нескольких слов	{{__сайт XGM__ (http://xgm.guru)}}	__сайт XGM__ (http://xgm.guru)
ссылка на пользователя	{{~ZlaYa1000, ~~__Dark Lord__~~}}	~ZlaYa1000, ~~Dark Lord~~

Англоязычные аналоги

Для некоторых альтернативных вариантов действуют англоязычные аналоги: "gallery", "quote", "center", "right", "code".

Спрятанный код

Пример:
>> code
""
int main(int argc, wchar_t ** argv) { return 0; }
""
<<
Результат:
» code
int main(int argc, wchar_t ** argv) { return 0; }

Видео по центру

Пример:
((центр
http://www.youtube.com/watch?v=18aCtDi1bLw
))

Большая картинка по центру

Пример:
((центр
http://xgm.guru/pics/article/22468_1t.png
))

Несколько картинок по центру

Пример:
((центр
<> http://xgm.guru/pics/article/22468_1t.png
<> http://xgm.guru/pics/article/22468_1t.png
<> http://xgm.guru/pics/article/22468_1t.png
))
Результат:

Галерея по центру

Пример:
((центр
((галерея
http://xgm.guru/pics/article/22468_1t.png - Я
http://xgm.guru/pics/article/22468_1t.png - люблю
http://xgm.guru/pics/article/22468_1t.png - модмейкинг!
))
))
Результат:

Опросы

((опрос Что это такое?
Первый опрос на сайте!
Невероятная вещь
Какой то квадрат
))
Результат:
Опрос: Что это такое?

Всего проголосовали: 228

И помните,

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


Просмотров: 32 828



» Лучшие комментарии


nvc123 #101 - 2 года назад 4
NilasAran_39, читай раздел изображения
там сказано
но знай что это работает лишь с галереями (то есть 2 и более картинок)
впрочем это там тоже сказано
NilasAran_39 #102 - 2 года назад 0
nvc123:
Thanks. Не заметил
Skairus #103 - 2 года назад 2
Я понимаю, что мой трек победил в конкурсе, но это его не делает менее технически ужасным (на тот момент я не умел практически ничего). Замените пример вставки музыкального проигрывателя на что-нибудь менее отпугивающее новичков.
Это сообщение удалено
Msey #105 - 1 месяц назад 0
dg-pic.tk не актуален
ScorpioT1000 #106 - 1 месяц назад 2
txt2 не актуальна, надо менять нахрен
Fakov #107 - 1 месяц назад 0
txt2 збс, не гони
Msey #108 - 3 недели назад 0
Кстати, я знаю, что можно тексту еще оранжевый цвет задать. Почему этот тэг не добавили?
ZlaYa1000 #109 - 2 недели назад 0
Msey, давай добавим, какой код у него?
ScorpioT1000 #110 - 2 недели назад 0
Они могут поменяться с новым дизайном, кстати (но это не скоро). Поэтому не стоит злоупотреблять.