База знаний Heroic – Использование системы шаблонов

Опубликовано: 2016-01-11

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

Примечание. В этой статье предполагается, что вы знаете, как устанавливать WordPress, плагины, и у вас есть некоторые знания в области разработки тем, включая родительские и дочерние темы, HTML, CSS и базовое понимание PHP.

Героическая база знаний

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

Как и большинство плагинов WordPress, первоначальная установка не может быть проще. Просто загрузите плагин в каталог плагинов через панель инструментов и активируйте его. Плагин базы знаний легко интегрируется с большинством хорошо закодированных тем, поэтому не имеет значения, используете ли вы полностью сделанную на заказ тему, один из наших премиальных продуктов HeroThemes или тему по умолчанию для WordPress. У вас будет полнофункциональная база знаний, интегрированная в ваш веб-сайт WordPress за считанные минуты с минимальными хлопотами.

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

Я дам краткий обзор:

  • Установка плагина, общие настройки и добавление контента
  • Базовая интеграция с новой темой TwentySixteen, доступной в WordPress 4.4.
  • Расширенная интеграция: изменение шаблонов для дальнейшей настройки

Начиная

После первоначальной установки WordPress убедитесь, что у вас установлены и активированы как тема TwentySixteen, так и плагин базы знаний.

TwentySixteen — это новая тема по умолчанию, которая поставляется с WordPress 4.4. Если после обновления установки WordPress у вас нет новой темы, указанной в разделе « Внешний вид» > «Темы» , вы можете загрузить ее со страницы темы TwentySixteen на WordPress.org.

Плагин базы знаний

Как и сам WordPress, настроить плагин базы знаний очень просто. После активации плагина вы автоматически попадаете на экран «Начало работы», который содержит несколько основных советов, которые помогут вам начать работу. В меню слева от приборной панели также есть новый пункт под названием «База знаний».

База знаний работает так же, как стандартный тип записи «запись», который использует WordPress. Статьи могут быть организованы по категориям, а также по тегам. Категории могут быть добавлены или удалены в любое время, как и сообщения, однако, чтобы ваша база знаний была максимально полезной, рекомендуется спланировать структуру категорий, прежде чем вы начнете создавать контент.

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

kb-blog1-настройки

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

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

Создание контента

Прежде чем вы сможете приступить к расширенным настройкам нашей базы знаний, вам понадобится некоторый контент. Поэтому первое, что вам нужно сделать, это создать несколько статей. С установленной темой TwentySixteen ваш экран добавления нового

kb-blog1-добавить-новый-экран
kb-blog1-добавить-новые-параметры

Это должно выглядеть очень знакомо, если вы когда-либо использовали WordPress раньше. Заголовок поста, содержание, публикация, форматы постов, поля категорий и тегов одинаковы. На самом деле единственные области, которые отличаются, — это параметры статьи и параметры голосования.

В качестве альтернативы вы можете установить содержимое по умолчанию с экрана начала работы во время начала работы.

Интеграция с TwentySixteen

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

Но… что, если вы хотите сделать больше?

Что действительно приятно в плагине для разработчиков тем, так это система шаблонов.

Система шаблонов работает путем копирования файлов шаблонов, которые вы хотите изменить, из плагина в папку вашей темы. Затем WordPress сначала смотрит на вашу тему. Если в вашей теме есть соответствующий файл шаблона, он будет использоваться. Если нет, вместо этого будет использоваться запасной шаблон в папке плагина, чтобы перехватить функцию the_content() и вставить содержимое базы знаний в ваш стандартный page.php .

Иерархия шаблонов в плагине или в теме работает очень похоже на стандартную иерархию шаблонов WordPress, что упрощает понимание.

Например hkb-taxonomy-category.php hkb-archive.php почти так же, как category-$slug.php переопределит стандартный archive.php .

kb-blog1-template-heirachy
Шаблоны заказов используются в зависимости от отображаемого контента и от того, существуют ли они в вашей теме. Например, при просмотре категории будет использоваться hkb-taxonomy-category.php , если файл существует, в противном случае будет использоваться hkb-archive.php .

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

Настройка шаблонов

По умолчанию раздел базы знаний будет выглядеть так при использовании темы TwentySixteen:

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

Это нормально, TwentySixteen — очень красиво оформленная тема для мобильных устройств. Однако из-за макета шаблонов страниц страницы базы знаний имеют много мертвого пространства по сравнению с другими страницами веб-сайта:

