Синтаксис XWiki 2.1

Загальні

Вступ

2.1 Introduction

Синтаксис XWiki 2.0 виявився досить корисним і надійним загалом; однак після його впровадження було виявлено кілька недоліків. Відповідні вдосконалення було закріплено у XWiki Syntax 2.1. Деякі нові можливості цього синтаксису:

• Гомогенізація синтаксису посилань і зображень для кращої чіткості, узгодженості та можливості розширення.
• Додано можливість відображати піктограми, вставляти зображення за допомогою схеми URI даних, створювати посилання на файли за допомогою нотації UNC і посилатися на відносні URL-адреси.

Загальні зауваження

2.0 General Remarks

Синтаксис XWiki 2.1 виправляє деякі помилки або неоднозначний синтаксис, введений користувачем, як показано в прикладах у таблиці нижче.

Інші синтаксиси

1.0 Other Syntaxes

Інші синтаксиси доступні за посиланням.

Редагування

Параграфи

2.0 Paragraphs

Параграфами є елементи тексту, розділені двома або більше новими рядками.

Заголовки

2.0 Headings

= рівень 1 =
== рівень 2 ==
=== рівень 3 ===
==== рівень 4 ====
===== рівень 5 =====
====== рівень 6 ======

Форматування тексту

2.0 Text Formatting

Горизонтальна лінія

2.0 Horizontal Line

(% style="border-color:blue" %)
----

Списки

2.0 Lists

* item 1
** item 2
*** item 3
* item 4

1. item 1
11. item 2
111. item 3
1. item 4

1. item 1
1*. item 2
1*. item 3
1. item 4

(% style="list-style-type: square" %)
* item 1
* item 2

(% style="list-style-type: disc" %)
* item 1
* item 2

(% style="list-style-type: lower-alpha" %)
* item 1
* item 2

(% style="list-style-type: upper-alpha" %)
* item 1
* item 2

(% style="list-style-type: lower-roman" %)
* item 1
* item 2

(% style="list-style-type: upper-roman" %)
* item 1
* item 2

(% style="list-style-type: lower-greek" %)
* item 1
* item 2

(% style="list-style-type: upper-greek" %)
* item 1
* item 2

(% style="list-style-type: hiragana" %)
* item 1
* item 2

(% style="list-style-type: hiragana-iroha" %)
* item 1
* item 2

(% style="list-style-type: katakana" %)
* item 1
* item 2

(% style="list-style-type: katakana-iroha" %)
* item 1
* item 2

(% style="list-style-type: armenian" %)
* item 1
* item 2

(% style="list-style-type: hebrew" %)
* item 1
* item 2

(% style="list-style-type: georgian" %)
* item 1
* item 2

(% style="list-style-type: cjk-ideographic" %)
* item 1
* item 2

Списки визначень

2.0 Definition Lists

; термін
: визначення

; термін 1
: визначення 1
:; термін 2
:: визначення 2

(% style="color:blue" %)
; термін
: визначення

Новий рядок/Розриви рядка

2.0 New Line Line Breaks

Новий рядок - це символ повернення каретки. Розрив рядка — це примусовий новий рядок, який може з’явитися будь-де в тексті.

Посилання

2.1 Links

