Как описывать поле position в файле templateDetails.xml?

Question

[Евгений]

Доброго времени суток. Пишу шаблон для joomla (с самого нуля) и дошел я до файла templateDetails.xml и есть там такое поле как position. Что писать туда, как выделять эти самые position из шаблона?

Я уже понял, что файл templateDetails.xml связан с версткой, но как описывать - не понял. В интернете попадаются ответы коротко - "вот есть position, его надо заполнить". А как? Чем? - раскрывать не хотят. Или я не там смотрю

Знаю, что вопрос глупейший, но знающих, прошу ответом прикрепить кусок поля position и кусок кода html/php где эта position есть. С комментариями, без сокращений

Answer 1

[Александр]

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

Пример:

Если у вас в файле index.php установлено несколько позиций, например:

<jdoc:include type="modules" name="social-share" />
<jdoc:include type="modules" name="contacts" />
<jdoc:include type="modules" name="main-menu" />

То в файле templatesDetail.xml нужно заполнить тэг positions следующим образом:

<positions>
        <position>social-share</position>
        <position>contacts</position>
        <position>main-menu</position>
    </positions>

Comments

[Евгений]

Хорошо. Это я понял. Как будет выглядеть тогда главное меню в index.php вместе с позицией
<jdoc:include type="modules" name="main-menu" />

?

[Александр]

Евгений, не совсем понятен ваш вопрос. Можно сказать лишь как будет выглядеть позиция для главного меню в файле index.php. Она будет выглядеть именно так:
<jdoc:include type="modules" name="main-menu" />
А как будет выглядеть само главное меню будет зависеть от того, что вы установите в эту позицию с помощью панели управления сайтом.

И в случае с приведённым примером в файле templateDetails.xml нужно прописать

<positions>
        <position>main-menu</position>
здесь идёт перечисление других позиций
</positions>

[Александр]

Евгений, ещё вы написали, что файл templateDetails.xml связан с вёрсткой. Это неверно. Данный файл содержит вспомогательную информацию, такую как:
название шаблона
дата создания
автор
контакты автора
тип лицензии шаблона
версия шаблона
описание
папки и файлы шаблона
названия позиций для модулей
язык шаблона

[Евгений]

Александр, я вынес меню в отдельный файл и через "require" его подключаю в index.php
Вот, что содержит у меня файл menu.php

<jdoc:include type="modules" name="position-0" style="none" />
<div class="nav justify-content-center align-items-center">
  <ul class="nav nav-pills align-self-center">
    <li class="nav-item align-self-center">
      <a class="nav-link navbar-brand" href="index.php"><img class="logo" src="/templates/gcbs/img/bibl_logo.png"></a>
    </li>
  </ul>
</div>

И при включении отображении позиций шаблона (настройки-шаблоны-Просмотр позиций модулей
(вкл), добавляю после index.php "?tp=1"), я не вижу на странице пометки "position-0"
И как я понимаю, я тут делаю что-то не правильно

[Александр]

Евгений, я бы для начала вставил этот код напрямую в index.php и посмотрел будет ли отображаться пометка position-0.

[Евгений]

Александр, результат тот же, ничего не поменялось

[Александр]

Евгений, а если в templateDetails.xml написать:

<positions>
        <position>position-0</position>
</positions>

[Евгений]

Александр, есть там такая строчка, поэтому я уже перерыл инет, написал сюда, попутно ломаю голову, на тему "почему не отображается position-0?"

[Александр]

Евгений, понятно, в предпросмотре положений позиций модулей она не отображается. А сама позиция работает, если на неё какой-нибудь модуль повесить?

[Евгений]

Александр, как это проверить (подробнее)?

[Александр]

Евгений, панель управления сайтом -> расширения -> модули -> создать -> HTML-код -> пишите в редакторе "тестовый текст" -> в "позиция": выбираете position-0 или пишете position-0.
Проверяете, что модуль включен и стоит привязка ко всем страницам и сохраняете.

Если на сайте появится надпись "тестовый текст", то значит позиция работает и всё ок.

[Евгений]

Александр, нет, не появился html-блок

