Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Последняя версия Следующая версия справа и слева | ||
страница_документации [28.10.2016 21:02] admin [Пространства имен (namespace, неймспейс)] |
страница_документации [08.11.2016 14:40] admin |
||
---|---|---|---|
Строка 31: | Строка 31: | ||
===== Страницы, идентификаторы, ссылки, создание страниц ===== | ===== Страницы, идентификаторы, ссылки, создание страниц ===== | ||
- | Каждая страница имеет свой уникальный идентификатор. Идентификатор страницы может содержать маленькие русские или английские буквы, цифры и знак "_". Еще в идентификаторе может быть двоеточие, см. ниже. Идентификатор страницы отображается вверху страницы в квадратных скобках (у этой страницы идентификатор "страница_документации"). | + | Каждая страница имеет свой уникальный идентификатор. Идентификатор страницы может содержать маленькие русские или английские буквы, цифры, знаки "-", "_". Еще в идентификаторе может быть двоеточие, см. ниже. Идентификатор страницы отображается вверху страницы в квадратных скобках (у этой страницы идентификатор "страница_документации"). |
- | Чтобы создать ссылку на другую страницу вики, нужно указать идентификатор страницы в двойных квадратных скобках: [[тестовая_страница_для_документации]]. Можно также сделать ссылку с [[тестовая_страница_для_документации|с другим текстом]]. | + | Чтобы создать ссылку на другую страницу вики, нужно указать идентификатор страницы в двойных квадратных скобках: [[тестовая_страница_для_документации]]. Можно также сделать ссылку с [[тестовая_страница_для_документации|другим текстом]]. |
<code>Чтобы создать ссылку на другую страницу вики, нужно указать | <code>Чтобы создать ссылку на другую страницу вики, нужно указать | ||
идентификатор страницы в двойных квадратных | идентификатор страницы в двойных квадратных | ||
скобках: [[тестовая_страница_для_документации]]. Можно также сделать | скобках: [[тестовая_страница_для_документации]]. Можно также сделать | ||
- | ссылку с [[тестовая_страница_для_документации|с другим текстом]].</code> | + | ссылку с [[тестовая_страница_для_документации|другим текстом]].</code> |
- | Чтобы создать новую страницу, нужно сначала создать ссылку на нее, указав идентификатор новой страницы: [[несуществующая страница для документации]]. После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, ее и не создавать. При создании страницы ее идентификатор автоматически преобразуется в нижний регистр, пробелы заменяются на "_". | + | Чтобы создать новую страницу, нужно сначала создать ссылку на нее, указав идентификатор новой страницы: [[Несуществующая страница для документации]]. После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, ее и не создавать. При создании страницы ее идентификатор автоматически преобразуется в нижний регистр, пробелы заменяются на "_". |
<code>Чтобы создать новую страницу, нужно сначала создать ссылку на нее, | <code>Чтобы создать новую страницу, нужно сначала создать ссылку на нее, | ||
- | указав идентификатор новой страницы: [[несуществующая страница для документации]]. | + | указав идентификатор новой страницы: [[Несуществующая страница для документации]]. |
После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, | После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, | ||
ее и не создавать. При создании страницы ее идентификатор автоматически | ее и не создавать. При создании страницы ее идентификатор автоматически | ||
Строка 50: | Строка 50: | ||
Обратите внимание, что ссылки на существующие и несуществующие страницы отображаются по-разному. | Обратите внимание, что ссылки на существующие и несуществующие страницы отображаются по-разному. | ||
- | ===== Пространства имен (namespace, неймспейс) ===== | + | ===== Разделы (namespace) ===== |
- | Пространства имен (namespace, неймспейс) - это способ группировать разные страницы. Чтобы сделать страницу в неймспейсе, нужно указать идентификатор неймспейса в идентификаторе страницы, через двоеточие [[тестовый_неймспейс:тестовая_страница]]. Зайдите [[тестовый_неймспейс:тестовая_страница|сюда]] и обратите внимание, как изменился раздел "Вы находитесь здесь". А еще пройдите по ссылке "Все страницы" вверху и посмотрите, как аккуратно все сгруппировано по неймспейсам. | + | Разделы (в официальной документации DokuWiki они называются namespace - пространства имен) - это способ группировать разные страницы. Чтобы сделать страницу в разделе, нужно указать идентификатор раздела в идентификаторе страницы, через двоеточие [[тестовый_раздел:тестовая_страница_в_разделе]]. Зайдите [[тестовый_раздел:тестовая_страница_в_разделе|сюда]] и обратите внимание, как изменился блок "Вы находитесь здесь" (вверху). А еще пройдите по ссылке "Все страницы" вверху и посмотрите, как аккуратно страницы группируются |
+ | по разделам (не все, конечно, но хотя бы некоторые %%=)%%. | ||
- | <code>Пространства имен (namespace, неймспейс) - это способ группировать | + | <code>Разделы (в официальной документации DokuWiki они называются namespace - |
- | разные страницы. Чтобы сделать страницу в неймспейсе, нужно указать | + | пространства имен) - это способ группировать разные страницы. Чтобы сделать |
- | идентификатор неймспейса в идентификаторе страницы, через двоеточие | + | страницу в разделе, нужно указать идентификатор раздела в идентификаторе |
- | [[тестовый_неймспейс:тестовая_страница_в_неймспейсе]]. Зайдите | + | страницы, через двоеточие [[тестовый_раздел:тестовая_страница_в_разделе]]. |
- | [[тестовый_неймспейс:тестовая_страница_в_неймспейсе|сюда]] и обратите внимание, как изменился | + | Зайдите [[тестовый_раздел:тестовая_страница_в_разделе|сюда]] и обратите внимание, |
- | раздел "Вы находитесь здесь" (вверху). А еще пройдите по ссылке "Все страницы" | + | как изменился блок "Вы находитесь здесь" (вверху). А еще пройдите по ссылке |
- | вверху и посмотрите, как аккуратно все сгруппировано по неймспейсам.</code> | + | "Все страницы" вверху и посмотрите, как аккуратно страницы группируются |
+ | по разделам (не все, конечно, но хотя бы некоторые %%=)%%.</code> | ||
+ | При создании страницы с разделом раздел создается автоматически. | ||
- | ===== Ссылки ===== | ||
- | Ссылки в DokuWiki бывают разные, и создавать их можно тоже по-разному. | + | ===== Вложенные разделы ===== |
- | ==== Внешние ==== | + | Разделы могут быть вложены друг в друга сколько угодно раз. Именно так у нас принято создавать странички с фотоальбомами по пробегам: [[фотоальбомы:2016:20160512_90-й_традиционный_пробег_пушкин-петербург]] |
- | Внешние ссылки распознаются автоматически: http://www.google.com или | + | <code>Разделы могут быть вложены друг в друга сколько угодно раз. Именно |
- | просто www.google.com --- также можно указывать текст ссылки: | + | так у нас принято создавать странички с фотоальбомами по пробегам: |
- | [[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты | + | [[фотоальбомы:2016:20160512_90-й_традиционный_пробег_пушкин-петербург]]</code> |
- | тоже распознаются: <andi@splitbrain.org>. | + | |
- | <code>Внешние ссылки распознаются автоматически: http://www.google.com или | ||
- | просто www.google.com --- также можно указывать текст ссылки: | ||
- | [[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты | ||
- | тоже распознаются: <andi@splitbrain.org>.</code> | ||
+ | ===== Заголовки ===== | ||
- | ==== Внутренние ==== | + | Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков 3-го уровня и выше, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку %%~~NOTOC~~%%. |
+ | ====== Заголовок 1-го уровня ====== | ||
+ | ===== Заголовок 2-го уровня ===== | ||
+ | ==== Заголовок 3-го уровня ==== | ||
+ | === Заголовок 4-го уровня === | ||
+ | == Заголовок 5-го уровня == | ||
- | Внутренние ссылки создаются посредством квадратных скобок. | + | <code> |
- | Можно либо просто указать [[Идентификатор страницы]], либо дополнительно прописать | + | ====== Заголовок 1-го уровня ====== |
- | [[Идентификатор страницы|Текст ссылки]]. Имена Wiki-страниц автоматически | + | ===== Заголовок 2-го уровня ===== |
- | переводятся в нижний регистр, спецсимволы использовать нельзя. | + | ==== Заголовок 3-го уровня ==== |
+ | === Заголовок 4-го уровня === | ||
+ | == Заголовок 5-го уровня ==</code> | ||
- | <code>Внутренние ссылки создаются посредством квадратных скобок. | + | Четыре и более тире преобразуются в горизонтальную черту: |
- | Можно либо просто указать [[Идентификатор страницы]], либо дополнительно прописать | + | |
- | [[Идентификатор страницы|Текст ссылки]]. Имена Wiki-страниц автоматически | + | |
- | переводятся в нижний регистр, спецсимволы использовать нельзя.</code> | + | |
- | Можно использовать в ссылке [[namespaces]] (пространство имён) через двоеточие. | + | текст |
+ | ---- | ||
+ | еще текст | ||
- | <code>Можно использовать в ссылке [[namespaces]] (пространство имён) через двоеточие.</code> | + | <code> |
+ | текст | ||
+ | ---- | ||
+ | еще текст | ||
+ | </code> | ||
- | Ставить ссылки на определённый раздел тоже можно. Просто добавьте через решётку имя раздела, также как это делается в HTML. Ссылка на [[syntax#внутренние|этот раздел]]. | + | ===== Заголовки и названия страниц ===== |
- | <code>Ссылка на [[syntax#внутренние|этот раздел]].</code> | + | Если у страницы нет заголовка, то по умолчанию ее идентификатор используется в качестве названия в ссылках и блоке "Вы находитесь здесь": [[тестовая_страница_без_заголовка]]. Если же у страницы есть хотя бы один заголовок, то в качестве названия используется заголовок: [[тестовый_раздел_с_заголовком:тестовая_страница_с_заголовком]]. Заголовок страницы может содержать любые символы и вообще обычно более красивый, чем идентификатор. |
- | Примечания: | + | ===== Ссылки на другие сайты ===== |
- | * Ссылки на [[syntax|существующие страницы]] отображаются иначе, чем ссылки на [[несуществующие страницы]] | + | Внешние ссылки распознаются автоматически: http://www.google.com или |
- | * Внутренние ссылки без указанного текста могут отображаться по разному в зависимости от настроек - в качестве текста может использоваться название страницы или заголовок первого уровня((именно такая настройка используется на этом сайте)). Так что лучше каждый раз указывать текст ссылки. | + | просто www.google.com --- также можно указывать текст ссылки: |
- | * DokuWiki по умолчанию не использует [[wp>CamelCase]] для автоматического создания ссылок, но эту возможность можно включить в файле [[doku>wiki:config]]. Проверка: Если DokuWiki — ссылка, значит эта возможность включена. | + | [[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты |
- | * Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы. | + | тоже распознаются: <andi@splitbrain.org>. |
+ | <code>Внешние ссылки распознаются автоматически: http://www.google.com или | ||
+ | просто www.google.com --- также можно указывать текст ссылки: | ||
+ | [[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты | ||
+ | тоже распознаются: <andi@splitbrain.org>.</code> | ||
+ | |||
+ | Ссылки на внешние сайты, в отличие от ссылок на страницы вики, автоматически выделяются курсивом. | ||
===== Картинки и другие файлы ===== | ===== Картинки и другие файлы ===== | ||
- | С помощью фигурных скобок можно вставлять в текст внешние и внутренние [[doku>wiki:images|картинки]]. По желанию можно указать их размер. | + | С помощью фигурных скобок можно вставлять в текст картинки, лежащие на других сайтах. |
+ | Разумеется, нужна ссылка на оригинал картинки. | ||
- | Нормальный размер: {{dokuwiki-128.png}} | + | Картинка с Яндекс-Фоток: {{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_L.jpg}} |
- | Отмасштабированная до заданной ширины: {{dokuwiki-128.png?50}} | + | <code>Картинка с Яндекс-Фоток: {{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_L.jpg}}</code> |
- | Отмасштабированная до заданных размеров:{{dokuwiki-128.png?200x50}} | ||
- | |||
- | Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}} | ||
- | |||
- | <code> | ||
- | Нормальный размер: {{dokuwiki-128.png}} | ||
- | Отмасштабированная до заданной ширины: {{dokuwiki-128.png?50}} | ||
- | Отмасштабированная до заданных размеров: {{dokuwiki-128.png?200x50}} | ||
- | Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}} | ||
- | </code> | ||
Поставив слева или справа пробел можно задать выравнивание картинки: | Поставив слева или справа пробел можно задать выравнивание картинки: | ||
- | {{dokuwiki-128.png }} | + | {{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_M.jpg }} |
- | {{ dokuwiki-128.png}} | + | {{ https://img-fotki.yandex.ru/get/105765/31216099.e4e/0_fb476_c78061a1_M.jpg}} |
- | {{ dokuwiki-128.png }} | + | {{ https://img-fotki.yandex.ru/get/151498/31216099.e54/0_fb59e_d8dc9ec7_M.jpg }} |
- | <code>{{dokuwiki-128.png }} | + | <code>{{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_M.jpg }} |
- | {{ dokuwiki-128.png}} | + | {{ https://img-fotki.yandex.ru/get/105765/31216099.e4e/0_fb476_c78061a1_M.jpg}} |
- | {{ dokuwiki-128.png }} | + | {{ https://img-fotki.yandex.ru/get/151498/31216099.e54/0_fb59e_d8dc9ec7_M.jpg }} |
</code> | </code> | ||
И, конечно, картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки). | И, конечно, картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки). | ||
- | {{ dokuwiki-128.png |Название картинки}} | + | {{https://img-fotki.yandex.ru/get/135076/31216099.e4e/0_fb470_972e1790_M.jpg|Белые Ночи 2016}} |
- | <code>{{ dokuwiki-128.png |Название картинки}}</code> | + | <code>{{https://img-fotki.yandex.ru/get/135076/31216099.e4e/0_fb470_972e1790_M.jpg|Белые Ночи 2016}}</code> |
- | Если задать имя файла (внутреннее или внешнее), который не является картинкой (''gif, jpeg, png''), оно будет отображаться в виде ссылки. | + | Если задать имя файла, который не является картинкой (''gif, jpeg, png''), оно будет отображаться в виде ссылки. "Является или не является" определяется по тексту ссылки, так что для ссылок Яндекса надо явно дописывать ".jpg" |
+ | Это правильная ссылка, которая не работает, т.к. не оканчивается на .jpg {{https://img-fotki.yandex.ru/get/105765/31216099.e4d/0_fb46d_55ee430b_M}} | ||
+ | <code>Это правильная ссылка, которая не работает, т.к. не оканчивается на .jpg {{https://img-fotki.yandex.ru/get/105765/31216099.e4d/0_fb46d_55ee430b_M}}</code> | ||
- | ==== Картинки-ссылки ==== | + | В теории, DokuWiki также поддерживает загрузку картинок непосредственно на наш сайт, но НаБегу эта возможность пока что отключена, т.к. место на хостинге ограничено. |
- | Совместив синтаксис ссылки и [[syntax#картинки и другие файлы|картинки]], можно вставить в текст картинку, которая будет внутренней или внешней ссылкой: | + | ===== Картинки-ссылки ===== |
- | <code>[[http://www.php.net|{{dokuwiki-128.png}}]]</code> | + | Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой: |
- | [[http://www.php.net|{{dokuwiki-128.png}}]] | + | [[https://fotki.yandex.ru/users/pvolan/album/227839/|{{https://img-fotki.yandex.ru/get/25232/31216099.e9d/0_fd699_e3840787_M.jpg}}]] |
+ | |||
+ | <code>[[https://fotki.yandex.ru/users/pvolan/album/227839/|{{https://img-fotki.yandex.ru/get/25232/31216099.e9d/0_fd699_e3840787_M.jpg}}]]</code> | ||
Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. | Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. | ||
Строка 164: | Строка 173: | ||
<code>С помощью двойных скобок можно добавить сноску ((Это сноска)).</code> | <code>С помощью двойных скобок можно добавить сноску ((Это сноска)).</code> | ||
- | |||
- | ===== Разбивка на разделы ===== | ||
- | |||
- | Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков 3-го уровня и выше, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку %%~~NOTOC~~%%. | ||
- | |||
- | |||
- | |||
- | ==== Заголовок 3-го уровня ==== | ||
- | === Заголовок 4-го уровня === | ||
- | == Заголовок 5-го уровня == | ||
- | |||
- | <code>==== Заголовок 3-го уровня ==== | ||
- | === Заголовок 4-го уровня === | ||
- | == Заголовок 5-го уровня ==</code> | ||
- | |||
- | Четыре и более тире преобразуются в горизонтальную черту: | ||
- | |||
- | ---- | ||
- | \\ | ||
- | |||
- | <code> | ||
- | ---- | ||
- | </code> | ||