Документация
Оглавление документа
1. Базовые концепции
- Концепции Wiki — что же такое Wiki?
- Концепции WackoWiki — особенности и идеи WackoWiki.
- Концепции Quick Start
- Расширения
- Не Вики, а Content Management Framework – QS предлагает не публичную вики, а фреймворк для управления данными
- Обратная совместимость
2. Общие функции и правила
2.1. Установка и обновление
2.2. Информация для пользователя (с картинками)
2.3. Форматирование текста
- Синтаксис разметки — общие правила разметки
- Правило двух символов — чудесное правило, которое иногда всё равно нарушается
- Универсальный транслит — особенное понимание русских и зарубежных букв
- Типографика — возможность отображать специальные символы сделает тексты более удобными для чтения
2.4. Другие возможности
- Загрузка файлов — как загружать файлы; как на них ссылаться
- Иерархия в ваке — как создать «подстраницу», как упрощённо расставлять между ними ссылки и не запутаться
- Права доступа — возможность ограничивать доступ к любой странице
2.5. Возможности QS
- HighlightJS – встроенная библиотека подсветка синтаксисов разных языков программирования
2.6. Уроки
- Видеоуроки по: установке QS, форматированию текста, написанию экшнов и расширений (к сожалению, для старой версии 3.0, но, благодаря обратной совместимости они вполне актуальны)
3. Дополнения
3.1. Расширения QuickStart
- Extensions – расширения для QuickStart. Что такое расширения?
3.2. Расширения Wacko (экшны, форматтеры)
- Локализация? — добавление нового языка
- Форматтеры? — добавление нового обработчика текста
- Действия (Аctions) — добавление нового динамического элемента
- Темы? — создание нового дизайна
- Файл конфигурации — описание настроек файла config.php
4. Разработчику
Во-первых, разработчику в целом надо знать всё то же, что и администратору – т.е. форматирование + возможности и принципы расширения QS.
Кроме того, есть:
4.1. Для программиста
- Видеоуроки
- Документация по функциям. Особое внимание рекомендуем уделить разделу Examples – посмотреть примеры использования.
- Доп фичи:
- Также обращаем внимание, что множество полезной документации доступно в форке данной системы
Wacko Wiki Very Quick Start, которая развивается Маркеловым Ильей. Большинство возможностей Very Quick Start совместимо с Quick Start; расширения также часто совместимы. Поэтому справкой можно пользоваться.
4.2. Для дизайнера
- bootstrapqs5 – тема «по умолчанию» для QS 5.x и её настройки
- Bootstrap – в QS 5 интегрирован клиентский фреймворк Bootstrap
- VisualTheme – в QS 5 интегрирована собственная разработка VisualTheme, упрощающее разработку тем
4.3. Для администратора
- Производительность? – объяснение механики производительности QS и рекомендации по её увеличению
- Производительность окружения – рекомендации по настройке окружения QS
- Антивирус – встроенная детекция вирусов, обычно поражающая сайт при вскрытии