WikiFormatting

Wiki форматирование

En-Version: WikiFormatting

Wiki разметка - главная фишка в Trac, полностью охватывающая все другие части Trac, делая его гибким и мощным.

Trac имеет встроенный небольшой и мощный wiki транслятор-движок. Этот wiki-движок включает подмножество комманд, некогда выросшее из других популярных wiki, особенно MoinMoin.

Эта страница демонстрирует синтаксис форматирования, разрешенного во всех wiki редактируемых текстах проекта.

Стили шрифта

Trac wiki поддерживает следующие стили:

 * '''bold''', '''!''' can be bold too''', и '''! '''
 * ''italic''
 * '''''bold italic'''''
 * __underline__
 * {{{monospace}}} or `monospace`
 * ~~strike-through~~
 * ^superscript^ 
 * ,,subscript,,

Отображается:

• bold, ''' can be bold too, and !
• italic
• bold italic
• underline
• monospace or monospace
• strike-through
• ^superscript
• _subscript

Примечание:

• {{{...}}} и `...` команды не только "выбрать моноширинный шрифт", но также рассматривает их текст дословно, то есть не применяет к нему wiki обработку
• ! сообщает wiki парсеру, чтобы к следующим символам не применялся wiki формат, так что обращайте внимание на пробел после !, например, когда завершается bold (жирный).

Заголовки

вы можете создавать заголовки строкой из от одного до пяти символов равно ("="), следующим за ним одиночным пробелом и текстом заголовка. Строка должна заканчиваться пробелом и тем же числом символов =. Заголовок может дополнительно следовать за явным порядковым номером (id). Если нет, подразумевается, тем не менее, что не менее удобочитаемо, если id сгенерирован The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.

Пример:

= Heading =
== Subheading ==
=== About ''this'' ===
=== Explicit id === #using-explicit-id-in-heading

Отображается:

Heading

Subheading

About this

Explicit id

Параграф (абзац)

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

Line 1[[BR]]Line 2

Отображается:

Line 1
Line 2

Списки

Wiki поддерживает нумерованные и ненумерованные списки.

Пример:

 * Item 1
   * Item 1.1
      * Item 1.1.1   
      * Item 1.1.2
      * Item 1.1.3
   * Item 1.2
 * Item 2

 1. Item 1
   a. Item 1.a
   a. Item 1.b
      i. Item 1.b.i
      i. Item 1.b.ii
 1. Item 2
И нумерованным спискам также можно задать явное число:
 3. Item 3

Отображается:

• Item 1
  • Item 1.1
    • Item 1.1.1
    • Item 1.1.2
    • Item 1.1.3
  • Item 1.2
• Item 2

1. Item 1
   1. Item 1.a
   2. Item 1.b
      1. Item 1.b.i
      2. Item 1.b.ii
2. Item 2

И нумерованным спискам также можно задать явное число:

3. Item 3

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

Список определений

Wiki поддерживает списки определений.

Пример:

 llama::
   some kind of mammal, with hair
 ppython::
   some kind of reptile, without hair
   (can you spot the typo?)

Отображается:

llama

some kind of mammal, with hair

ppython

some kind of reptile, without hair (can you spot the typo?)

Заметьте, что нужен пробел впереди определения термина.

Предварительно форматированный текст

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

Пример:

 {{{
  def HelloWorld():
      print "Hello World"
 }}}

Отображается:

 def HelloWorld():
     print "Hello World"

Цитаты

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

Пример:

  This text is a quote from someone else.

Отображается:

This text is a quote from someone else.

Цитаты обсуждений

Чтобы описать отсылку к ветке обсуждения, как например область комментариев тикета, используйте метки цитаты "как-в-e-mail" (">", ">>", и т.п.)

Пример:

>> Someone's original text
> Someone else's reply text
My reply text

Отображается:

Someone's original text

Someone else's reply text

My reply text

Примечание: Некоторые wiki форматированные? элементы, как например списки и преформатированный текст, уже могут содержать блоки цитат. Дополнительное переформатирование может помочь создать корректную цитату.

Таблицы

