Це стара версія документу!
Зміст
Синтаксис форматування
«ДокуВікі» підтримує просту мову розмітки, що за можливістю зберігає файли даних як найбільш читабельними. Тут перераховані всі можливі синтаксичні конструкції, які можна використовувати при редагуванні статей. Просто подивіться на вихідний код цієї статті, натиснувши кнопку «Відредагувати статтю» вгорі чи внизу сторінки. Якщо хочете поекпериментувати, просто використовуйте «пісочницю». Просту розмітку також можна легко зробити за допомогою панелі інструментів.
Основні конструкції форматування
«ДокуВікі» підтримує виділення тексту жирним шрифтом, курсивом,
підкресленням та вивід тексту моноширинним шрифтом
.
Всі ці конструкції можна об'єднати
.
«ДокуВікі» підтримує виділення тексту **жирним шрифтом**, //курсивом//, __підкресленням__ та вивід тексту ''моноширинним шрифтом''. Всі ці конструкції можна **__//''об'єднати''//__**.
Також можна використовувати підрядковий та надрядковий індекси.
Також можна використовувати <sub>підрядковий</sub> та <sup>надрядковий</sup> індекси.
Ще можна закреслити текст.
Ще можна <del>закреслити текст</del>.
Абзаци відбиваються порожнім рядком. Якщо потрібно примусово вставити перенос рядка, не створюючи абзац, вставте два зворотних слеша і за ним пробіл або перехід до нового рядка.
Просто текст з розривом рядків
Зверніть увагу,
що два зворотних слеша діють тільки в кінці рядка
або якщо за ними стоїть
пробіл. Якщо його не поставити, \\вийде ось так.
Просто текст з розривом рядків\\ Зверніть увагу, що два зворотних слеша діють тільки в кінці рядка\\ або якщо за ними стоїть\\ пробіл. Якщо його не поставити, \\вийде ось так.
Примусові переноси слід використовувати тільки в разі крайньої необхідності.
Посилання
Посилання в «ДокуВікі» бувають різні і створювати їх можна теж по-різному.
Зовнішні
Зовнішні посилання розпізнаються автоматично: http://www.google.com або просто www.google.com — також можна вказувати текст посилання: Це посилання на Google. Адреси електронної пошти теж розпізнаються: andi [at] splitbrain [dot] org.
Зовнішні посилання розпізнаються автоматично: http://www.google.com або просто www.google.com --- також можна вказувати текст посилання: [[http://www.google.com|Це посилання на Google]]. Адреси електронної пошти теж розпізнаються: <andi@splitbrain.org>.
Внутрішні
Внутрішні посилання створюються за допомогою квадратних дужок. Можна або просто вказати ім'я сторінки, або додатково прописати текст посилання. Імена вікі-статей автоматично переводяться в нижній регістр, спецсимволи використовувати не можна.
Внутрішні посилання створюються за допомогою квадратних дужок. Можна або просто вказати [[pagename|ім'я сторінки]], або додатково прописати [[pagename|текст посилання]]. Імена вікі-статей автоматично переводяться в нижній регістр, спецсимволи використовувати не можна.
Можна використовувати в посиланні простір імен через двокрапку.
Можна використовувати в посиланні [[namespaces|простір імен]] через двокрапку.
Ставити посилання на певний розділ теж можна. Просто додайте через решітку (#) ім'я розділу, так само, як це робиться в HTML. Наприклад, посилання на цей розділ.
Наприклад, посилання на [[syntax#внутрішні|цей розділ]].
Примітки:
- Посилання на ті статті, що існують відображаються інакше, ніж посилання на ті, що не існують.
- Якщо змінюється назва розділу, посилання на нього не змінюється автоматично. Так що не дуже покладайтеся на посилання на розділи.
Interwiki
«ДокуВікі» підтримує інтервікі-посилання. Це короткі посилання на інші вікі. Наприклад, ось посилання на статтю Вікіпедії про вікі: Wiki.
«ДокуВікі» підтримує [[interwiki|інтервікі]]-посилання. Це короткі посилання на інші вікі. Наприклад, ось посилання на статтю Вікіпедії про вікі: [[wp>Wiki]].
Мережеві ресурси Windows
Посилання на мережеві ресурси виду \\server\share також розпізнаються. Однак врахуйте, що такі посилання мають сенс тільки в гомогенних групах користувачів, наприклад в корпоративному интранеті.
Посилання на мережеві ресурси виду \\server\share також розпізнаються.
Примітки:
- З міркувань безпеки безпосередній перегляд мережевих ресурсів працює за умовчанням тільки в Internet Explorer (і тільки в «локальній зоні»).
- У браузерах Mozilla цю можливість можна включити за допомогою опції security.checkloaduri, але робити це не рекомендується.
- Докладніше читайте тут: 151.
Картинки-посилання
Поєднавши синтаксис посилання і картинки, можна вставити в текст картинку, яка буде внутрішнім чи зовнішнім посиланням:
[[http://www.php.net/|{{wiki:dokuwiki-128.png}}]]
Врахуйте: форматування картинок — це єдина синтаксична конструкція, яку можна використовувати в тексті посилання.
Виноски
За допомогою подвійних дужок можна додати виноску1).
За допомогою подвійних дужок можна додати виноску((Виноска - примітка, посилання, переклад, що розташовується внизу сторінки.)).
Розбивка на розділи
Для структурування тексту можна використовувати до п'яти рівнів заголовків. Якщо у тексті більше трьох заголовків, автоматично створюється список змісту. Його можна відключити, вставивши в документ рядок ~~NOTOC~~.
Заголовок 3-го рівня
Заголовок 4-го рівня
Заголовок 5-го рівня
==== Заголовок 3-го рівня ==== === Заголовок 4-го рівня === == Заголовок 5-го рівня ==
Чотири і більше тире перетворюються в горизонтальну риску:
----
Картинки та інші файли
Див. також: «Робота з зображеннями та медіафайлами».
За допомогою фігурних дужок можна вставляти в текст зовнішні та внутрішні картинки. За бажанням можна вказати їх розмір.
Відмасштабована до заданої ширини:
Відмасштабована до заданих розмірів:
Відмасштабована зовнішня картинка:
Нормальний розмір: {{wiki:dokuwiki-128.png}} Відмасштабована до заданої ширини: {{wiki:dokuwiki-128.png?50}} Відмасштабована до заданих розмірів: {{wiki:dokuwiki-128.png?200x50}} Відмасштабована зовнішня картинка: {{http://de3.php.net/images/php.gif?200x50}}
Поставивши зліва чи справа пробіл, можна задати вирівнювання картинки:
{{wiki:dokuwiki-128.png }} - картинка ліворуч {{ wiki:dokuwiki-128.png}} - праворуч {{ wiki:dokuwiki-128.png }} - посередині
І, звичайно, зображенню можна задати назву (у більшості браузерів вона відображається у вигляді виринаючої підказки).
{{ wiki:dokuwiki-128.png |Логотип «ДокуВікі»}}
Якщо задати ім'я файлу (внутрішнє або зовнішнє), яке не є картинкою (gif, jpeg, png
), воно буде відображатися у вигляді посилання.
Дізнатися, як вставити картинку з посиланням можна у розділі вище.
Списки
«ДокуВікі» підтримує нумеровані і марковані списки. Щоб створити елемент списку, поставте на початку рядка два пробіли і потім зірочку (*) у разі маркованого списку, або дефіс (-) — у разі нумерованого.
- Перший елемент маркованого списку
- Другий елемент списку
- Можна зробити вкладений список
- Ще один елемент
- Той самий список, але нумерований
- Ще елемент
- Чим більше пробілів на початку, тим глибше вкладеність
- Все просто
* Перший елемент маркованого списку * Другий елемент списку * Можна зробити вкладений список * Ще один елемент - Той самий список, але нумерований - Ще елемент - Чим більше пробілів на початку, тим глибше вкладеність - Все просто
Див. також FAQ по елементам списку.
Смайлики
«ДокуВікі» переробляє найбільш вживані смайлики в їх графічні еквіваленти. Додаткові смайлики можна покласти в директорію smiley
і додати їх у файл conf/smileys.local.conf
.
Ось смайлики, які є в «ДокуВікі»:
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME
Друкарські символи
«ДокуВікі» може переробляти символи, набрані простим текстом, в їх коректні типографські еквіваленти. Розпізнаються наступні символи.
→ ← ↔ ⇒ ⇐ ⇔ » « – — '640×480' © ™ ® …
“Володимир Володимирович™ — це наше всьо © не я”
-> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r) ... "Володимир Володимирович(tm) --- це наше всьо (c) не я"
Примітка: цю конвертацію можна відключити у файлі конфігурації conf/entities.conf
.
Таблиці
«ДокуВікі» підтримує спрощений синтаксис створення таблиць.
Заголовок 1 | Заголовок 2 | Заголовок 3 |
---|---|---|
Рядок 1 Колонка 1 | Рядок 1 Колонка 2 | Рядок 1 Колонка 3 |
Рядок 2 Колонка 1 | Об'єднання колонок (зверніть увагу на подвійну вертикальну риску) | |
Рядок 3 Колонка 1 | Рядок 3 Колонка 2 | Рядок 3 Колонка 3 |
Нормальні рядки повинні починатися і закінчуватися вертикальною рисою — |, а заголовки «кришечкою» - ^.
^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | Рядок 1 Колонка 1 | Рядок 1 Колонка 2 | Рядок 1 Колонка 3 | | Рядок 2 Колонка 1 | Об'єднання колонок (зверніть увагу на подвійну вертикальну риску) || | Рядок 3 Колонка 1 | Рядок 3 Колонка 2 | Рядок 3 Колонка 3 |
Щоб об'єднати дві сусідні клітинки у рядку, просто залиште сусідню клітинку повністю порожньою, як показано вище. Слідкуйте, щоб кількість роздільників клітин була однаковою.
Вертикальні заголовки теж можна зробити:
Заголовок 1 | Заголовок 2 | |
---|---|---|
Заголовок 3 | Рядок 1 Колонка 2 | Рядок 1 Колонка 3 |
Заголовок 4 | Об'єднання нема | |
Заголовок 5 | Рядок 3 Колонка 2 | Рядок 3 Колонка 3 |
Як легко побачити, роздільник, що стоїть перед клітинкою, визначає форматування:
| ^ Заголовок 1 ^ Заголовок 2 ^ ^ Заголовок 3 | Рядок 1 Колонка 2 | Рядок 1 Колонка 3 | ^ Заголовок 4 | Об'єднання нема | | ^ Заголовок 5 | Рядок 3 Колонка 2 | Рядок 3 Колонка 3 |
Можна зробити вертикально об'єднані, поєднані до низу клітинки за допомогою додавання трьох двокрапок :::
Заголовок 1 | Заголовок 2 | Заголовок 3 |
---|---|---|
Рядок 1 Колонка 1 | ця клітинка поєднана вертикально | Рядок 1 Колонка 3 |
Рядок 2 Колонка 1 | Рядок 2 Колонка 3 | |
Рядок 3 Колонка 1 | Рядок 3 Колонка 3 |
В цих клитинках не повинно бути нічого, окрім синтаксиса об'єднання (:::
).
^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | Рядок 1 Колонка 1 | ця клітинка об'єднана вертикально | Рядок 1 Колонка 3 | | Рядок 2 Колонка 1 | ::: | Рядок 2 Колонка 3 | | Рядок 3 Колонка 1 | ::: | Рядок 3 Колонка 3 |
Текст клітинки таблиці можна вирівнювати. Просто додайте мінімум два пробіли з протилежного боку: зліва - якщо треба вирівняти вправо, праворуч - якщо треба вирівняти вліво, і по два з кожного боку - якщо по центру. Можна зробити вертикально об'єднані клітинки за допомогою додавання трьох двокрапок :::
в поєднанні вниз клітинки.
^ Таблиця з вирівнюванням ^^^ | праворуч| в центрі | | |ліворуч | праворуч| в центрі | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Примітка: вертикальне вирівнювання не підтримується.
Неформатовані блоки
Якщо вам потрібно відобразити текст точно так, як він набраний (без будь-якого форматування), обмежте область тегами <nowiki>
або навіть простіше подвійними знаками відсотків %%
.
Це деякий текст, який містить такі адреси: %%http://www.splitbrain.org%% і %%**форматування**%%, але з ним нічого не зроблено.
<nowiki> Це деякий текст, який містить такі адреси: http://www.splitbrain.org і **форматування**, але з ним нічого не зроблено. </nowiki>
Те саме стосується //__цього__ тексту// зі смайликом ;-).
Те саме стосується %%//__this__ текст// зі смайликом ;-)%%.
Кодові блоки
Ви можете включити блоки коду до своїх документів, зробивши для них відступ принаймні на два пробіли (як у попередніх прикладах) або використовуючи теги <code>
або <file>
.
Це текст із відступом у два пробіли.
Це попередньо відформатований код, усі пробіли збережено: ось <-так
Це майже те саме, але ви можете використовувати це виділення, щоб показати, що цитується вміст файлу.
Ці блоки були створені цим джерелом:
Це текст із відступом у два пробіли.
<code>Це попередньо відформатований код, усі пробіли збережено: ось <-так</code>
<file>Це майже те саме, але ви можете використовувати це виділення, щоб показати, що цитується вміст файлу. </file>
Щоб детально побачити, як створюються ці блоки, дивіться код статті.
Подсветка синтаксиса
«ДокуВики» может подсвечивать программный код, чтобы его было проще читать. Для этого используется библиотека GeSHi — соответственно подсвечиваются все языки, поддерживаемые GeSHi. Синтаксис такой же, как и в блоке code
в предыдущем разделе, но на этот раз внутри тэга добавляется название языка. Например <code java>.
/** * The HelloWorldApp class implements an application that * simply displays "Hello World!" to the standard output. */ class HelloWorldApp { public static void main(String[] args) { System.out.println("Hello World!"); //Display the string. } }
На данный момент распознаются следующие языки: 4cs;, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, ecmascript, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, z80.
Скачиваемые блоки кода
Используя тэги <code>
или <file>
, как показано выше, вы можете сделать отображаемый код доступным для загрузки. Для этого определите имя файла после кода языка вот так:
<file php myexample.php> <?php echo "hello world!"; ?> </file>
- myexample.php
<?php echo "hello world!"; ?>
Если вам не нужна подсветка, но нужен загружаемый файл, поставьте прочерк (-
) на месте кода языка: <code - myfile.foo>
.
Особенность: при написании имени файла на русском языке для формирования корректного имени файла обрамляйте название файла двойными кавычками например “Фоо Бар.php”.
- "Фоо Бар.php"
<?php echo "hello world!"; ?>
Вставка HTML та PHP
Чистий HTML- або PHP-код можна вставити у документ за допомогою тегів html
та php
:
Приклад застосування HTML:
<html> Це є <span style="color:red;font-size:150%;">HTML-код</span> </html> <html> <p style="border:2px dashed red;">Це також блок HTML</p> </html>
<html> Це є <span style=“color:red;font-size:150%;”>HTML-код</span> </html>
<html> <p style=“border:2px dashed red;”>Це також блок HTML</p> </html>
Приклад застосування PHP:
<php> echo 'Логотип, згенерований PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(generated inline HTML)'; </php> <php> echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>'; echo '</tr></table>'; </php>
<php> echo 'Логотип, згенерований PHP:'; echo '<img src=“' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '” alt=“PHP Logo !” />'; echo '(inline HTML)'; </php> <PHP> echo '<table class=“inline”><tr><td>The same, but inside a block level element:</td>'; echo '<td><img src=“' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '” alt=“PHP Logo !” /></td>'; echo '</tr></table>'; </PHP>
Зверніть увагу: З метою підвищення безпеки HTML- і PHP-блоки за замовчуванням відключені в конфігурації. Увімкніть їх, якщо хочете бачити результат виконання цього коду.
Управляющие макросы
Некоторый синтаксис влияет на то, как «ДокуВики» обрабатывает статьи без создания каких-либо результатов для себя. Доступны следующие макросы:
Макрос | Описание |
---|---|
~~NOTOC~~ | Если этот макрос присутствует в статье, оглавление не будет создано. |
~~NOCACHE~~ | «ДокуВики» помещает всё выводимое в кэш по умолчанию. Иногда это нежелательно (например, когда выше был использован синтаксис <php>), добавление этого макроса заставит «ДокуВики» обрабатывать статью при каждом вызове. |
Синтаксические плагины
Синтаксис «ДокуВики» может быть расширен за счёт плагинов. Как их устанавливать и использовать — описывается на страницах описания. Следующие плагины доступны в инсталляции «ДокуВики» на этом сайте:
- Gallery Plugin 2023-12-08 повз Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed - Repository plugin 2024-02-09 повз Andreas Gohr/Håkan Sandell
Helps organizing the plugin and template repository