Посібник із синтаксису XWiki

Остання зміна 2024/05/06 14:59 автором Ashterix

Синтаксис XWiki 2.1: Посилання

ФункціяСинтаксис 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]]img.png
Абсолютне посилання на сторінку 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"