Справка по форматированию текста - iSimpleLab JIRA

Заголовки

Чтобы создать заголовок - начните строку с "hn. " (где n - цифра от 1 до 6)

Запись	Комментарий
`h1. Наибольший заголовок`	Наибольший заголовок
`h2. Больший заголовок`	Больший заголовок
`h3. Большой заголовок`	Большой заголовок
`h4. Нормальный заголовок`	Нормальный заголовок
`h5. Маленький заголовок`	Маленький заголовок
`h6. Наименьший заголовок`	Наименьший заголовок

Текстовые эффекты

Текстовые эффекты используются для изменения форматирования слов и предложений.

Запись	Комментарий
`жирный`	Делает текст жирным.
`_выделенный_`	Делает текст выделенным..
`??цитирование??`	Делает текст в виде цитаты.
`-удаленный-`	Делает текст ~~удаленным~~.
`+вставленный+`	MДелает текст вставленным.
`^верхний индекс^`	Делает текст ^{верхним индексом}.
`~нижний индекс~`	Делает текст _{нижним индексом}.
`{{моноширинный}}`	Делает текст `моноширинным`.
`bq. Некоторый цитированный блок текста`	Чтобы сделать весь параграф цитированным - поместите "bq. " перед ним. Пример: Некоторый цитированный блок текста
`{quote} Здесь находится подходящее для цитирования содержание {quote}`	Цитировать блок текста, длиннее одного абзаца. Пример: Здесь находится подходящее для цитирования содержание
`{color:red} Смотри, ма - красный текст! {color}`	Изменяет цвет блока текста. Пример: Смотри, ма - красный текст!

Текстовые разрывы

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

Запись	Комментарий
`(чистая строка)`	Создает новый абзац
`\\`	Переносит текст на следующую строку. Редко нужно - в большинстве случаев Вики-рендерер сможет сам правильно переносить текст на новую строку.
`----`	Создает горизонтальную направляющую линию.
`---`	Создает — символ длинного тире.
`--`	Создает – символ короткого тире.

Ссылки

Важно узнать, как быстро создавать ссылки.