Простые таблицы создаются так:

||Cell 1||Cell 2||Cell 3||
||Cell 4||Cell 5||Cell 6||

Отображается:

Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6

Заметьте, что более сложные таблицы могут быть созданы с использованием reStructuredText.

Ссылки

Гиперссылки уже автоматически создаются для WikiPageNames и URLs. WikiPageLinks может быть отключена, если добавить перед ней метку "!" как !WikiPageLink.

Пример:

 TitleIndex, http://www.edgewall.com/, !NotAlink

Отображается:

TitleIndex, http://www.edgewall.com/, NotAlink

Ссылке может быть задано более вразумительное описание, главное, чтобы ссылка отделялась от описания пробелом и все это было собрано в квадратные скобки. Если описательное название опущено, то явный префикс может быть пропущен, если ссылка ведет не на внешний ресурс. Это может быть полезным для имен wiki статей, не поддерживающих WikiPageNames соглашение.

Пример:

 * [http://www.edgewall.com/ Edgewall Software]
 * [wiki:TitleIndex Title Index]
 * [wiki:ISO9000]

Отображается:

• Edgewall Software
• Title Index
• ISO9000?

Trac ссылки

Wiki статьи могут ссылаться непосредственно на другие части проекта Trac. Статьи могут быть связаны с тикетами, отчетами, чейнджсетами, вехами, исходными файлами и другими wiki страницами, используюя следующую нотацию:

 * Tickets: #1 or ticket:1
 * Reports: {1} or report:1
 * Changesets: r1, [1] or changeset:1
 * ...

Отображается:

• Tickets: #1 or ticket:1
• Reports: {1} or report:1
• Changesets: r1, [1] or changeset:1
• ...

Есть еще много различных способов задания Trac ссылок, смотри TracLinksRu для дополнительной информации.

Обход TracLinks или WikiPageNames

Вы можете избежать создания гиперссылки или Trac ссылки, поставив перед выражением единственный знак "!" (восклицательный знак).

Пример:

 !NoHyperLink
 !#42 is not a link

Отображается:

NoHyperLink #42 is not a link

Изображения

URLы, оканчивающиеся на .png, .gif or .jpg автоматически интерпретируются как ссылки на изображения, и конвертируются в <img> тег.

Теперь вы должны использовать [[Image]] макрос. Это самый простой путь вставить картинку чтобы выложить ее как аттачмент к текущей странице и прописать имя файла, например, вызов макроса [[Image(picture.gif)]]. Дополнительно к текущей странице можно ссылаться на другие ресурсы:

• [[Image(wiki:WikiFormatting:picture.gif)]] (referring to attachment on another page)
• [[Image(ticket:1:picture.gif)]] (file attached to a ticket)
• [[Image(htdocs:picture.gif)]] (referring to a file inside project htdocs)
• [[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]] (a file in repository)

Пример отображения:

Смотри в WikiMacros развернутую документацию по макросу [[Image()]].

Макросы

Макросы — специальные функции для вставки динамического содержимого на страницу.

Пример:

 [[RecentChanges(Trac,3)]]

Отображается:

01/07/2009

• TracWorkflow (diff)

01/03/2009

• TracModWSGI (diff)
• TracModPython (diff)

Смотри еще информацию в WikiMacros, и список установленных макросов.

Процессоры

Trac поддерживает альтернативные форматы разметки, используемой Wiki процессором. Например, процессор использует для вывода страницы reStructuredText или HTML.

Пример 1:

{{{
#!html
<h1 style="text-align: right; color: blue">HTML Test</h1>
}}}

Отображается:

HTML Test

Пример:

{{{
#!python
class Test:

    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()
}}}

Отображается:

class Test:
    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()

Perl:

my ($test) = 0;
if ($test > 0) {
    print "hello";
}

Смотри в WikiProcessors более полную информацию.

Комментарии

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

{{{
#!comment
Your comment here
}}}

Прочее

Четыре или более дефиса будут заменены на горизонтальную линию (<HR>).

Пример:

 ----

Отображается:

---

---

Смотри также: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.