[Александр]

А эта часть кода из menu.php на сайте отображается?

<div class="nav justify-content-center align-items-center">
  <ul class="nav nav-pills align-self-center">
    <li class="nav-item align-self-center">
      <a class="nav-link navbar-brand" href="index.php"><img class="logo" src="/templates/gcbs/img/bibl_logo.png"></a>
    </li>
  </ul>
</div>

[Евгений]

Александр, отображается как положено

[Александр]

А можно глянуть index.php и на всякий случай на templateDetails?

[Евгений]

<spoiler title="index.php"><!DOCTYPE html>
<html lang="ru">
<head>
	<title>New gcbs</title>
	<?php require "SharedBlocks/head.php"?>
</head>
<body>
	<?php require "SharedBlocks/sudo-top.php"?>
	<?php require "SharedBlocks/menu.php"?>
	<?php require "SharedBlocks/top.php"?>
	<?php require "SharedBlocks/social-link.php"?>
	<h3>My content</h3>
	<?php require "SharedBlocks/footer.php"?>
</body>
</html></spoiler>

<spoiler title="templateDetails.xml"><?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 2.5//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.6/template-install.dtd">
<extension version="3.10" type="template" client="site">
	<name>GCBS</name>
	<creationDate>2022</creationDate>
	<author></author>
	<authorEmail></authorEmail>
	<authorUrl>None</authorUrl>
	<copyright> 2022. All Rights Reserved.</copyright>
	<license>GNU General Public License version 3 or later; see LICENSE.txt</license>
	<version>1.0</version>
	<description>TPL_GCBS_XML_DESCRIPTION</description>

	<files>
		<folder>css</folder>
		<folder>img</folder>
		<folder>js</folder>
		<folder>language</folder>
		<folder>MySliders</folder>
		<folder>Pages</folder>
		<folder>SharedBlocks</folder>
		<filename>component.php</filename>
		<filename>error.php</filename>
		<filename>favicon.ico</filename>
		<filename>Feedback.php</filename>
		<filename>index.html</filename>
		<filename>index.php</filename>
		<filename>template_preview.png</filename>
		<filename>template_thumbnail.png</filename>
		<filename>templateDetails.xml</filename>
	</files>

	<positions>
      <position>position-200</position>
    </positions>

	<languages folder="language">
		<language tag="en-GB">en-GB/en-GB.tpl_GCBS.ini</language>
		<language tag="en-GB">en-GB/en-GB.tpl_GCBS.sys.ini</language>
	</languages>
</extension></spoiler>

Уже начал экспериментировать - переписал на position-200 - может ему не нравился номер, но оказывается, что номер не играет значения. Главное, чтобы он не повторялся внутри шаблона

[Александр]

Евгений, у вас какие-нибудь ещё позиции для модулей есть, кроме position-200?

[Евгений]

Александр, в дальнейшем - будут, но хотелось бы пока разобраться на одной позиции. А так, сверху вниз, до социальный сетей (social-link.php) включительно - будут иметь пометки "position-N"

[Александр]

Евгений, по ходу начинаю догадываться. Можно глянуть head.php ?

[Евгений]

Александр, из-за чего такие траблы?

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="/templates/gcbs/css/bootstrap.min.css">
<link rel="stylesheet" href="/templates/gcbs/css/owl.carousel.min.css">
<link rel="stylesheet" href="/templates/gcbs/css/owl.theme.default.min.css">
<script src="/templates/gcbs/js/jquery.slim.min.js"></script>
<script src="/templates/gcbs/js/popper.js"></script>
<script src="/templates/gcbs/js/bootstrap.min.js"></script>
<script src="/templates/gcbs/js/owl.carousel.min.js"></script>    
<link rel="stylesheet" href="/templates/gcbs/css/MyStyle.css">
<script src="/templates/gcbs/js/custom.js"></script>

[Александр]

Евгений, так у вас шаблон отдельно, а джумла отдельно. Они вообще никак не связаны.

Вот к примеру как выглядит начальная часть index.php типичного шаблона Joomla (где происходит вся интергация и подключения):