Функція	Синтаксис XWiki 2.1	Результат
Абсолютне посилання на сторінку PageB розташованій у PageA	[[PageA.PageB]]	PageB
Відносне посилання на сторінку PageA з поточної сторінки	[[PageA]] або [[.PageA]]	PageA
Відносне посилання на сторінку PageB у PageA з поточної сторінки	[[.PageA.PageB]]	PageB
Посилання з міткою	[[label>>PageA]] Синтаксис XWiki підтримується в мітках посилань.	label
Посилання із вікі-синтаксисом у мітці	[[**bold label**>>PageA]]	bold label
Посилання на зображення	[[image:PageA@img.png>>PageA]]
Абсолютне посилання на сторінку PageB розташованій у PageA у вікі WikiA	[[WikiA:PageA.PageB]]	PageB
Посилання, яке відкривається в новому вікні	[[PageA||target="_blank"]]	PageA
Неявне посилання на URL-адресу	Це URL: https://xwiki.org	Це URL: https://xwiki.org
Явне посилання на URL-адресу	[[https://xwiki.org]]	https://xwiki.org
Явне посилання на URL-адресу з міткою	[[XWiki>>https://xwiki.org]]	XWiki
Посилання на адресу електронної пошти	[[john@smith.net>>mailto:john@smith.net]]	john@smith.net
Посилання на вкладення на поточній сторінці	[[attach:img.png]]	img.png
Посилання на вкладення на іншій сторінці	[[attach:PageA.PageB@img.png]]	img.png
Посилання на прив'язку на сторінці	[[PageA.PageB||anchor="anchor"]]	PageB
Посилання на заголовок на сторінці	[[PageA.PageB||anchor="HMyheading"]] Коли ви додаєте заголовок, створюється прив'язка з іменем "H", за якою йде заголовок із лише буквеними символами. Наприклад, для заголовка під назвою "My heading" створеним прив’язкою буде "HMyheading".	PageB
Посилання на прив’язку поточної сторінки	[[label>>||anchor="anchor"]]	label
Посилання на сторінку з рядком запиту	[[PageA.PageB||queryString="param1=value1&param2=value2"]]	PageB
Посилання на поточну сторінку з рядком запиту	[[label>>||queryString="param1=value1&param2=value2"]]	label

Специфікація посилання синтаксис XWiki 2.1

Повний формат посилання – це [label>>] (resource) [||parameters]

• label: Необов'язковий рядок, який відображатиметься користувачеві як ім'я посилання під час відтворення. Мітка може містити синтаксис XWiki. Якщо не вказано жодної мітки, буде згенеровано мітку за умовчанням. Шаблон генерації можна змінити, детальніше Admin Guide. Наприклад: My Page
• resource: Обов'язковий рядок із посиланням на посилання в одній із наведених нижче форм
  • URL: Будь-яка URL-адреса у формі [url:](protocol://path). Examples: http://xwiki.org, url:https://svn.xwiki.org/
    • url: Необов'язковий рядок, що ідентифікує ресурс як URL-адресу.
    • protocol://path: Сама URL-адреса
  • Wiki page: Посилання у формі page:[(wikiName):](pageNameList). Наприклад: page:Page, page:myxwiki:Page, page:ParentPage.ChildPage.SubChildPage, page:../SiblingPage, page:./ChildPage
    • page: Обов'язковий рядок, що визначає ресурс як сторінку XWiki. Те саме посилання можна використовувати як для термінальної, так і для нетермінальної сторінки, якщо обидві існують, це буде вказувати до нетермінальної сторінки.
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання вказуватиме на сторінку всередині цієї вікі. Якщо вікі не вказано, використовується поточна вікі. Наприклад: mywiki
    • pageNameList: Обов'язковий список імен вікі-сторінок, відокремлених косою рискою, що вказує на синтаксис остаточної пов’язаної вікі-сторінки. Також можна використовувати . і .. для позначення поточної або батьківської сторінки/вікі. Наприклад: Main, A/B, A/B/C, ../Sibling, ./Child
  • Wiki document: Посилання у формі [doc:][[(wikiName):](spaceNameList).](documentName). Наприклад: doc:Welcome, doc:Main.Welcome, doc:mywiki:Main.Welcome, Welcome
    • doc: Необов'язковий рядок, що ідентифікує ресурс як сторінку терміналу XWiki. Нетермінальна сторінка також може мати посилання таким чином, але вона повинна додати до власної назви .WebHome part (e.g. doc:Sandbox.WebHome).
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання вказуватиме на сторінку всередині цієї вікі. Якщо вікі не вказано, використовується поточна вікі. Наприклад: mywiki.
    • spaceNameList: Необов'язковий список назв вікі-просторів, відокремлених крапками. Якщо простір не вказано, використовується поточний простір. Наприклад: Main, A.B, A.B.C
    • documentName: Обов'язковий рядок, що містить назву зв'язаної вікі-сторінки. Наприклад: Welcome
  • Wiki space: Посилання у формі space:[(wikiName):](spaceNameList). Наприклад: space:Main, space:mywiki:Main, space:A.B.C
    • space: Обов'язковий рядок, що ідентифікує ресурс як нетермінальну сторінку XWiki (тобто простір).
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання вказуватиме на сторінку всередині цієї вікі. Якщо вікі не вказано, використовується поточна вікі. Наприклад: mywiki
    • spaceNameList: Обов'язковий список назв вікі-просторів, відокремлених крапками, які вказують на остаточний зв’язаний вікі-простір (або нетермінальну сторінку). Наприклад: Main, A.B, A.B.C
  • InterWiki page: Посилання у формі interwiki:[(interWikiAlias):](pageName). Наприклад: interwiki:wikipedia:XWiki
    • interwiki: Обов'язковий рядок, що ідентифікує ресурс як посилання InterWiki.
    • interWikiAlias: Необов'язковий Inter Wiki псевдонім, що визначено на карті InterWiki (Детальніше Admin Guide). Наприклад: wikipedia
    • pageName: Обов'язковий рядок, що містить назву сторінки, яке містить посилання. Наприклад: XWiki
  • Attachment: Посилання у формі attach:{{{(wikiName):}(spaceNameList).}(pageName)@}(imageName)
    • attach: Обов'язковий рядок, який ідентифікує посилання як вкладення документа XWiki.
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання вказуватиме на сторінку всередині цієї вікі. Якщо вікі не вказано, використовується поточна вікі. Наприклад: mywiki.
    • spaceNameList: Необов'язковий список назв вікі-просторів, відокремлених крапками. Якщо простір не вказано, використовується поточний простір. Наприклад: Main, A.B, A.B.C
    • pageName: Необов'язковий рядок, що містить назву вікі-сторінки, до якої приєднано зображення, на яке посилається. Наприклад: Welcome
    • attachmentName: Назва вкладення, те як воно зберігається у вікі. Наприклад: photo.png
  • Page Attachment: Посилання у формі pageAttach:{{{(wikiName):}(pageNameList)/}(imageName)
    • pageAttach: Обов'язковий рядок, що визначає посилання як вкладення сторінки XWiki.
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання вказуватиме на сторінку всередині цієї вікі. Якщо вікі не вказано, використовується поточна вікі. Наприклад: mywiki.
    • pageNameList: Необов'язковий список назв вікі-сторінок, відокремлених косою рискою. Якщо сторінка не вказана, використовується поточна сторінка. Наприклад: Main, A/B, A/B/C
    • attachmentName: Name of the attachment as it is stored in the wiki. Example: photo.png
  • Email address: Посилання у формі mailto:(emailAddress) (#anchor is not valid). Наприклад: mailto:john@smith.com
    • mailto: Обов'язковий рядок, що ідентифікує ресурс як електронну пошту.
    • emailAddress: Цільова адреса електронної пошти. Наприклад: john@smith.com
  • Relative path: Посилання на сервер у формі path:(relPath). Наприклад: path:$doc.getURL('reset') створює цільову адресу http://server.domain.com/xwiki/bin/reset/Space/Page where /xwiki/bin/reset/Space/Page створено $doc.getURL('reset').
    • path: Обов'язковий рядок, що визначає ресурс як відносний шлях.
    • relPath: Обов'язковий рядок, що містить відносний шлях до ресурсу на сервері, який має бути зв'язаний.
  • UNC (Windows Explorer): Посилання у формі unc:(path). Посилання представлено як a file:// link. Наприклад: unc:C:Windows, unc:~myserverpathimg.png, unc:home/user/somefile
    • unc: Обов'язковий рядок, що визначає ресурс як шлях UNC (Провідник Windows).
    • path: Обов'язковий рядок, що містить локальний шлях ресурсу, до якого має доступ користувач. Наприклад: C:Windows, ~myserverpathimg.png, home/user/somefile
  • Untyped: Якщо жоден із зазначених вище типів ресурсів не вказано (тобто в посиланні не вказано префікс ресурсу type:), тоді посилання розглядатиметься як посилання на термінальну або нетермінальну сторінку XWiki за допомогою наступного алгоритму:
    • Terminal page у поточному просторі, only якщо існує. Наприклад: [[A]] розв'язано до еквівалента [[doc:currentSpace.A]]
    • Non-terminal page у поточному просторі. Наприклад: [[A]] розв'язано до еквівалента [[space:currentSpace.A]], що є еквівалентом [[doc:currentSpace.A.WebHome]]
    • Якщо поточна сторінка є нетермінальною і 2 попередні перевірки вище не знайшли наявної сторінки, виконуються 2 додаткові перевірки:
      • Terminal page як дочірня у батьківському просторі, only якщо існує. Наприклад: [[B]] посилання всередині нетермінальної сторінки A.C розв'язано до еквівалента [[doc:A.B]]
      • Non-terminal page як дочірня у батьківському просторі, незважаючи на те, існує той чи ні. Наприклад: [[B]] посилання всередині нетермінальної сторінки A.C розв'язано до еквівалента [[space:A.B]], що є еквівалентом [[doc:A.B.WebHome]]
    • Note1 - Absolute links: Якщо нетипове посилання містить 2 або більше компонентів, розділених крапками (тобто такі, що виглядають як назва простору та ім'я сторінки), наведений вище алгоритм визначить сторінку відносно поточної вікі, а не поточного простору. Наприклад: [[A.B]] може бути вирішено будь-яким [[doc:currentWiki:A.B]] (якщо існує) або [[space:currentWiki:A.B]] (є еквівалентом [[doc:currentWiki:A.B.WebHome]]) та ні [[doc:currentWiki:currentSpace.A.B]] або [[doc:currentWiki:currentSpace.A.B.WebHome]].
    • Note2 - Special handling of .WebHome: Якщо невизначене посилання закінчується на .WebHome, буде завжди розглядатись як термінальна сторінка. Наприклад: [[A.WebHome]] завжди буде розв'язано до еквівалента [[doc:A.WebHome]] та ні [[doc:A.WebHome.WebHome]].
• parameters: Необов'язковий список параметрів, відокремлених пробілами, переданих до посилання. Наприклад: queryString="mydata1=5&mydata2=Hello" anchor="HTableOfContents" target="_blank"
  • queryString: Необов'язковий рядок запиту для визначення параметрів, які будуть додані до цільової адреси посилання та використані у відтвореній URL-адресі. Наприклад: url:http://domain.com/path||queryString="mydata1=5&mydata2=Hello" створює цільову адресу http://domain.com/path?mydata1=5&mydata2=Hello
  • anchor: Необов'язкове ім'я прив'язки, що вказує на прив'язку, визначену в посиланні. Зверніть увагу, що в XWiki прив'язки створюються автоматично для заголовків і зображень. Наприклад: url:http://domain.com/path||anchor="HTableOfContents" produces target address http://domain.com/path#HTableOfContents
  • target: Необов'язковий параметр, який дозволяє відкрити цільове посилання в новому вікні. Наприклад: target="_blank"

Таблиці

2.0 Tables

Дозволяє легко створювати вміст у форматі таблиці. Параметри для таблиці, рядка чи комірки також підтримуються в XWiki Syntax 2.1.

|=Заголовок 1|=Заголовок 2
|Слово 1|Слово 2

!=Заголовок 1!=Заголовок 2
!!Слово 1!!Слово 2

(% style="background-color:red;text-align:center" %)
|=Заголовок 1|=(% style="background-color:yellow" %)Заголовок 2
|Слово 1|Слово 2

{{velocity}}
$xwiki.ssfx.use("js/xwiki/table/table.css")
$xwiki.jsfx.use("js/xwiki/table/tablefilterNsort.js", true)
{{/velocity}}

(% class="grid sortable filterable doOddEven" id="tableid" %)
(% class="sortHeader" %)|=Заголовок 1|=Заголовок 2
|Комірка 11|Комірка 12
|Комірка 21|Комірка 22

Зображення

2.1 Images

Функція	Синтаксис XWiki 2.1	Результат
Зображення з вкладення поточної сторінки	image:img.png
Зображення з вкладення іншої сторінки	image:PageA.PageB@img.png
Зображення з параметрами	[[image:img.png||width="25" height="25"]]
Зображення з підписом	[[~[~[XWiki~>~>https://www.xwiki.org~]~] підтримує підписи.>>image:img.png]]
Зображення, розташовані за URL	image:https://some/url/img.png
Prepackaged Icons	image:icon:accept

Специфікація зображення синтасксис XWiki 2.1

The full format of an image is either image: (reference) or [[{caption>>}image: (reference) {||parameters}]]

• caption: Необов'язковий підпис. Може містити довільний синтаксис XWiki 2.1, але синтаксис вкладеного посилання має бути екранований за допомогою ~. Підпис підтримується, лише якщо синтаксис зображення є єдиним вмістом абзацу. Зображення з підписом також можна загорнути в посилання. У цьому випадку посилання міститиме зображення, але не підпис.
• image: Обов'язковий рядок, що визначає ресурс як зображення.
• reference: Посилання на зображення, яке має відображатися в одній із таких форм:
  • URL: Будь-яка URL-адреса зображення у вигляді [url:](protocol://path/imageName). Наприклад: http://domain.org/path/img.png
    • url: Необов'язковий рядок, що визначає зображення як URL-адресу.
    • protocol://path/imageName: URL-адреса зображення
  • Attachment: Посилання у формі [attach:]{{{(wikiName):}(spaceNameList).}(pageName)@}(imageName)
    • attach: Необов'язковий рядок, що ідентифікує посилання як вкладення документа XWiki.
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання на зображення вказуватиме на зображення, прикріплене до сторінки цієї вікі. Якщо не вказано жодної вікі, використовується поточна вікі. Наприклад: mywiki.
    • spaceNameList: Необов'язковий список назв вікі-просторів, відокремлених крапками. Якщо не вказано простір, використовується поточний простір. Приклади Main, A.B, A.B.C
    • pageName: Необов'язковий рядок, що містить назву вікі-сторінки, до якої приєднано зображення, на яке посилається. Наприклад: Welcome
    • imageName: Обов'язковий рядок, що містить назву зображення, доданого до сторінки, оскільки воно зберігається у вікі. Наприклад: myImage.png
  • Page Attachment: Посилання у формі pageAttach:{{{(wikiName):}(pageNameList)/}(imageName)
    • pageAttach: Обов'язковий рядок, що визначає посилання як вкладення сторінки XWiki.
    • wikiName: Необов'язковий рядок, що містить назву вікі. Посилання на зображення вказуватиме на зображення, прикріплене до сторінки цієї вікі. Якщо не вказано жодної вікі, використовується поточна вікі. Наприклад: mywiki.
    • pageNameList: Необов'язковий список назв вікі-сторінок, відокремлених крапками. Якщо не вказано жодної сторінки, використовується поточна сторінка. Приклади: Main, A/B, A/B/C
    • imageName: Обов'язковий рядок, що містить назву зображення, доданого до сторінки, оскільки воно зберігається у вікі. Наприклад: myImage.png
  • Icon: Посилання у формі icon:(iconName). Наприклад: icon:accept
    • icon: Обов'язковий рядок, що ідентифікує посилання на зображення як піктограму із XWiki Icon Set.
    • iconName: Обов'язковий рядок, що ідентифікує піктограму, на який посилається. Наприклад: accept
  • Data URI: Посилання у формі (data:)(content). Наприклад: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
    • data: Обов'язковий рядок, який ідентифікує зображення як таке, що вказано всередині за допомогою Data URI scheme.
    • content: Закодоване зображення. Наприклад: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
• parameters: Необов'язковий список параметрів, відокремлених пробілами, які передаються до зображення. приклад: width="800" height="600" alt="img.png" title="My nice image"
  • HTML attributes: Усі атрибути, визначені стандартом HTML, будуть додані до візуалізованого HTML <img> тегу.
    • style: Інформація про стиль CSS, який потрібно застосувати до зображення. Приклади: style="float:right;height:50" (image on right side, height 50 px), style="display:block;margin-left:auto;margin-right:auto;width:80%" (зображення по центру, ширина становить 80% ширини блоку), style="vertical-align:bottom" (текст починається в нижній частині зображення)
    • height: Параметр, який визначає висоту відображуваного зображення. Значення має бути подано або в пікселях (приклад: height="80"), або в пікселях, пов'язаних із висотою блоку, що містить зображення (приклад: height="40%").
    • width: Параметр, який визначає ширину відображеного зображення. Значення має бути подано або в пікселях (приклад: width="80"), або в пікселях, пов'язаних із шириною блоку, що містить зображення (приклад: width="40%").
    • title: Параметр, який визначає назву відображеного зображення, яке буде видно, наприклад, якщо навести на нього кнопку миші. Наприклад: title="My nice image"
    • alt: Параметр, який визначає, який текст має відображатися, якщо браузер не може відобразити зображення. Оскільки це обов'язковий HTML-атрибут, XWiki використовуватиме замість нього ім'я файлу, якщо параметр alt не визначено. Наприклад: alt="img.png"
    • More: Детальніше пояснення HTML <img> тегів, що містять більше атрибутів, можна переглянути HTML standard.
  • queryString: Дозволяє надсилати запити на сервер під час створення посилання для завантаження зображення, на яке посилається. Наприклад: queryString="width=100&height=800&keepAspectRatio=true" (keepAspectRatio=true зазнає невдачі, якщо width та height параметри вказуються додатково до queryString!)

Розширені

Verbatim

2.0 Verbatim

Дозволяє вводити вміст, який не буде відформатовано (іншими словами, синтаксис XWiki не буде враховано).

{{{
багаторядковий
*verbatim*
вміст
}}}

багаторядковий
*verbatim*
вміст

Цитати

2.0 Quotations

Дозволяє процитувати деякий текст.

> це сказав Джон
Я сказав добре

> це сказав Джон
>> Марі відповіла на це
Я сказав добре

Групи

2.0 Groups

Групи можна використовувати, щоб вставити інший документ у рядок безпосередньо в поточний. Це дозволяє, наприклад, вставляти складні елементи або стилі всередину елемента списку, клітинки таблиці чи абзацу. Групи розділені такими синтаксичними елементами: (((...))). Одна група може містити іншу групу, і немає жодних обмежень на вкладеність.

|=Заголовок 1|=Заголовок 2|=Заголовок 3
|Комірка 1|(((
= Вбудований документ =

Деякі вбудовані параграфи.

* пункт списку перший
* пункт списку другий
   ** підпункт 1
   ** підпункт 2
))) | Комірка 3

Наступний параграф у документі верхнього рівня

(% class="myClass" style="color:blue" %)(((сині параграфи

всередині myClass)))

Екранування

2.0 Escapes

Дозволяє екранувати синтаксис XWiki.

Параметри

2.0 Parameters

За допомогою XWiki Syntax 2.1 можна передавати параметри до різних елементів синтаксису, а також до блоків тексту. Це використовується, наприклад, для їх стилізації. Ви можете встановити будь-яку пару параметрів ключ/значення. Засіб візуалізації XHTML передаватиме ці параметри як атрибути XHTML базовому представленню XHTML різних елементів синтаксису.

(% class="myClass" style="myStyle" id="myId" %)
= заголовок =

<h1 class="myClass" style="myStyle" id="myId">заголовок</h1>

Програмування

Макроси

2.0 Macros

У синтаксисі XWiki є лише один тип макросу 2.1, який викликається за допомогою синтаксису: {{macroname param1="value1" ... paramN=" valueN"}}...{{/macroname}}. Для макросів без вмісту є коротке позначення: {{macroname param1="value1" ... paramN="valueN"/}}

{{code language="java"}}
System.out.println("Hello World!");
{{/code}}

Макроси в цій вікі

HTML

2.0 HTML

Скрипти

2.0 Scripts

{{groovy}}
def var = "whatever"
{{/groovy}}