Модуль документации и справки

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

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

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

Следующие предложения упорядочены по простоте использования.

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

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

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

Вам, как и мне, не нужно ничего знать о «разработке» или программировании, чтобы поделиться тем, что вы «знаете», и учились.

Методом проб и ошибок

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

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

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

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

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

Содержание страницы проекта

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

Если вы внимательно прочитаете страницу проекта в полном объеме, вы можете быть относительно уверены, что у вас есть вся самая важная информация, которая вам нужна. Например, при рассмотрении вопроса о том, стоит ли опробовать модуль, если для работы модуля требуются какие-либо другие модули, эти другие модули будут перечислены где-то на странице проекта.

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

Содержимое страницы проекта может быть предназначено для новых пользователей Drupal или может быть ориентировано на более продвинутых пользователей / разработчиков.

Ссылка на страницу проекта «Читать документацию» (если есть)

В правом столбце (столбец, который опускается до нижней части страницы на мобильных устройствах или внутри других узких окон браузера) вы всегда найдете заголовок «Ресурсы», под которым вы можете или не можете найти ссылку "Читать документацию".

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

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

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

Другие участники drupal.org, не имеющие доступа к изменению страницы проекта, тем не менее, очень часто создают другие страницы d.o с отличной информацией о модуле, о котором вы хотите знать. К сожалению, однако, эти другие страницы очень редко будут иметь ссылки на них на странице проекта.

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

Файл модуля "README.txt"

Файл «README.txt» исторически был официальным местом, где документирована вся действительно важная и необходимая информация для модуля (или темы), включая все, что имеет отношение к обновлению модуля (или темы) до более новой версии.

Файл README.txt находится в папке верхнего уровня модуля contrib (или темы) после его извлечения, если он существует.

Чтобы просмотреть файл README.txt модуля (или темы), не загружая ничего, перейдите по ссылке:

http://cgit.drupalcode.org/project/PROJECT_MACHINE_NAME.git/blob/HEAD:/README.txt

Замените выражение PROJECT_MACHINE_NAME в приведенном выше URL-адресе на короткое «имя машины» конкретного проекта.

«Имя машины» находится в URL-адресе адресной строки вашего браузера, когда вы находитесь на любой странице проекта drupal.org, как, например, часть «PROJECT_MACHINE_NAME» в этом примере URL-адреса - URL, аналогичный URL-адресу для каждого проекта:

https://www.drupal.org/project/PROJECT_MACHINE_NAME

Если файл README.txt не существует, то, вероятно, это модуль, для которого нет настраиваемых параметров, и он просто является модулем, который работает в фоновом режиме и необходим для работы других модулей contrib.

Если файла README.txt нет или вы просто хотите просмотреть всю остальную документацию для проекта, используйте следующий URL-адрес (замените «PROJECT_MACHINE_NAME»):

http://cgit.drupalcode.org/PROJECT_MACHINE_NAME/tree/?id=HEAD

В верхнем правом углу этой страницы «drupalcode.org» вам, возможно, придется «переключиться» на версию ядра Drupal, которую вы хотите изучить.

Поиск в Google ограничен drupal.org

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

Я захожу на google.com ⎘ и набираю:

site:drupal.org

Обратите внимание, что после двоеточия (":") перед именем домена нет пробела. И не используйте «www.» в начале любого доменного имени.

Добавьте «пробел» после имени домена и введите ключевые слова, которые вы можете придумать, а именно, для нашего сегодняшнего обсуждения, имя модуля.

Иногда я также находил полезным попытаться ограничить поиск Google специально для «Drupal 8» (вместо того, чтобы также получать результаты для D6, D7 ...), добавив «Drupal 8» в поле текстовой области поисковой системы Google. , Используя двойные кавычки, Google затем возвращает результаты поиска для страниц, которые содержат точное выражение из двух или более слов в двойных кавычках. (...главным образом.)

Чтобы увидеть, какая информация доступна для конкретного модуля по всей Земле, включая страницы как внутри, так и за пределами drupal.org, опустите site:drupal.org.

Чтобы получить 100 результатов поиска Google на странице, вместо 10, когда вы находитесь на любой странице результатов поиска Google, щелкните значок «шестеренка» в правом верхнем углу и в раскрывающемся меню нажмите «Настройки поиска». На следующей странице под заголовком «Мгновенные прогнозы Google» установите переключатель «Никогда не показывать мгновенные результаты». Затем под заголовком «Результаты на страницу» перетащите ползунок полностью вправо. Ваши поиски теперь будут занимать дополнительные три тысячи долей секунды или что-то в этом роде.

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

Кнопки / ссылки «Справка» на странице «Расширить» вашего сайта (если есть)

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

Если вы нажмете на эту первую строку описания, оно развернется вниз и раскроет остальную часть его описания, а также откроет кнопки / ссылки «Справка», «Разрешения» и «Настроить» для этого модуля, когда те предметы доступны.

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

К сожалению, чтобы получить доступ к странице справки на вашем сайте для модуля, вы не только должны импортировать модуль на свой сайт, но кнопка/ссылка «Справка» будет видна, только если этот модуль включен. И, к сожалению, не у всех модулей contrib или core есть кнопка/ссылка «Помощь», у вас не будет возможности узнать, доступна ли она, если вы сначала не включите модуль.

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