Отображается в меню админской части в качестве ссылки на документ


Скачать 484.15 Kb.
Название Отображается в меню админской части в качестве ссылки на документ
страница 1/4
Тип Документы
rykovodstvo.ru > Руководство эксплуатация > Документы
  1   2   3   4

ОСНОВНЫЕ ПОНЯТИЯ



Документ - объект, характеризующийся набором свойств зависящих от типа документа и набором свойств общих для всех документов:

  • Название - отображается в меню админской части в качестве ссылки на документ.

  • Код - Уникальный идентификатор документа

Код не должен начинаться с цифры

  • Отображать - Видимость документа на сайте

  • Заголовок длинный

  • Заголовок средний

  • Заголовок короткий

  • Изображение в активном состоянии - если в меню сайта используются картинки, то эта выбирается, если документ просматривается

  • Изображение в неактивном состоянии


Помимо этого есть еще свойство тело документа, которое формируется для каждого документа автоматически и зависит от типа документа и значений остальных свойств. Так для новостной ленты тело – список новостей, для текстового документа – собственно текст.
Тип документа – одно из списка (список может пополняться):

  • Бинарный документ

  • Каталог

  • Элемент каталога

  • Консультарий

  • Опросник

  • Папка

  • Форма

  • HTML документ

  • Новостная лента

  • Новость

  • Таблица БД

  • Текстовый документ


Шаблон – HTML код со спецтегами, используется для отображения документа. При выводе документа отображается шаблон. Каждый спецтег заменяется на сгенерированный HTML код, при генерации кода используются параметры текущего документ (если в параметрах тега жестко не указан другой документ).

Так спецтег [BODY] будет заменен на тело текущего документа.
Спецтег – тег, формат тот же, что и у HTML тегов за исключением того, что скобки не треугольные а квадратные, либо квадратные в комментариях HTML ([] или от типа скобок результат не зависит).
Доступные теги:


Имя Тега

Назначение

BODY

тело документа

DOCFIELD

поле документа

MENU

оглавление

FORPRINT

ссылка "для печати"

LINK

ссылка на документ движка

MAP

карта сайта

NEWS

новостная лента

NEWSARC

архив новостной ленты

PATH

путь к текущему документу

PHP

php код

INCLUDE

Вставка одного шаблона в другой

DATE

текущая дата/время


Более подробное описание смотри раздел СПЕЦТЕГИ
Стиль - CSS файл. После того как стиль добавлен в систему, он может быть назначен стилем для отображения любому документу.
Рассылка - Объект, позволяющий рассылать документы по email, включает в себя список, адресов на которые производится рассылка (может пополняться как пользователями сайта, так и администратором) и документ который должен по этим адресам рассылаться.

Работа со стилями
Основное, что надо понять, это то, что стили в CMS наследуются, т.е при отображении документа подгружаются стили всех его предшественников по дереву вплоть до стиля, определенного в конфиге для корневого документа. Это означает, что если различие в стиле вывода какого-то документа по сравнению с его предшественником не слишком велико, то не нужно брать стиль предшественника, дописывать в него недостающие описания и прописывать как стиль документа, достаточно записать эти описания (и только их) в отдельный файл стиля, добавить этот файл в систему и присвоить его документу.

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

При генерации каждого типа документа CMS прописывает определенные классы в генерируемые теги. Их список есть в описаниях типов документов.

СПЕЦТЕГИ
Внутри теговых скобок вместо ] следует писать ~] иначе ] будет закрывающей теговой скобкой
BODY
Описание : Выводит тело документа

Формат : [BODY doc_id='']

Параметры :

doc_id - ID или код документа для отображения. По умолчанию - текущий документ.

check_visiblity – параметр отвечает надо ли делать проверку на отображаемость документа. Если документ не отображается, то выводиться боди этого документа не будет

prefix, postfix – два параметра, которые отвечают за вывод HTML перед и после боди тега. Если документ не отображается и стоит параметр check_visiblity установлен, то prefix и postfix выводиться не будут.

short_format – формат вывода тела документа, в который можно передать любые параметры (например, из каталога), которые хранятся в полях таблиц БД engine_documents и engine_ТИПДОКУМЕНТА