Запись	Комментарий
`[#anchor] [^attachment.ext]`	Создает внутреннюю ссылку на заданную метку, или вложение. Использование знака '#', за которым следует имя метки, ведет к заданной закладке на желаемой странице. Наличие '^', за которым следует имя вложения ведет к вложению в текущем запросе.
`[http://jira.atlassian.com] [Atlassian\|http://atlassian.com]`	Создает ссылку на внешний источник. Спецсимволы, которые следуют после URL и не являются его частью должны быть отделены пробелом. Внешние ссылки обозначены иконкой со стрелочкой. Скобки [] вокруг внешних ссылок ставятся по усмотрению, если вы не хотите использовать никакие псевдонимы для ссылок. Примеры: http://jira.atlassian.com Atlassian
`[mailto:legendaryservice@atlassian.com]`	Создает ссылку на почтовый адрес. Пример: legendaryservice@atlassian.com
`[file:///c:/temp/foo.txt] [file:///z:/file/on/network/share.txt]`	Создает ссылку на скачивание файла на ваш компьютер или в сетевую папку, которую вы выбрали на диске. Чтобы получить доступ к файлу, нажмите правую кнопку на ссылке и выберите "Сохранить Как". По умолчанию, это работает только в Internet Explorer, но также может быть задействовано в Firefox (Смотрите документацию).
`{anchor:anchorname}`	Создает метку на странице. В последствии вы можете создавать ссылки прямо на эту метку. Таким образом, ссылка [My Page#here] будет ссылаться в любое место на страницу "My Page", где есть макрос {anchor:here}, и ссылка [#there] будет ссылаться в любое место на текущей странице, где есть макрос {anchor:there}.
`[~username]`	Создает ссылку на страницу профиля отдельного пользователя, с иконкой юзера и его полным именем.

Списки

Списки позволяют вам представлять информацию в виде серии упорядоченных элементов.

Запись	Комментарий
`* некоторые * булит с отступом буллиты * точки`	Список с буллитами (должен быть в первом столбце). Используйте больше (**) для увеличения глубины списка. Пример: некоторые булит с отступом буллиты точки
`- другой - булит - типы`	Элементы списка (с -), несколько строк образуют единственный список. Пример: другой булит типы
`# a # нумерованный # список`	Нумерованный список (должен быть в первом столбце). Используйте больше (##, ###) для увеличения глубины списка. Пример: a нумерованный список
`# a # нумерованный #* с #* вложенные #* булит # список` `* a * с буллитами # с # вложенные # нумерованный список`	Вы также можете создавать любые смешанные вложенные списки. Пример: a нумерованный с вложенные булит список Пример: a с буллитами с вложенные нумерованный список

Изображения

Изображения можно вставлять в Вики-поле из вложенных файлов или удаленных источников.

Запись Комментарий

!http://www.host.com/image.gif!
или
!attached-image.gif!

Вставляет изображение на страницу.

Если подходящий URL указан для изображения - оно будет отображаться с удаленного источника, иначе будет отображаться приложенный файл с картинкой.

!image.jpg|thumbnail!

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

!image.gif|align=right, vspace=4!

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

Вложения

Некоторые вложения особого типа могут быть вставлены в визуальное Вики-поле из приложенного файла.

Запись Комментарий

!quicktime.mov!
!spaceKey:pageTitle^attachment.mov!
!quicktime.mov|width=300,height=400!
!media.wmv|id=media!

Вставка объекта на страницу, вставляя свойства разделенные запятыми.

Форматы, поддерживаемые по умолчанию.:

Flash (.swf)
Quicktime клипы (.mov)
Windows Media (.wma, .wmv)
Real Media (.rm, .ram)
MP3 файлы (.mp3)

Прочие типы файлов могут быть использованы, но могут потребовать указание свойств "classid", "codebase" и "pluginspage", чтобы быть распознанными веб-браузерами.

Обычные свойства:

ширина - ширина медиа-файла
высота - высота медиа-файла
id - ID присвоенный вставленному объекту

Благодаря запросам безопасности файлы, расположенные на удаленных серверах не поддерживают Стилизацию
По умолчанию, каждый вставляемый объект обернут тегом "div". Если вы хотите стилизировать div и его содержимое - перепишите содержимое CSS-класса "embeddedObject". Указание ID в качестве свойства также позволяет вам стилизировать разные вставленные объекты. Используются имена CSS-классов в формате "embeddedObject-ID".

Таблицы

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

Запись Комментарий

||заголовок 1||заголовок 2||заголовок 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|

Создает таблицу. Используйте double bars для заголовочных строк таблицы.

Код, заданный здесь, создает таблицу которая выглядит как:

заголовок 1	заголовок 2	заголовок 3
col A1	col A2	col A3
col B1	col B2	col B3

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

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

Запись Комментарий

{noformat}
предварительно отформатированный кусок текста
 таким образом, дальнейшее _форматирование_ здесь *не* производится
{noformat}

Делает предварительно отформатированный блок текста без синтаксической подсветки. Все опциональные параметры макроса {panel} также действительны для {noformat}.

без панели: Окружает блок текста полностью настраиваемой панелью. Опциональные параметры, которые вы можете задать:

Пример:

предварительно отформатированный кусок текста таким образом, дальнейшее _форматирование_ здесь *не* производится

{panel}
Некий текст
{panel}

{panel:title=Мой заголовок}
Некий текст с заголовком
{panel}

{panel:title=Мой заголовок|borderStyle=dashed|borderColor=#ccc|titleBGColor=#F7D6C1|bgColor=#FFFFCE}
блок текста, окруженный *панелью*
еще _другая_ линия
{panel}

Окружает блок текста полностью настраиваемой панелью. Опциональные параметры, которые вы можете задать:

title: Заголовок панели
borderStyle: Стиль границы, которая используется в панели (сплошная, пунктирная и любая другая CSS-valid)
borderColor: Цвет границы, которая используется в панели
borderWidth: ширина границы, которая используется в панели
bgColor: Цвет фона этой панели
titleBGColor: Цвет фона заглавной секции этой панели

Пример:

Мой заголовок

блок текста, окруженный панелью
еще другая линия

{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
    return foo;
}
{code}

{code:xml}
    <test>
        <another tag="attribute"/>
    </test>
{code}

Делает предварительно отформатированный блок текста с подсветкой синтаксиса. Все опциональные параметры макроса {panel} также действительны для {code}. Язык по умолчанию - Java, но вы такуже можете выбрать другие, включая ActionScript, Ada, AppleScript, bash, C, C#, C++, CSS, Erlang, Go, Groovy, Haskell, HTML, JavaScript, JSON, Lua, Nyan, Objc, Perl, PHP, Python, R, Ruby, Scala, SQL, Swift, VisualBasic, XML и YAML.

Пример:

Bar.java

// Some comments here
public String getFoo()
{
    return foo;
}

<test>
    <another tag="attribute"/>
</test>

Разное

Различные другие возможности синтаксической подсветки.

Запись Комментарий

\X

Экранирование спецсимвола X (например, {)

:)

:(

etc

Графические эмотиконы (смайлы).

Notation	:)	:(	:P	:D	;)	(y)	(n)	(i)	(/)	(x)	(!)
Image

Запись	(+)	(-)	(?)	(on)	(off)	(*)	(*r)	(*g)	(*b)	(*y)	(flag)
Изображение

Запись	(flagoff)
Изображение

Заголовки

Наибольший заголовок

Больший заголовок

Большой заголовок

Нормальный заголовок

Маленький заголовок

Наименьший заголовок

Текстовые эффекты

Текстовые разрывы

Ссылки

Списки

Изображения

Вложения

Таблицы

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

Разное