Описание wiki
Комплексный компонент позволяет вести полнофункциональную работу с Wiki, создавая физически только одну страницу. Компонент является стандартным и входит в дистрибутив модуля.
В визуальном редакторе компонент расположен по пути: Контент > Wiki > Wiki.
Компонент относится к модулю Wiki.
Параметры
| Поле |
Параметр |
Описание |
| Основные параметры |
|---|
| Тип информационного блока (используется только для проверки) |
IBLOCK_TYPE |
Указывается тип информационных блоков, в котором будут храниться данные Wiki. Тип инфоблока создается при инсталляции дистрибутива или установке модуля. Если не создан, то требуется создание вручную. |
| Код информационного блока |
IBLOCK_ID |
Указывается информационный блок, в котором будут храниться данные Wiki. Инфоблок создается при инсталляции дистрибутива или установке модуля. Если не создан, то требуется создание вручную. |
| Имя Wiki-страницы |
ELEMENT_NAME |
Задается имя переменной в которой будет передаваться имя страницы. Должно совпадать с полем "Имя переменной для страницы". |
| Шаблоны ссылок |
|---|
| Шаблон пути к странице пользователя |
PATH_TO_USER |
Указывается путь к странице пользователя. Используется в истории создании страницы для перехода на страницу профиля пользователя. |
| Управление адресами страниц |
|---|
| Включить поддержку ЧПУ |
SEF_MODE |
[Y|N] При отмеченной опции будет включена поддержка ЧПУ.
Если режим поддержки ЧПУ включен, то необходимо настроить
следующие параметры:
| Каталог ЧПУ (относительно корня сайта) |
SEF_FOLDER |
Каталог ЧПУ: путь до папки, с которой работает компонент. Для серверов на Windows каталог, указанный в этом поле, физически существовать не должен. Это связано с обработкой символа ":" в Windows. |
| Адреса страниц |
SEF_URL_TEMPLATES |
Указываются адреса следующих страниц:
- index - Шаблон пути к главной Wiki-странице;
- post - Шаблон пути к Wiki-странице;
- post_edit - Шаблон пути к странице редактирования Wiki-страницы;
- categories - Шаблон пути к странице со списком категорий;
- discussion - Шаблон пути к странице обсуждения;
- history - Шаблон пути к странице истории изменений Wiki-страницы;
- history_diff - Шаблон пути к странице сравнения версий Wiki-страницы;
- search - Шаблон пути к странице поиска;
|
SEF_FOLDER и SEF_URL_TEMPLATES.
Если режим поддержки ЧПУ выключен, то необходимо настроить
следующие параметры:
| Имена переменных |
VARIABLE_ALIASES |
Имена переменных для управления страницами.
При выключенном режиме ЧПУ необходимо указать имена следующих переменных:
- wiki_name - имя переменной для страницы;
- oper - имя переменной для операции;
|
VARIABLE_ALIASES.
|
| Дополнительные настройки |
|---|
| Название пункта меню для цепочки навигации |
NAV_ITEM |
В цепочку навигации будет включен пункт меню. |
| Устанавливать заголовок страницы |
SET_TITLE |
Название страницы будет установлено в качестве заголовка окна браузера. |
| Устанавливать статус 404, если не найдены элемент или раздел |
SET_STATUS_404 |
Странице будет установлен статус 404, если не найдена страница или раздел. |
| Включать инфоблок в цепочку навигации |
INCLUDE_IBLOCK_INTO_CHAIN |
В цепочку навигации будет включено название информационного блока. |
| Включать раздел в цепочку навигации |
ADD_SECTIONS_CHAIN |
Раздел Wiki будет включен в цепочку навигации. |
| Настройки обсуждения |
|---|
| Разрешить обсуждеие |
USE_REVIEW |
Дается разрешение на обсуждение статей Wiki. При включенной опции появляются
дополнительные настройки.
| Количество сообщений на одной странице |
MESSAGES_PER_PAGE |
Число сообщений форума, выводимое на одной странице. |
| USE_CAPTCHA |
USE_CAPTCHA |
Разрешает использование CAPTCHA при создании сообщений в форуме. |
| Путь относительно корня сайта к папке со смайлами |
PATH_TO_SMILE |
Если используется нестандартная папка со смайликами, укажите путь до нее. |
| ID форума для отзывов |
FORUM_ID |
Указать форум, который будет использован для обсуждения статей Wiki. Требуется предварительное создание форума. |
| Страница чтения темы (пусто - получить из настроек форума) |
URL_TEMPLATES_READ |
Указывается шаблон пути до темы форума с обсуждением статьи. Используется при выводе ссылки на обсуждение на странице статьи. |
| Показать ссылку на форум |
SHOW_LINK_TO_FORUM |
Разрешается показ ссылки на форум обсуждения статей. |
| Начинать тему текстом элемента |
POST_FIRST_MESSAGE |
Первое сообщение в форуме будет цитировать текст статьи. |
|
Пример вызова
<?$APPLICATION->IncludeComponent(
"bitrix:wiki",
"",
Array(
"SEF_MODE" => "Y",
"PATH_TO_USER" => "",
"IBLOCK_TYPE" => "wiki",
"IBLOCK_ID" => "",
"ELEMENT_NAME" => $_REQUEST["title"],
"USE_REVIEW" => "Y",
"MESSAGES_PER_PAGE" => "10",
"USE_CAPTCHA" => "Y",
"PATH_TO_SMILE" => "/bitrix/images/forum/smile/",
"FORUM_ID" => "",
"URL_TEMPLATES_READ" => "",
"SHOW_LINK_TO_FORUM" => "N",
"POST_FIRST_MESSAGE" => "N",
"NAV_ITEM" => "",
"SET_TITLE" => "Y",
"SET_STATUS_404" => "N",
"INCLUDE_IBLOCK_INTO_CHAIN" => "N",
"ADD_SECTIONS_CHAIN" => "N",
"SEF_FOLDER" => "/about/",
"SEF_URL_TEMPLATES" => Array(
"index" => "index.php",
"post" => "#wiki_name#/",
"post_edit" => "#wiki_name#/edit/",
"categories" => "categories/",
"discussion" => "#wiki_name#/discussion/",
"history" => "#wiki_name#/history/",
"history_diff" => "#wiki_name#/history/diff/",
"search" => "search/"
),
"VARIABLE_ALIASES" => Array(
"wiki_name" => "wiki_name",
"oper" => "oper"
)
)
);?>