Документация разработчика

CushyCMS работает посредством загрузки сайта по FTP и последующего поиска конкретных CSS классов, примененных к элементам страницы. В зависимости от найденного контента, Cushy представит наиболее целесообразный способ редактирования контента.

На этой странице зафиксированы все доступные опции шаблона Cushy.

Free Account

Pro Account


Free Account

Общий обзор

Cushy грамотно отредактирует любой элемент, перед которым Вы поставите css класс cushycms on.

<h1 class="cushycms" title="My Heading">Это будет отредактировано</h1>
<div class="cushycms" title="Main Content">
  <p>Больше редактируемого материала тут...</p>
</div>
<p>Меня изменить нельзя</p>
<img class="cushycms" src="foo.jpg" alt="Я – изменяемое изображение!" />

Tip: Pro users can specify a class of "clienteditor" as an alternative to "cushycms".

Если у Вашего элемента уже есть классовое имя, Вы все равно можете применять cushycms к нему:

<div class="whatever cushycms">

Вот видео, показывающее, как начать работу с CushyCMS всего за несколько минут.

Как настроить и изменить Ваш сайт при помощи Cushy всего за 5 минут

Маркировка полей

Помогите Вашим редакторам определить точно какую часть они редактируют с помощью применения маркировки на полях. Просто используйте свойство названия редактируемого элемента.

<h1 class="cushycms" title="Основной заголовок">Это станет изменяемым</h1>

Cushy будет автомагически отбирать маркировку следующих элементов там, где это возможно:
title, alt, id

Редактирование изображений

Cushy сможет позволить Вашим редакторам изменить изображения на странице. Она будет проверять высоту и ширину тегов изображения, что бы наилучшим образом подогнать размер файла к данной площади.

<img src="1.jpg" class="cushycms" width="250" height="100" alt="Photo" />

Размер загруженного изображения будет 250 пикселей в ширину и 100 пикселей в высоту. Также, при надобности, изображение можно обрезать.

<img src="1.jpg" class="cushycms" width="250" alt="Photo" />

Ширина загруженного изображения станет 250 пикселей. Его высота изменится пропорционально.

<img src="1.jpg" class="cushycms" alt="Photo" />

Загруженное изображение не изменится в размерах.

Загрузка файлов

Редактор Cushy WYSIWYG позволяет пользователям загружать локальные файлы с помощью кнопок панели инструментов Ссылка и Изображение (обратите внимание на кнопку Загрузка в всплывающем меню).

Изначально эти файлы временно хранятся на сервере cushy, но после публикации страницы они передаются на Ваш FTP-сервер.

По умолчанию эти файлы публикуются в том же каталоге, что и страница, но это можно настроить с помощью страницы Конфигурация сайта.

Корректировка типа содержимого

Cushy использует несколько разных методов редактирования, в зависимости от типа контента. Cushy выберет наиболее подходящий метод, основываясь на элементе контейнера. Но мы понимаем, что могут возникнуть случаи, когда Вы захотите принудительно установить тип контента. В таком случае, используйте один из альтернативных классов, приведенных ниже::

class="cushycms-text"

Редактирует контент как открытый текст. Пример использования ":" редактируемый серверный код или если вы предпочитаете писать html от руки.

class="cushycms-html"

Любые введенные специальные символы будут конвертированы в элементы html. Eg: © becomes &copy;

class="cushycms-wysiwyg"

Тоже, что и в верху, только в этом случае редактор снабжается кнопками для выполнения базовых заданий, таких, как создание списков, ссылок и т.д.

class="cushycms-xml"

Любые специальные символы, введенные будет преобразован в XML лиц. Eg: < becomes &lt;

Элементы XML

Легкие имеет поддержку для элементов XML. Содержание вошел в окно редактирования для XML элементов будет правильно XML закодированы так, что ваш XML не будет считаться недействительным. Любой элемент, с которыми сталкиваются Cushy, который не классифицируется как XHTML (полный список элементов здесь) будет рассматриваться как XML.

<product>
  <name>Banana</name>
  <price class='cushycms'>$12.99/kg</price>
</product>

Если у вас возникли проблемы с элементами в XML подхватили как XHTML (потому что они имеют те же названия), проверьте раздел на главной типов содержимого. В общем, вы можете использовать cushycms-xml класса типа, чтобы заставить ваш элемент в режиме XML.

Советы и трюки

Помните, что Cushy может редактировать практически все. Снизу приведено несколько креативных подходов:

<script type="text/javascript" class="cushycms">
  alert('Смотрите - Вы можете редактировать даже JAVA-Скрипты!');
</script>

Редактирование javascript. Примером может быть Ваш код Google AdSense.

<p>Our charity has raised $<span class="cushycms">2140</span> so far</p>

Позволяет редактировать даже одну цифру или слово.

Использование Cushy с динамическими языками (PHP, ASP и т.д.)

Иногда Cushy трудно декодировать документы, содержащие комбинацию из html и серверного сценариев, таких, как PHP.

Поэтому мы настоятельно рекомендуем размещать редактируемый контент cushy в автономном статическом файле, в котором и будет находиться Ваш код.

Например:

<html>
  <head><title>Contact Us</title></head>
  <body>
    <? include("contact_static.html"); ?>
  </body>
</html>

Вверху":" содержимое contact.php.

<h1 class="cushycms">Contact Us</h1>
<div class"cushycms">
  <p>Тут контент изменяется...</p>