<?php
defined('_JEXEC') or die;
$app = JFactory::getApplication();
$doc = JFactory::getDocument();
$menu = $app->getMenu();
$lang = JFactory::getLanguage();

$template_url = $this->baseurl . '/templates/' . $this->template;
$doc->addStyleSheet($template_url . '/css/v100.css');

$is_home_page = $menu->getActive() == $menu->getDefault($lang->getTag());
?>

<!doctype html>
<html>
<head>
   <jdoc:include type="head"/>

    <meta http-equiv="X-UA-Compatible" content="IE=Edge">
    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
</head>


<body>
    тут должен быть html
</body>

</html>

Обратите внимание, что здесь содержимое head подключается из джумлы, а вы прописываете всё вручную. И это только один пример.

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

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

[Евгений]

Александр, то есть, если я добавлю код, который идёт до определения html и всё пойдёт?

Answer 2

[exmmth]

Александр, ответ правильны, но вы человека Евгений невероятно запутываете дальше в комментариях)
Вот для примера https://master3.alekvolsk.info/ шаблон-болванка, там можно посмотреть и отследить как устроен шаблон joomla. Или если у вас joomla 3 смотрите стандарный шаблон protostar, если joomla 4 то cassiopeia.
Если вам надо меню как примитив(набор html) без редактирования в админке, можно просто в index.php шаблона добавить этот код в нужном месте.
Если вы хотите чтобы меню можно было редактировать через админку в пунктах меню. То нужно использовать тип модуля для меню (Панель меню --> Расширения --> Модули) у него выбрать position, этот position через код в index.php в нужно месте конструкцией:

<?php if ($this->countModules('my-menu')) { ?>
            <jdoc:include type="modules" name="my-menu"/>
<?php } ?>

сам код, как именно будет формироваться меню можно посмотреть в папке modules/mod_menu/tmpl/ но лучше использовать стандартные переопределения в папке вашего шаблона templates/my_templates/html/mod_menu/
для примера переопределений: https://github.com/master3-blank-template/Master3/...
Думаю исчерпывающе ответил на ваш вопрос как это всё устроено, если что-то нужно уточнить, спрашивайте!)
Приходите в чате в телеге по https://t.me/joomlaru там вам оперативно помогут разобраться.

Comments

[Евгений]

Если вы хотите чтобы меню можно было редактировать через админку в пунктах меню. То нужно использовать тип модуля для меню (Панель меню --> Расширения --> Модули) у него выбрать position, этот position через код в index.php в нужно месте конструкцией

А если я уже накидал пункты меню и хочу их завести (чтобы они виделись, работали, редактировались) в joomle (балуюсь на версии 3.10.4) + чтобы это меню можно было расширять, а не как на скрине два отдельных друг от друга меню

скрин меню

Меню созданное через позицию - верхнее (один пункт "Home"), а нижнее забито через html, с применением bootstrap 4.6.1

P. S. Как я понимаю, придется все слайдеры, и остальные части, что я колотил ранее, создавать с нуль через позиции. Или я ошибаюсь?

[exmmth]

Евгений, вывод меню через модули с переопределением шаблона как раз и позволят свою верстку держать. то что в рамках ul>li>a. Обрамление внешние родительские div я держу в шаблоне, но можно тоже в шаблон модуля добавить.
Для слайдеров есть готовые модули https://extensions.joomla.org/instant-search/?jed_... или в чате в телеге можно спросить. Если у вас своя верстка и тоже подразумевается редактирование в админке, то через переопределения шаблона в зависимости от компонента тоже всё делается не так уж и сложно.

[Евгений]

exmmth, что за администрация на канале joomlaru? Не ответил в ту же секунду на их сообщение (не написал своё имя), как они тут же банят, думают, что бот. Не могли бы вы со своей стороны попросить меня достать из бана?

[exmmth]

Евгений, Можно без проблем, какой ник?)

[Евгений]

exmmth, напишите мне на почту [e-mail]

[exmmth]

Евгений, что написать?) напишите мне проще в телегу https://t.me/exmmth, раз секретность нужна.