Та же страница содержимого базы знаний по сравнению со стандартной записью в блоге
Та же страница содержимого базы знаний по сравнению со стандартной записью в блоге

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

Прежде чем вы доберетесь до этого, вам нужно будет создать дочернюю тему для TwentySixteen, чтобы ни одно из ваших изменений не было потеряно при выпуске обновлений темы. Я назвал свою папку двадцать шестнадцать детей . Более подробную информацию о дочерних темах можно найти в нашей статье о дочерних темах.

После того, как вы настроили дочернюю тему, вы можете приступить к редактированию шаблонов. Создайте новую папку внутри папки с двадцатью шестнадцатью детьми и назовите ее hkb-templates . Затем скопируйте шаблон, который вы хотите отредактировать, из папки плагина в только что созданную папку шаблона.

Чтобы изменить страницу архива базы знаний, вам нужно отредактировать hkb-archive.php . После копирования откройте его в редакторе кода. Тебе следует увидеть:


<?php /** * Theme template for archive display */ ?>

<?php get_header(); ?>

<?php hkb_get_template_part('hkb-compat', 'archive'); ?>

<?php get_footer(); ?>

Примечание. Поскольку шаблоны в плагине внедряют содержимое базы знаний на страницу с помощью функции WordPress the_content() , полная структура страницы изначально не включается в шаблон. Поскольку вы переопределяете шаблон по умолчанию, вам потребуется добавить на страницу дополнительный HTML-код.

Поэтому код в hkb-archive.php следует изменить, чтобы он выглядел примерно так:

<?php /** * Theme template for archive display */ ?>
<?php get_header(); ?>

<div id="primary" class="content-area">
<main id="main" class="site-main" role="main">
<?php // Include the page content template. hkb_get_template_part('hkb-compat', 'archive'); ?>
</main><!-- .site-main -->

<?php get_sidebar( 'content-bottom' ); ?>
</div>

<!-- .content-area -->

<?php get_sidebar(); ?><?php get_footer(); ?>

Примечание. Нет необходимости включать цикл while в этот шаблон.

kb-blog1-база знаний-неформат

Сохраните файл и просмотрите страницу. Теперь это должно выглядеть примерно так:

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

Это связано с тем, что как только вы начинаете настраивать тему, плагин предполагает, что вы хотите иметь свободу писать свои собственные стили, и поэтому не загружает таблицу стилей. Это действительно полезно, когда вы создаете совершенно индивидуальные темы, однако, если вы хотите сохранить существующие стили, вы можете скопировать и вставить стили из hkb-style.css в style.css в вашей дочерней теме. Или, если вы создаете специальную тему, вы можете скопировать таблицу стилей из папки плагина в папку вашей темы, а затем поставить ее в очередь в файле functions.php , используя следующие строки кода:


// Knowledge Base plugin styles
wp_enqueue_style( 'hkb-style', get_template_directory_uri() . '/css/hkb-style.css', array( 'twentysixteen-style' ), '20151217' );

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

Если вы создаете специальную тему, а не модифицируете существующую с помощью дочерней темы, то я лично предпочитаю хранить таблицы стилей отдельно и использовать метод enqueue для правильного внедрения стилей в тему. Это связано с тем, что style.css часто может стать очень большим и трудным для быстрого управления, хранение соответствующих стилей отдельно упрощает их поиск, если вам нужно отредактировать их дальше. Ту же организацию можно использовать, если вы используете препроцессор, такой как SASS, поскольку тогда вы можете @import свою новую таблицу стилей, чтобы она автоматически объединялась в style.css , который затем можно было внедрить в вашу тему с помощью wp_enqueue_style() .

После повторного применения стилей снова просмотрите страницу, и теперь вы должны увидеть:

kb-blog1-база знаний в формате

Теперь страница была переформатирована, а мертвое пространство слева удалено, благодаря чему все выглядит намного опрятнее без потери стиля и дизайна темы. Если есть какие-либо другие шаблоны страниц, к которым вы хотите применить это изменение макета, просто скопируйте соответствующие шаблоны в свою дочернюю тему, и все готово!

Последние мысли

Надеюсь, я продемонстрировал, насколько настраиваемым является плагин Heroic Knowledge Base. Вы можете сделать многое из коробки, не зная кода, однако, если вы хотите настроить что-то дальше и у вас есть понимание стандартов кода WordPress и разработки тем, вы можете сделать это очень легко.