</div>

Вверху":" содержимое content_static.html.

В этом сценарии Вы скажете Cushy делать изменения в файле contact_static.html.

Кодирование символов

Cushy поддерживает специальные символы (к пимеру, не только западный алфавит) в формате UTF-8. Для поддержки данного формата, пожалуйста, убедитесь, что в верхней части Вашей html страницы есть следующее::

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

Узнайте больше о преимущества UTF-8.

 

Pro Account

Повторяющиеся элементы

Использование повторяющихся элементов в CushyCMS может быть чрезвычайно мощным. Первый шаг положить редактируемый класс на вашем внешнем повторяемых элементов, доступных теги <ul>, <ol> <table> и <dl>. Отсюда, теплые будет выглядеть внутри этого элемента и определить, какие элементы считаются "повторяемый", например, <li>, <tr> или <dt> тега. Как только, что элемент не найден, любой редактируемой метки внутри этого элемента будут сгруппированы так, что любой "повторять" внешнего элемента будет содержать все редактируемые элементы внутри.

Рассмотрим следующий пример:

<ul class="cushycms">
  <li>
    <p class="cushycms">Это будет отредактировано</p>
    <p>Меня изменить нельзя</p>
  </li>
</ul>

Здесь, <p> тег содержит редактируемые теги <p> и неизменяемые <p>. Когда редактор выбирает "повторить" это <li> CushyCMS будет сделать клон все теги, в том числе и <p> элементов, хотя редактор имеет доступ только к редактировать один из них. Вы можете иметь столько редактируемой метки внутри повторяющихся элементов, как вы хотите, или вы можете просто сделать повторяемым элементом редактируемые в целом.:

Вот видео, показывающее, как реализовать повторяемые регионе.

Повторяется регионов

Переопределение изображений / добавления

Используйте флажок на присвоить / настроить страницу экран для переключения этой функции. После включения каких-либо новых изображений для вашего CushyCMS теги <img> будет держать же именем. Все изображения и файлы, загруженные с помощью редактора WYSIWYG также будет держать файла они были во время загрузки. Это полезно для вещей, как price_list.pdf или аналогичные, но это также означает, редактор находится в полный контроль того, что файл будет называться на сервере. Вы должны быть осторожны в случае, если ваш редакторов загрузить файл с именем print.css или logo.gif или подобных, что может разрушить ваш сайт. По этой причине мы рекомендуем применять только этот параметр, если также используется пользовательский путь для загрузки.

Пользовательские Редактируемые класса

Как Pro пользователь, вы можете определить свои собственные редактируемые класса вместо традиционных CushyCMS или clienteditor классов. Вы даже можете установить это в редакторе. Это позволит вам дает один редактор доступ к определенным разделам страницы в то же время давая различные доступ редактора в другие разделы. Возьмите ниже код для примера:

<span class="cushycms-ferris">Only Ferris can edit this.</span>
<span class="cushycms-cameron">Only Cameron can edit this.</span>

Здесь вы можете увидеть пользовательские классы CushyCMS-обозрения и CushyCMS-Камерон. Это могут быть MyCompany-обозрения, если хотите. Вы также можете просто установить каждый редакторов пользовательского класса быть просто "MyCompany", если вам не нужны любые сложные методы разрешения. Следует отметить, что эти классы также работать с содержанием перекрывает, так MyCompany-Феррис-HTML будет работать, как ожидалось.

Брендинг и оформление

Вот видео, показывающее, как настроить CushyCMS, чтобы соответствовать вашим брендом, или бренд вашего клиента.

Брендинг, дизайн и клонирование

Копирование страниц

Как Pro пользователь у вас есть способности, чтобы ваши некоторые или все ваши редакторы создавать новые страницы на основе содержимого существующих страниц. Вы можете включить эту при добавлении или редактировании редактор разрешения существующих редактора. Включение это позволит клон значок рядом с каждой страницы в панели управления редакторов (этот значок уже видна конструктор странице). Редактор будет предложено ввести имя новой страницы и файл будет создан на основе этого имени. Новая страница будет точный клон старой страницы, которые редактор может редактировать соответственно.

Пользовательские Добро пожаловать Email

Как Pro пользователь вы можете установить пользовательские приветствуем шаблон электронной почты. Это делается в настройках пользователя, чуть ниже, где вы установите ваш пользовательский домен и выбрать другой про такие функции, как брендинг. Есть целый ряд переменных, которые будут интерполированы в электронной почте, например, имя редактора, адрес электронной почты и системы сгенерированный пароль. Мы, очевидно, рекомендуется включать по крайней мере пароль переменной.

Новостная лента RSS об изменениях страницы

Пользователи Pro могут получить доступ к специальной новостной ленте RSS, которая проинформирует обо всех изменениях на сайте и на его страницах.

  • Все изменения: эта лента доступна со страницы Панель управления, установленной по умолчанию
  • Изменения сайта: эта лента доступна со страницы Конфигурации сайта
  • Изменения страницы: эта лента доступна со страницы Истории изменений

Какой бы Вы не использовали клиент для чтения новостей, обратите внимание на то, чтобы бы он поддерживал возможность верификации пользователя, т.к. Вам надо будет ввести Ваш логин cushy для просмотра ленты. Если Ваш клиент не поддерживает такой функционал (например, Google Reader), тогда иным выходом может стать сервис свободного доступа к лентам новостей .