Шаблоны Портала Поддержки

Последнее изменение:

В этой статье мы объясним, для чего используется каждый шаблон.

Для создания шаблонов можно использовать контекст, теги и фильтры шаблонов.

Контекст

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

  • portal
    • page - текущая страница, открытая пользователем (главная, категория, список, элемент, новый, вход, пользователь, public_user, поиск, ошибка, таблица лидеров, виджет)
    • view - текущий вид для выбранной страницы (портал, база знаний, сообщество, служба поддержки, виджет)
    • section - текущий раздел для выбранного вида. Смотрите значения на определенных страницах, если они доступны.
    • user - текущий пользователь.
    • language_code - код языка интерфейса.
    • current_relative_url - относительный URL для открытой страницы.
    • current_absolute_ur- абсолютный URL для открытой страницы.
    • page_no - номер страницы, выбранной в пагинаторе, если существует.
    • name - имя портала.
    • knowledgebase_forums - форумы базы знаний, доступные на портале.
    • comunity_forums - форумы сообщества, доступные на портале.
    • helpdesk_forums - форумы хелпдеск, доступные на портале.
    • knowledgebase_enabled - True, если база знаний включена на портале.
    • community_enabled - True, если сообщество включено на портале.
    • helpdesk_enabled - True, если хелпдеск включен на портале.
    • chat_enabled - True, если чат включен на портале.
    • params - параметры, специфичные для темы, такие как логотипы, тексты, конфигурации и т. д. Будут описаны позже.
  • meta
    • page_title - заголовок страницы.
    • page_description - описание страницы.
    • search_term - поисковые термины, если есть.

UserEcho поддерживает порталы, состоящие из страниц. Каждая страница генерируется с использованием некоторых шаблонов. Мы можем разделить все шаблоны на три группы: структура, содержимое страниц, дополнительный пользовательский шаблон.

    Структура

    Шаблоны структуры определяют структуру страниц вашего портала и используются практически на всех страницах.

    Portal Layout

    Общий макет страницы вашего портала поддержки. Он определяет основную структуру, такую ​​как заголовок, нижний колонтитул, содержимое для всех страниц. Он имеет переменную {{ CONTENT }}, которая содержит информацию для определенной открытой страницы, сгенерированной из определенного шаблона содержимого.


    Дополнительный контекст: 

    • CONTENT - данные, отображаемые в шаблоне страницы для добавления в макет портала.

    HEAD Section

    Используется для добавления информации в <HEAD> раздел вашей страницы. Обычно он включает метаданные, заголовок, сторонние загруженные шрифты и т. д.

    SCRIPT Section

    Используется для добавления любого кода прямо перед . Обычно он используется для добавления JavaScript на ваши страницы. Не забудьте обернуть свой код в тег ..., если вы добавляете JavaScript.

    По умолчанию JQuery доступен на вашем портале, поэтому вы можете использовать синтаксис JQuery. Также, если вы хотите убедиться, что ваш код будет запущен после загрузки страницы и инициализации всех переменных UserEcho, вы можете использовать:

    <script>
    initqueue.push(function(){
        # здесь ваш код
    })
