[FAQ] Что такое МОДы и как установить МОД

[Палыч]

Что такое МОД
МОД - модификация вашей конференции phpBB, которая добавляет функциональность, изначально отсутствующую в стандарной комплектации phpBB (например, возможность Быстрого ответа). Как правило, МОД представляет собой архивный файл, включающий в себя набор файлов кода php, набор файлов-шаблонов стиля, инструкцию по установке, набор изображений.

Где искать МОДы
В интернете, конечно. Их достаточно много на http://www.phpbb.com , http://www.phpbbhacks.com , http://www.sourceforge.net и сайтах авторов МОДов. На нашей конференции в разделе МОДЫ вы также сможете найти некоторые из них (пока только для версии phpBB2).

Как установить МОД
1. Найти актуальную версию интересующего вас МОДа. Обязательно заглянуть на сайт автора МОДа для проверки наличия новейших (более поздних) версий МОДа.
2. Скачать файл-архив с МОДом.
3. Разархивировать файл в отдельную папку. Мы рекомендуем делать это на вашем локальном компьютере.

Дальше есть небольшие различия в МОДах для phpBB2 и phpBB3.

Для phpBB2:
Находите в корневой директории распакованного архива файл install.txt, или readme.txt, или имя_мода_возможно_номер_версии.txt_возможно_.mod, так же загляните в каталог /docs в архиве мода. Этот файл и есть инструкция по установке МОДа. Открываете его в любом текстовом редакторе, в таком, который не ломает кодировку и не ломает переносы строк и табуляцию. Вы можете почитать, какие текстовые редакторы для php предпочитают использовать пользователи нашей конференции в этой теме - topic6910.html

Для phpBB3:
После распаковки архива вы должны увидеть папку, в которой по крайней мере 3 файла:
- *.XML (например, index.xml)
- *.XSL (скорее всего modx.prosilver.en.xsl или modx.subsilver.en.xsl)
- файл лицензии GPL (обычно license.txt)
XML (eXtensible Markup Language) файл содержит инструкцию по установке, однако, его синтаксис, как правило, не предназначен для человеческого чтения. Однако, XSL (eXtensible Stylesheet Language), помогает сделать XML файл таким, чтобы при просмотре XML-файла в браузере, он выглядел как обычные веб-страницы. Практически все браузеры поддерживают язык XML. Поэтому, для того чтобы прочитать файл, просто дважды щелкните мышкой на его названии и он должен автоматически загрузиться в ваш веб-браузер. Не забывайте, что открывать файл вы должны в той же папке, в которую разархивировали МОД.
После открытия XML-файла в веб-браузере, вы должны иметь возможность видеть инструкцию по установке как текстовую веб-страницу.
В верхнем правом углу есть меню выбора языка, что позволяет изменить язык файла. В настоящее время есть уже 19 языков, доступных для использования. По умолчанию инструкции пишутся с использованием английского интерфейса.
Если Вы изменяете язык интерфейса MODX, может быть вам потребуется разрешить JavaScript. Если Ваш браузер не поддерживает этот вариант, и вы не можете изменить язык интерфейса MODX, попробуйте открыть файл с помощью других браузеров, например IE или Firefox.

4. Внимательно прочтите инструкцию.
Инструкция состоит их 2 основных разделов, общая информация о МОДЕ и фактическое руководство: перечень того, что вы должны сделать, чтобы установить МОД на своем форуме phpBB.

В первом разделе вы увидите:
- Название МОДА, описание, версию, оценку сложности и времени для завершения установки.
- Автор: Здесь вы увидите автора(ов) этого МОДА. Его/ее адрес электронной почты, личные веб-страницы и реальное имя.
- Файлы для изменения и включенные Файлы: Список файлов, которые вам придется редактировать. Указанные имена файлов включают полный путь до файла(ов). Таким образом, вы будете знать, где найти конкретный файл(ы) для редактирования.
- Примечания: Авторы иногда считают необходимым включить дополнительную информацию об их МОДах. Это всегда полезно прочитать перед установкой.
- История МОДа: Вы можете проследить историю развития МОДа, прочитав этот раздел инструкции.
- Лицензия и другие Примечания: Большинство МОДов сделаны под GPL лицензией. Если у вас есть сомнения по поводу этого, обратитесь к автору.
- Напоминание вам, что необходимо сделать резервную копию ваших файлов, прежде чем делать любые изменения в коде phpBB. Вы должны также создать резервные копии базы данных (или связанных таблиц), если МОД требует изменений в вашей базе данных. В случае возникновения каких-либо ошибок при установке, вы можете восстановить резервные файлы/базу данных. Не забывайте делать это!
- Уведомление о версии phpBB, с которой совместим МОД.

Здесь вы можете посмотреть пример (шаблон) инструкции МОДа для phpBB2 - http://phpbbguru.net/docs/?id=8