INCLUDE
Описание : Вставляет один шаблон в другой.Допустима любая вложенность.

Формат : [INCLUDE имя шаблона]

Параметры :

имя шаблона - название вставляемого шаблона.


DATE



Описание : Выводит текущую дату/время

Формат : [DATE format='']

Параметры :

format - - формат вывода даты. Строка, в которой обозначения заменяются в соответствии со следующей таблицей.



%a

abbreviated weekday name according to the current locale

%A

full weekday name according to the current locale

%b

abbreviated month name according to the current locale

%B

full month name according to the current locale

%c

preferred date and time representation for the current locale

%C

century number (the year divided by 100 and truncated to an integer, range 00 to 99)

%d

day of the month as a decimal number (range 01 to 31)

%D

same as %m/%d/%y

%e

day of the month as a decimal number, a single digit is preceded by a space (range ' 1' to '31')

%h

same as %b

%H

hour as a decimal number using a 24-hour clock (range 00 to 23)

%I

hour as a decimal number using a 12-hour clock (range 01 to 12)

%j

day of the year as a decimal number (range 001 to 366)

%m

month as a decimal number (range 01 to 12)

%M

minute as a decimal number

%n

newline character

%p

either `am' or `pm' according to the given time value, or the corresponding strings for the current locale

%r

time in a.m. and p.m. notation

%R

time in 24 hour notation

%S

second as a decimal number

%t

tab character

%T

current time, equal to %H:%M:%S

%u

weekday as a decimal number [1,7], with 1 representing Monday

%U

week number of the current year as a decimal number, starting with the first Sunday as the first day of the first week

%V

The ISO 8601:1988 week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the current year, and with Monday as the first day of the week.

%W

week number of the current year as a decimal number, starting with the first Monday as the first day of the first week

%w

day of the week as a decimal, Sunday being 0

%x

preferred date representation for the current locale without the time

%X

preferred time representation for the current locale without the date

%y

year as a decimal number without a century (range 00 to 99)

%Y

year as a decimal number including the century

%Z

time zone or name or abbreviation

%%