</script>

    Pages Content

    Шаблоны контента страниц используются для отображения контента для определенной страницы, посещенной пользователями. После отображения шаблона контента страницы он доступен в шаблонах макета портала как {{ CONTENT }}.

    Portal Home Page

    Главная страница вашего портала.


    Ссылка: /

    Login Page

    Страница для входа, регистрации, сброса пароля и т. д.

    Дополнительный контекст:

    • portal.section - конкретная страница, открытая пользователем. Может иметь следующие значения:
      • login (/user/login)
      • login_openid (/user/login/openid)
      • password_reset (/user/password/reset)
      • password_reset_done (/user/password/reset/done)
      • signup (/user/signup)

    Error Page

    Шаблон для генерации сообщения об ошибке для пользователей.

    Дополнительный контекст:

    • error_code - код произошедшей ошибки. Может иметь значения: 
      • access_denied - у пользователя нет доступа к странице.
      • page_not_found - страница не найдена.


    User Page

    Страница настроек пользователя (собственный профиль).

    Дополнительный контекст:

    • portal.section - конкретная страница, открытая пользователем. Может иметь следующие значения:
      • settings(/user/settings)
      • notifications (/user/notifications)
      • password_change(/user/password_change)
      • tickets (/user/tickets)
      • topics (/user/topics)
      • voted_topics (/user/voted_topics)
      • updates (/user/updates)

    Search Results Page

    Страница для отображения результатов поиска.

    Дополнительный контекст:

    • search
      • results
        • forum_type - тип форума (база знаний, сообщество, служба поддержки).
        • item_list - список результатов для типа форума.
        • item_count - количество результатов в списке.
        • active - True, если тип активен (на странице 3 типа результатов и только один активен в данный момент).
        • url - URL для активации типа.
      • item_count -общее количество элементов для всех типов форумов.
      • forum_type__item_count - количество типов форумов.
      • forum_type__nonzero_item_count - количество типов форумов с некоторыми доступными результатами.
    • helpdesk_forum - форум службы поддержки для поиска (помогает добавить кнопку для отправки нового тикета).
    • community_forum - форум сообщества для поиска (помогает добавить кнопку для отправки новой темы).


    Ссылка: /search

    Search Results Popup

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

    Дополнительный контекст: 

    тот же контекст, что и страница результатов поиска, плюс:

    • search_mode - режим поиска.
      • search - когда это всплывающее окно для поля поиска.
      • suggestion - когда это всплывающее окно для предложения пользователю похожих тем в новой теме или форме тикета.

    Knowledge Base Home Page

    Шаблон для отображения домашней страницы базы знаний.


    Ссылка: /knowledge-bases/[id]-[slug] (/knowledge-bases/10-knowledge-base)

    Дополнительный контекст:

    • forum - выбранный форум базы знаний.

    Knowledge Base Category Page

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


    Ссылка: /knowledge-bases/[id]-[slug]/categories/[id]-[slug] (/knowledge-bases/10-knowledge-base/categories/984-getting-started)

    Дополнительный контекст:

    • forum - выбранный форум базы знаний.
    • category - выбранная категория базы знаний.

    Knowledge Base Article List Page

    Шаблон для отображения страницы со списком статей базы знаний. Отображает список статей с фильтрами.


    Ссылка: /knowledge-bases/[id]-[slug]/categories/[id]-[slug]/articles (/knowledge-bases/10-knowledge-base/categories/984-getting-started/articles)

    Дополнительный контекст:

    • forum - выбранный форум базы знаний.
    • category - выбранная категория базы знаний.
    • forum_or_category - выбранная категория базы знаний (если выбрана) или форум.

    Knowledge Base Article Page

    Шаблон страницы статьи базы знаний для отображения конкретной статьи.


    Ссылка: /knowledge-bases/[id]/articles/[id]-[slug] (/knowledge-bases/10/articles/555-example-article)

    Дополнительный контекст:

    • article - выбранная статья.


    Community Home Page

    Шаблон для отображения домашней страницы сообщества.


    Ссылка: /communities/[id]-[slug] (/communities/1-general)

    Дополнительный контекст:

    • forum - выбранный форум сообщества.

    Community Category Page

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


    Ссылка: /communities/[id]-[slug]/categories/[id]-[slug] (/communities/1-general/categories/33-general-questions)

    Дополнительный контекст:

    • forum - выбранный форум сообщества.
    • category - выбранная категория сообщества.

    Community Topic List Page

    Шаблон для отображения страницы списка тем сообщества. Отображает список тем с фильтрами.

    Дополнительный контекст:

    • forum - выбранный форум сообщества.
    • category - выбранная категория сообщества.
    • forum_or_category - выбранная категория сообщества (если выбрана) или форум.

    Community Topic Page

    Шаблон для отображения определенной статьи.


    Ссылка: /communities/[id]/topics/[id]-[slug] (/communities/1/topics/444-example-topic)

    Дополнительный контекст:

    • topic - выбранная тема.

    Community Topic Form Page

    Шаблон для создания новой страницы темы.


    Ссылка: /communities/[id]-[slug]/topics/new (/communities/1-general/topics/new)

    Дополнительный контекст:

    • forum - выбранный форум сообщества.
    • form_mode - режим формы для отображения: новый или редактирование.

    Helpdesk Ticket Page

    Шаблон для отображения определенного тикета.


    Ссылка: /helpdesks/[id]/tickets/[id]-[slug] (/helpdesks/1/tickets/444-example-ticket)

    Дополнительный контекст:

    • ticket- выбранный тикет.

    Helpdesk Ticket Form Page

    Шаблон для создания новой страницы тикета.


    Ссылка: /helpdesks/[id]/tickets/new (/helpdesks/3/tickets/new)

    Дополнительный контекст:

    • forum - выбранный хелпдеск форум.
    • form_mode - режим формы для отображения: новый или редактирование.

    Leaderboard Page

    Шаблон для отображения страницы таблицы лидеров для сообществ.


    Ссылка: /leaderboard

    Public User Page

    Страница для публичных профилей пользователей, если они разрешены на вашем портале.

    Дополнительный контекст:

    • portal.section - конкретная страница, открытая пользователем. Может иметь следующие значения:
      • profile(/users/[id]-{slug])
      • topics (/users/[id]-{slug]/topics)
    Эта статья была полезна для 9 людей. Эта статья помогла вам?
    Как восстановить забытый пароль в UserEcho?
    Теги и Фильтры Шаблонов Портала Поддержки
    Портал поддержки клиентов работает на UserEcho