BardSongbooks

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

Текущая версия: 0.1.9.

Скачать

de67bbdf31e67b78a01d22c4dd097aafcb89561e79aaaf2737210b88b569a247  BardSongbooks-0.1.9.zip
09246223c66260ca94962bf38753c9e81982eb9e1e9b9d3fbaea395604dd6c94  BardSongbooks-0.1.9.tar.gz

Архив распаковывается в каталог BardSongbooks/. Лицензия: GPL-2.0-or-later.

Возможности

несколько приватных песенников у одного пользователя;
добавление песни прямо со страницы песни или из поиска в редакторе;
управление добавлением в служебной панели темы: справа в инструментах Vector 2022 и слева в старых Vector/MonoBook;
поиск по основному, альтернативному и оригинальному названию, композиторам, авторам текста, первой строке и всему индексированному тексту песни;
одновременный запрос по разным полям;
результаты вида Название (авторы) — Первая строка;
произвольная перестановка песен перетаскиванием или кнопками вверх/вниз;
ссылки на исходные страницы песен;
печать песен подряд или каждой с новой страницы;
от одной до трёх колонок внутри песни и размер шрифта от 8 до 16 пунктов;
сохранение строф целиком при разбиении на колонки;
возможность скрыть сведения о песне;
режим «Только первый раздел песни», исключающий следующие разделы, например «Аккорды»;
дополнительное нумерованное оглавление без номеров страниц со ссылками на песни внутри печатного представления;
печать и сохранение в PDF средствами браузера.

Требования

MediaWiki 1.43 или новее;
PHP 8.1 или новее; выпуск проверен на PHP 8.3;
MySQL или MariaDB, поддерживаемые установленной версией MediaWiki;
расширение Cargo и таблица cargo__song;
стандартный полнотекстовый индекс MediaWiki searchindex.

Поиск ожидает поля Cargo Name, AlterName__full, OriginalName__full, Composer__full, Lyric__full, FirstString и _pageID. Для другой схемы Cargo код поиска потребуется адаптировать.

Установка

Сделайте резервную копию базы данных, каталога расширений и LocalSettings.php.
Распакуйте архив в extensions/BardSongbooks. Файл манифеста должен оказаться по пути extensions/BardSongbooks/extension.json.
Добавьте в LocalSettings.php:

wfLoadExtension( 'BardSongbooks' );

Из корня MediaWiki выполните:

php maintenance/run.php update --quick

Проверьте версию на странице Служебная:Версия.
Войдите как зарегистрированный пользователь и откройте Служебная:Мои песенники.

Обновление

Сохраните текущий каталог extensions/BardSongbooks и базу данных.
Замените каталог файлами новой версии.
Выполните php maintenance/run.php update --quick.
При необходимости очистите кеш браузера.
Проверьте создание песенника, поиск, перестановку и печатную версию.

Использование

Создание

Откройте «Мои песенники» в пользовательском меню или Служебная:Мои песенники, введите название и нажмите «Создать». Один пользователь может иметь до 50 песенников. Названия песенников одного пользователя не повторяются.

Добавление и поиск

Песню можно добавить со страницы самой песни либо найти в редакторе песенника. В один песенник нельзя дважды добавить одну страницу; предел — 500 песен.

Запрос разбивается максимум на десять слов. Каждое слово должно встретиться хотя бы в одном поддерживаемом поле, но разные слова могут находиться в разных полях. Это позволяет одновременно искать по автору, части названия и словам из текста. Минимальная длина запроса — два символа, за один запрос возвращается до 30 результатов.

Порядок

Песни можно перетаскивать мышью либо перемещать кнопками вверх и вниз. Порядок хранится отдельно для каждого песенника.

Печать и PDF

В редакторе выбираются расположение песен, 1–3 колонки внутри песни, размер шрифта, показ сведений и режим первого раздела. Строфы распределяются между колонками целиком. Заголовки остаются ссылками на исходные страницы.

Кнопка «Печать / сохранить в PDF» открывает системный диалог браузера. Серверный PDF-файл расширение не создаёт.

Режим «Только первый раздел песни» отбрасывает содержимое начиная со следующего прямого заголовка H2–H6 и подходит для исключения раздела «Аккорды».

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

Данные и безопасность

Расширение создаёт только собственные таблицы:

bard_songbook — владелец, название и параметры печати;
bard_songbook_item — страницы песен и их порядок.

Страницы песен, PageForms, шаблоны, Lua-модули и Cargo-данные не изменяются.

Право bard-songbooks-use по умолчанию выдано группе user. Анонимным посетителям песенники недоступны. Изменения требуют входа, проверки владельца, POST-запроса и CSRF-токена MediaWiki.

Откат и удаление

Для отката верните сохранённый каталог предыдущей версии и выполните php maintenance/run.php update --quick.

Для отключения удалите или закомментируйте wfLoadExtension( 'BardSongbooks' );. Таблицы и песенники при этом сохраняются.

Удалять таблицы вручную следует только при окончательном удалении расширения и после отдельной проверенной резервной копии. Сначала удаляется bard_songbook_item, затем bard_songbook.

Ограничения версии 0.1.9

песенник использует текущую версию страницы песни и не фиксирует ревизию;
совместный доступ и публичная публикация песенника отсутствуют;
PDF создаётся браузером;
полнотекстовый поиск зависит от актуальности индекса MediaWiki;
Cargo-поиск привязан к структуре Бард-Вики.

История выпусков

0.1.9: Мелкий шрифт подписей в списке песен; сохраняемое нумерованное оглавление без номеров страниц с внутренними ссылками на песни.
0.1.8: Ссылка с Служебная:Версия на эту документацию; рабочая логика 0.1.7 не менялась.
0.1.7: Блок убран из содержимого статьи и перенесён в служебную панель темы. В Vector 2022 он следует за «Инструментами» в правой закреплённой колонке либо в раскрывающемся меню; в старых Vector и MonoBook находится в левой колонке.
0.1.6: Блок добавления песни перенесён в компактную правую колонку; на экранах до 720 пикселей он остаётся в обычном потоке, а при печати скрывается.
0.1.5: Полная документация, журнал изменений, лицензия и публичные установочные архивы. Функциональность 0.1.4 не менялась.
0.1.4: Ссылки на страницы песен и сохранение строф при распределении по колонкам.
0.1.3: Полнотекстовый поиск, альтернативные названия и режим первого раздела.
0.1.1: Составной поиск по названию, авторам и первой строке.
0.1.0: Первый рабочий выпуск личных песенников.

См. также каталог самописных расширений Бард-Вики.