a literal `%' character



DOCFIELD

Описание : Выводит свойство документа

Формат : [DOCFIELD doc_id='' type='']

Параметры :

doc_id ID или код документа для отображения, по умолчанию - текущий документ

prefix будет выводиться перед полем

postfix будет выводиться после поля

check_visiblity информация из поля будет выведена только в том случае, если документ отображается

type - поле для вывода по умолчанию – тело документа

допустимые значения:

name название

caption_long заголовок длинный

caption_medium заголовок средний

caption_short заголовок короткий (если хотим чтоб выводился короткий заголовок раздела на уровень выше текущего, т.е. https://bt.belti.ru/tasks/bug_view_page.php?bug_id=0007659, нужно указать параметр ptitle='1')

code код

creation_date дата создания

folder Название папки, которой принадлежит документ

meta меты

title заголовок

counter1 код счеичика 1

counter2 код счеичика 2

counter3 код счеичика 3

resume резюме

actimg картинка активная

unactimg картинка неактивная

https://bt.belti.ru/tasks/bug_view_advanced_page.php?bug_id=0008604

add_text1 – доп текст 1

add_text2 - доп. текст 2

add_number1 - доп число 1

add_number2 – доп. число 2

add_img1 – доп. картинка 1

add_img2 - доп картинка 2

FORPRINT

Описание : Выводит JavaScript на отображение "для печати" (для вставки в onClick тега ). Выводится именно JavaScript, а не url, и не сам тег , отображение тела документа без дизайна

Формат : [FORPRINT doc_id='']

Параметры :

doc_id - ID или код документа для отображения, по умолчанию - текущий документ
пример использования:

Версия для печати
LINK

Описание : Выводит URL документа

Формат : [LINK doc_id='']

Параметры :

doc_id - ID или код документа.


MAP

Описание : Выводит карту сайта

Формат : [MAP folder='']

Параметры :

folder - ID или код папки, от которой начинать вывод карты сайта. По умолчанию - корень.


MENU

Описание : Выводит меню.

Формат : [MENU folder='' type=’’ text_to_show=’’ Format=’’]

Параметры :

folder - ID или код папки, от которой начинать вывод карты сайта, по умолчанию - корень. (либо если имеет вид upN, то меню раздела, выше на N, чем текущий)

parent. Выведет список документов в папке-родителе

topfolder. Выведет список документов в самой верхней папке (сразу после корня)

-1 – Корневая папка

0 – текущая папка
view horizontal – вывод горизонтального меню

prefix выводится до меню если есть документы

postfix выводится после меню если есть документы
format_postfix текст, который будет выводиться после формата и отработки внутренних папок

no_docs выводится, если документов нету

deep_search глубина вывода меню. По умолчанию 0. При использовании этого параметра можно указывать отедельные настройки для каждого меню.

only_open_docs - вывод подменю

Если вы хотите использовать для меню 1 уровня, то переменная с форматом должна называться format1 и т.д.

type тип оглавления
Допустимые значения


Documents

Только документы

Folders

Только разделы

по умолчанию

Все

“NEW”,”TEXTDOC”

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


view_catalog = 1 выводить содержимое каталога
text_to_show - текст отображаемый в качестве пункта меню.


caption_short

Короткий заголовок

caption_medium

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

caption_long

Длинный заголовок

по умолчанию

Название


separator – html текст который будет выводиться после каждого элемента кроме последнего.
Format Формат вывода пункта меню

SFormat Формат вывода текущего (selected) пункта меню


Используемые в формате обозначения:

ITEM_TEXT

место для вывода текста пункта меню

ITEM_IMG

место для вывода названия файла изображения пункта меню

ITEM_LINK

место для вывода URL пункта меню

ITEM_CAPTION_LONG

Место для вывода длинного названия

ITEM_CAPTION_MEDIUM

Место для вывода среднего названия

ITEM_CAPTION_SHORT

место для вывода короткого названия

ITEM_CODE

место для вывода кода документа

ITEM_CREATION_DATE

место для вывода даты создания документа

ITEM_USER

место для вывода пользователя, создавшего документ

ITEM_RESUME

место для вывода резюме документа

ITEM_NUM

Порядковый номер элемента

ITEM_COUNT

Количество элементов в меню

ITEM_SELECTED

Флаг выделения элемента. Если текущий элемент активен, то флаг будет браться из параметра item_selected иначе из item_unselected

ITEM_PID

ID родителя


Если формат пустой, то вывод будет производиться по стандартному шаблону.
Частный случай с меню
При выводе меню необходимо чтобы по нажатию на пункт меню, его название (либо картинка-кнопка) отображалось где-то в другом месте. При этом при переходе в подразделы оно (она) сохранялась.
Для этого в начале шаблона прописывается такая строка

[PHP do='find_open_folder.php' in_folder='-1' pname='fold1']
find_open_folder.php - скрипт, который находит открытую (текущую) папку, опделяет ее ID и передает его в переменную pname.
В теге [MENU] в параметре folder=’’ указывается значение параметра pname.
Меню умеет выводить doc_разныеполя родительской папки и PARENT_* в префикс, постфикс и nodocs, но в поля элемента - только ITEM.


NEWS

Описание : Выводит новостную ленту с заданым ID

Формат : [NEWS doc_id='' format=’’ style=’имя класса’]

Параметры :

count – количество выводимых новостей

doc_id ID или код новостной ленты для отображения

style Стиль картинки. По умолчанию стиль «pic_class»

format

Используемые в формате обозначения:

NEW_HREF

Ссылка на подробную новость

NEW_HEADER

Заголовок новости

NEW_TEXT

Текст новости (короткий)

NEW_DATE

Дата публикации

NEW_PICn

Картинка, где n – её порядковый номер

NEWS_PIC_URLn

URL картинки


Так же формат может быть указан в виде format1=’...’ format2=’...’ и т.п., в таком случае первая новость будет выведена по format1, вторая по format2 и так далее. При этом, если отсутствуют какие либо из промежуточных форматов, новости будут выводиться по последнему. Т.е. например если format2 не указан, то вторая и далее новости будут выводиться по format1, а если далее будет указан format5 то пятая и далее новости выведутся по этому формату. Данные форматы перекрывают параметр format.



NEWSARC

Описание : Выводит архив новостной ленты с заданым ID

Формат : [NEWSARC id='']

Параметры :

id ID или код новостной ленты для отображения
Устарело. Сейчас у новостных лент есть чекбокс «Добавить ссылку на архив»


PATH


Описание : Путь к текущему документу.

Формат : [PATH splitter=’’ root=’’ format=’’ lang=’’]

Параметры :

splitter разделитель по умолчанию /

lang по умолчанию русский, если надо английский то значение eng, esp, fra, rus

root Вывод названия для корневой директории. По умолчанию – «Главная»

format формат вывода пункта меню. По умолчанию

"ITEM_TEXT"

doc_root код или ID документа для ссылки на главуную страницу


Используемые в формате обозначения:

ITEM_TEXT

место для вывода текста пункта меню

ITEM_LINK

место для вывода URL пункта меню


PHP

Описание : Запускает и выводит результат выполнения php скрипта.

Формат : [PHP do=’’]

Параметры : do имя файла скрипта
Внутри теговых скобок вместо ] следует писать ~] иначе ] будет закрывающей теговой скобкой

Пример: [PHP do='echo $doc_vars[folder~];']

Кроме этого, следует помнить что значение параметра “do” выполняется с помощью PHP-функции eval() и соблюдать правильность параметров.
ДОПОЛНЕНИЕ тега PHP;

Синтаксис [PHP do='...;end;...end;']

ключевое слово ;end;

Описание разделяет инструкции и помещает в eval по очереди

выбор ;end; связан с тем, что можно видеть конструкции вида [PHP do=’ echo "<script> bbb; </</i>script>;)’] в этом случае сложно отделить инструкции по ;
возможные варианты синтаксиса

1. [PHP do='echo "1";end; echo "2";end;'] печатает 1, 2

2. [PHP do='if ($doc->code!="allnumbers") file_php(joke.php);else |BODY|;end;']

if ($doc->code!="allnumbers") то выводится содержимое файла joke.php (при помощи функции file_php, в другом случае будет ощибка)

иначе выведится BODY - тег (обязательное использование | перед и в конце тега)

использование тега (не PHP) обязательно с |

3. [PHP do='if ($doc->code!="allnumbers") file_php(joke.php);end;file_php(joke2.php);end;']

в зависимости от условия выводится либо файл joke2.ph или joke.ph
4. [PHP do='if ($doc->code=="allnumbers") file_php(joke.php);else {echo "

";{|DOCFIELD type="caption_short"|;} echo "

";};end;']

похожа по конструкции на синтаксис
[IF do='($doc->code=="allnumbers”)']

[PHP do= joke.php ']

[ENDIF]

[IF do='(($doc->code!="$allnumbers)']

[DOCFIELD type='name']



[ENDIF]
p.s. внутри блока [PHP do='...'] не возможно использование ‘, будет ошибка

IF

Описание : В зависимости от условия выводит или не выводит блок межу [IF do='....'] [ENDIF]

Формат : [IF do='....']

.....

[ENDIF]

Параметры : do условие
Пример:

[IF do='(($doc->type=="CATALOGITEM") || ($doc->type=="CATALOG"))']

[DOCFIELD type='name']



[ENDIF]
Важно!! предусмотрена только одно вложение [IF ... [ENDIF], вложения [IF .[IF ... [ENDIF].. [ENDIF] не будут работать, как и [ELSE] Кроме этого, следует помнить что значение параметра “do” выполняется с помощью PHP-функции eval() и соблюдать правильность параметров.
Указание и вызов переменных.
[SETVAR varName="someVar"]

[SHOWVAR varName]
varName – имя переменной

someVar – значение переменной (в кавычках)
SESSION_USER - Частный случай использования условия IF

Описание : Вывод конфидиц. информации для залогин. пользователей.

Формат :

Пользователь залогинился

[IF do='SESSION_USER']

Поздравляю вы вошли в данный раздел и видите скрытую информацию



[ENDIF]
Пользователь не залогинился

[IF do='!SESSION_USER']

  1   2   3   4

Похожие:

Отображается в меню админской части в качестве ссылки на документ icon Инструкция по использованию сервиса Версия 2015. 10. 01
В правой верхней части Личного кабинета отображается строка, содержащая имя пользователя и наименование его организации, а также...
Отображается в меню админской части в качестве ссылки на документ icon Ответы на трудные вопросы будьте объективны опирайтесь на факты
Веб-панели Microsoft Word, выключите схему документа (разделение окна word на две части) если она появится при Ваших программных...
Отображается в меню админской части в качестве ссылки на документ icon Заключение
Этот документ предоставляется на условиях "как есть". Информация и взгляды, отображенные в данном документе, включая интернет-ссылки...
Отображается в меню админской части в качестве ссылки на документ icon Руководство пользователя. Часть II. Эксплуатация. 2003 г. Содержание...
Данный документ является руководством пользователя по арм тк. В нём описано применение пользовательского интерфейса и выполнение...
Отображается в меню админской части в качестве ссылки на документ icon Руководство по эксплуатации Рисунок 1
Значок приема отображается при приеме сигнала. Значок передачи отображается при передаче сигнала
Отображается в меню админской части в качестве ссылки на документ icon Инструкция по созданию выпадающего меню
Рассмотрим процесс создания подменю сайта на примере добавления подпункта «Помощь учителю в создании сайта в системе Ucoz» в пункт...
Отображается в меню админской части в качестве ссылки на документ icon 1. Регламентирующий документ при составлении меню: приказ мз СССР от 05. 93 г. №530
До момента раздачи первые и вторые блюда могут находиться на горячей плите не более (часов)
Отображается в меню админской части в качестве ссылки на документ icon Инструкция по выгрузке анкеты с мв-портала
На открытой странице в левой нижней части (в самом низу, 3-я меню снизу) «Печать анкеты»
Отображается в меню админской части в качестве ссылки на документ icon SharePoint Server 2013 Ознакомительное руководство для ит-специалистов
Корпорация Microsoft, 2012 г. Все права сохранены. Настоящий документ предоставляется на условиях «как есть». Сведения и идеи, изложенные...
Отображается в меню админской части в качестве ссылки на документ icon Руководство программиста системы управления разделом «электронная россия»
Таким образом, начальный функционал системы может быть расширен за счет написания соответствующих модулей. Настоящий документ предназначен...
Отображается в меню админской части в качестве ссылки на документ icon Справочник программ 14 Меню телевизора Меню настройки картинки изображения Нажмите кнопку «menu»
Нажмите кнопку выбора источника сигнала «source» для прокрутки вариантов выбора, представленных в меню выбора источника входящего...
Отображается в меню админской части в качестве ссылки на документ icon Руководство пользователя Оглавление
Для вызова контекстного меню формы используется правая кнопка мыши (при настройке мыши для левой руки – левая кнопка мыши). Контекстное...
Отображается в меню админской части в качестве ссылки на документ icon Инструкция 1 шт. Характеристика При движении на дисплее отображается...
При движении на дисплее отображается следующая информация: «running speed» (Скорость движения), «attention» (Внимание), «overspeed»...
Отображается в меню админской части в качестве ссылки на документ icon Инструкция по обновлению Государственный контракт № уфт-11/2016 от 10. 02. 2016
Платежного поручения любого платежного поручения внизу его содержимое отображается корректно пока не поставишь пользовательский фильтр...
Отображается в меню админской части в качестве ссылки на документ icon Руководство пользователя по эксплуатации подсистемы «федеральный...
«Региональные параметры» и нажать на кнопку «Настройка». Далее перейти на закладку «Дата». В качестве разделителя компонентов даты...
Отображается в меню админской части в качестве ссылки на документ icon Инструкция пользователю сайта конференции (участнику конференции),...
Сайт конференции включает в себя две части: информационную и регистрационную. Он состоит из нескольких страниц, переход на которые...

Руководство, инструкция по применению




При копировании материала укажите ссылку © 2024
контакты
rykovodstvo.ru
Поиск