5. Внимательно и чётко выполнить инструкцию.
Второй раздел - и есть сама инструкция по установке, состоящая из последовательности действий, которые необходимо выполнить. Достаточно подробно все действия расписаны в статье Краткое руководство по установке модов.

Некоторые заключительные замечания.

При установке МОДа вам, как правило, необходимо сделать три вещи:

- 1. Внести изменения в вашу базу данных (требуется не всегда). В инструкции это секция [SQL]. Действие [ SQL ] описыватся запросы к БД, котрорые необходимо выполнить при установке МОДа. Если Вы указали при установке phpBB префикс отличный от используемого по умолчанию, вы должны заменить этот префикс на свой. Для выполнения SQL-запросов Вы можете воспользоваться любым менеджером работы с БД (например, phpMyAdmin). Часто в архиве с модом идет php-файл (обычно db_update.php), который сам внесет необходимые изменения в БД. Обычно его необходимо поместить в корневой каталог вашего форума и обратиться к нему через браузер, при этом часто требуется, чтобы вы были залогинены на конференции в качестве администратора. Ещё такой файл можно сгенерировать самому. Для этого можно воспользоваться генератором, который можно найти здесь - http://www.phpbbsmith.com/generate-db.html Не забывайте, что генератор для phpBB2 и phpBB3 отличаются. Вставьте SQL-запросы из инструкции в окно генератора, нажмите Сгенерировать и скачайте получившейся файл.

- 2. Добавить к имеющимся файлам форума те файлы, которые имеются в архиве (секция [COPY]) (требуется не всегда). Не забывайте соблюдать структуру папок при копировании. Учтите, что частенько FTP-клиенты искажают регистр символов в названии файлов и папок при копировании, а это важно.

- 3. Отредактировать файлы кода вашей конференции (требуется не всегда). Учтите, что использовать следует редактор, который не добавляет отсебятины. Кроме того, для версии phpBB3 важно сохранение файлов в кодировке UTF-8 без BOM (загляните в FAQ-3). В процессе редактирования вы последовательно выполняете действия [FIND] - найти и [ADD] - добавить или [REPLACE] - заменить. Добавление кода производится с новой строки. Замена - точно вместо найденного фрагмента.
Учтите, что для поиска может быть задана и вся строка кода, и любая её часть (начало, середина, конец). В заданном для поиска фрагменте кода важны все символы, в том числе и пробелы и символы табуляции. Если два или более действий [FIND] следует один за другим, то их так и следует выполнять: каждое последующее действие с того места в файле, на котором вы остановились после выполнения первого. Так иногда бывает в инструкции для облегчения поиска. Например, нужно отредактировать одну конкретную строку, которая встречается в файле несколько раз. Тогда для поиска указывается какой-либо уникальный фрагмент, находящийся чуть выше искомой строки. И следующее действие [FIND] укажет вам уже именно нужную строку.
Не путайте аргументы операций [AFTER] - после и [BEFORE] - перед, это распространённая ошибка. Например, [ADD AFTER] - добавить после найденного. Если присутствует аргумент [IN-LINE], то действия осуществляются со строкой, а не со всем содержимым файла. То есть [IN-LINE ADD] означает добавить в строке после найденного (не с новой строки!).
Также следует учесть, что инструкции пишуться на стандартные стили (subSilver для phpBB2 и prosilver и subsilver2 для phpBB3). Поэтому, если вы используете другие стили, то следует отредактировать и соответствующие файлы данных стилей, ориентируясь по инструкции и здравому смыслу. Тоже самое относится и к языковым файлам (lang-файлам). Инструкции, как правило, написаны для английского языка, следовательно вам потребуется редактирование аналогичных файлов используемого вами языка (скорее всего, русского). Необходимые инструкции вы скорее всего сможете найти в разделе Локализация МОДов на нашей конференции.
Мы рекомендуем скачивать файлы с сервера, редактировать их на вашем локальном компьютере и закачивать обратно. Редактирование через FTP-клиента очень часто служит дополнительным источником ошибок и к тому же использует больше траффика.

- 4. Иногда в каталоге с модом можно увидеть папку "contrib" или "add-ons". Как правило, в этой папке находятся дополнения к МОДу (по сути - тоже МОДы), содержащие код, или файлы для совместимости или корректной работы устанавливаемого МОДа с другими МОДами, установленнми на вашем форуме, а также файлы для перехода с предыдущих версий данного МОДа, если вы уже ставили более раннюю версию данного МОДа. Устанавливать эти МОДы, по-другому их называют адд-оны (add-on), не всегда обязательно (если иное не указано в инструкции).

И не забывайте, что перед началом установки МОДа необходимо сделать резервную копию ваших файлов, прежде чем делать любые изменения в коде phpBB. Вы должны также создать резервные копии базы данных (или связанных таблиц), если МОД требует изменений в вашей базе данных.