Где находятся справочные материалы?
Документация системы Onyma находится в разделе База знаний.
Какой язык разметки используется?
Страницы базы знаний используют язык разметки Textile (с некоторыми отличиями от стандарта). Самое заметное разночтение — тег вставки изображения. В стандартном Textile имя файла окружается знаками ! с обеих сторон. В диалекте, используемом базой знаний, за первым восклицательным знаком идет ^:
!^some_filename.png!
Применить стили к изображению пока нет возможности. Атрибуты изображения, определенные в Textile 2, тоже пока не работают.
Какова структура базы знаний?
Объекты, из которых состоит база знаний, располагаются в виртуальной файловой системе. Это могут быть:
- Хранилища;
- Разделы базы знаний;
- Страницы базы знаний;
- Папки.
Хранилище M11 Wiki — корневой объект (или объект верхнего уровня) в базе. Разделы, страницы, папки являются его потомками. Объекты базы знаний могут быть вложенными, хотя и с ограничениями. Раздел можно создать только в хранилище, не в другом разделе. Папку –— внутри хранилища или страницы. Обычная структура базы (сверху вниз) примерно такая: хранилище-разделы-страницы. Страницы могут быть вложенными. См. карточку свойств раздела, вкладка Иерархия страниц:
Подробнее о структуре виртуальной файловой системы см. здесь.
Как добавить новый раздел?
Откройте раздел Виртуальная файловая система | Объекты, нажмите кнопку Добавить ниже списка объектов.
Заполните все поля в карточке объекта:
Нажмите Добавить. Готово:
Как добавить новую страницу?
Добавить новую страницу можно двумя способами: в разделе базы знаний и в разделе виртуальной файловой системы.
Добавление новой страницы через базу знаний
Зайдите в раздел База знаний, выберите любой подраздел.
Нажмите кнопку Новая страница. Откроется карточка новой страницы:
Все поля в карточке обязательны.
Системное имя — часть URL будущей страницы — заполняется латинскими буквами, желательно на английском языке (general_info, а не obschie_svedeniya).
Название страницы — имя, под которым страница будет показываться в списке материалов.
Язык, Язык разметки и Статус менять не следует.
Родителем может быть как сам раздел, так и любая из его страниц.
Редактор в карточке новой страницы полезен, если текст уже готов и ждет только копирования и вставки.
Заполнив все поля, нажмите кнопку Создать.
Добавление новой страницы через виртуальную файловую систему
Откройте раздел Виртуальная файловая система | Объекты, нажмите кнопку Добавить ниже списка объектов. В поле Тип объекта выберите Страница базы знаний.
Заполните все поля, как описано выше. Нажмите Добавить и обновите страницу объектов.
В списке дочерних страниц выбранного объекта появится новая.
Как сделать страницу начальной страницей раздела?
Страницу базы знаний можно настроить так, чтобы она открывалась автоматически при входе в раздел.
Разверните строку нужного раздела, откройте вкладку Иерархия страниц, разверните строку любой страницы.
Поставьте флажок в поле Стартовая. Нажмите кнопку Сохранить.
Как редактировать текст страницы?
Откройте страницу Базы знаний, нажмите кнопку Редактировать.
Откроется карточка редактора.
Выше окна с исходным текстом страницы — кнопочная панель.
- Переключение между режимами редактирования и просмотра;
- Расположение предварительного просмотра;
- Полужирный;
- Курсив;
- Зачеркнутый;
- Заголовок 1;
- Заголовок 2,
- Заголовок 3;
- Маркированный список;
- Нумерованный список;
- Код (теги <pre></pre>);
- Ссылка (внешняя);
- Ссылка (Wiki);
- Вставка изображения (лучше не пользоваться, вставляет теги !! вместо !^!);
- Вставка текста другого цвета.
Как обновить текст страницы без редактирования?
Страницу базы знаний на сервере можно обновить, не редактируя, путем загрузки нового исходного файла. Это удобно, если вы работаете над текстом на локальном компьютере. Сделать это можно двумя способами.
Обновление текста через окно редактора
В окне редактора страницы нажмите кнопку Загрузить новый файл, выберите локальный файл, нажмите Загрузить.
Обновление текста через объект виртуальной файловой системы
Перейдите в раздел Виртуальная файловая система, в списке объектов раскройте строку нужной страницы, перейдите во вкладку Контент. Найдите строку с тем же названием, что и текущая страница, разверните ее, во вкладке Объект нажмите кнопку Загрузить новый файл.
Выберите локальный файл и нажмите Загрузить.
Как добавить к странице изображения?
Сначала в текст страницы нужно добавить ссылку на изображение:
!^some_filename.png!
Затем — загрузить изображение на сервер. Для этого откройте карточку объекта, соответствующего странице Базы знаний (или в разделе Виртуальной файловой системы, или нажав кнопку Объект прямо на странице).
Перейдя в карточку объекта, откройте вкладку Вложения. Нажмите кнопку Добавить.
Следующий шаг может выглядеть по-разному, в зависимости от инсталляции. Рассмотрим обе возможности.
Загрузка файла, способ А
В карточке нового файла щелкните по полю Файл, затем выберите файл на локальном компьютере. Нажмите кнопку Добавить.
Готово.
Загрузка файла, способ Б
В карточке нового файла заполните поле Файл. Под этим именем файл будет сохранен на сервере. Это имя вам нужно будет указать в исходном тексте страницы в теге !^!. Нажмите Добавить.
Теперь разверните строку добавленного файла. Во вкладке Объект нажмите Загрузить новый файл.
В карточке нового файла щелкните по полю Новый файл, затем выберите файл на локальном компьютере. Нажмите кнопку Загрузить новый файл.
Готово.
Теперь в любом месте страницы вы можете поместить команду вставки файла:
Как обновить уже загруженное изображение?
Разверните строку прежде загруженного файла. Во вкладке Объект нажмите Загрузить новый файл.
В карточке нового файла щелкните по полю Новый файл, затем выберите файл на локальном компьютере. Нажмите кнопку Загрузить новый файл.
Готово.
Как ограничить права доступа к материалам базы знаний?
Иногда нужно разрешить доступ к странице/разделу только пользователям, назначенным на определенную позицию. Чтобы это сделать, откройте карточку объекта, перейдите во вкладку Доступ по позициям, нажмите Добавить.
Заполните поле Позиция. В поле Роль укажите [SYS] Читатель базы знаний. Поля Допуска не заполняйте.
Нажмите Добавить.
Объект, у которого в списке Доступ по позициям нет ни одной позиции, открыт для всех пользователей.
Технические вопросы
Как использовать в тексте страниц символы "[", "]", "|"?
Символы "[", "]", "|" имеют особое значение в языке Textile. Использовать их в тексте страницы, вообще говоря, нельзя. При необходимости, однако, можно их заменить на соответствующие коды HTML:
| Символ | Код |
|---|---|
| [ | [ |
| ] | ] |
| | | | |
У этого приема есть один недостаток: после сохранения файла и повторной загрузки в редактор коды снова превратятся в символы.
Как создать в тексте страниц внутренние ссылки?
В чистом HTML можно создать ссылки внутри страницы следующим образом:
<p><a href="#named_anchor">Краткие сведения о нуммулитах</a></p> <a name="named_anchor"></a> <h2>Краткие сведения о нуммулитах</h2>
В Textile то же самое выглядит так:
[Краткие сведения о нуммулитах|current_page_name#named_anchor] h2(wiki_anchor#named_anchor). Краткие сведения о нуммулитах
Current_page_name — внутреннее имя текущей страницы.