Відсьогодні ввечері користувачі musdb бачитимуть повідомлення із пропозицією спробувати новий інтерфейс. Виникає очевидне питання: чи готовий він до повноцінного використання? Насправді однозначної відповіді немає. Під час розробки ми насамперед зосередилися на функціях, які використовуються найчастіше, тоді як деякі менш уживані розділи musdb у новому інтерфейсі поки що повністю відсутні. Перш ніж перейти до майже повного переліку та категоризації функцій, яких у новому інтерфейсі ще немає, розглянемо кілька його ключових нових можливостей і переваг.

Нова архітектура, нові можливості

Як ми вже неодноразово пояснювали в попередніх дописах, найскладнішою і водночас фундаментальною частиною оновлення інтерфейсу musdb став перехід до іншого архітектурного підходу. У старому інтерфейсі кожна сторінка є окремим скриптом, а всі ці скрипти використовують спільні функції у фоновому режимі. Тому відкриття сторінки або, наприклад, збереження форми потребує повного перезавантаження сторінки, разом з усіма даними, які при цьому взагалі не змінилися. На перший погляд це здається неефективним з погляду продуктивності та використання пропускної здатності. Так воно і є. Це також помітно безпосередньо під час роботи: наприклад, після надсилання форми сторінка повертається на самий верх.

Рефакторинг бекенд-коду musdb для створення більш багаторазової, тестованої та логічної структури триває вже понад п’ять років. Безпосереднім результатом цієї роботи стало поступове розширення API musdb, про яке ми час від часу згадували в блозі: функції, що використовувалися для звичайного, зрозумілого для людини інтерфейсу, стали також доступними для обміну даними між машинами.

Новий інтерфейс став результатом завершення цього рефакторингу. Це застосунок на TypeScript, повністю побудований на API musdb. З одного боку, це означає, що потенційно будь-яка дія, яку користувач може виконати через графічний інтерфейс musdb, буде доступна й для автоматизованого виконання через API. З іншого боку, це спрощує розробку: оскільки ми самі всюди використовуємо API, підтримувати його в належному стані стає значно простіше (див. також цей принцип).

Завдяки новій архітектурі інтерфейс повністю обробляється в браузері. Під час надсилання форм на сервер передаються лише змінені значення. Після завантаження застосунку це суттєво зменшує обсяг переданих даних. Так само під час навігації перезавантажуються лише ті частини сторінки, які справді змінюються. Це зменшує навантаження як на сервер, так і на клієнт та відповідно підвищує продуктивність.

Автоматизація за допомогою вебхуків

Саме завдяки новій архітектурі в musdb стало можливим додати систему вебхуків, яка дає змогу автоматично реагувати на зміни в musdb. Налаштувати вебхуки можна в налаштуваннях установи в новому інтерфейсі. Зверніть увагу: оскільки система вебхуків працює на основі нової архітектури, вебхуки, налаштовані в новому інтерфейсі, не спрацьовуватимуть під час роботи у старому інтерфейсі, доки доступні обидві версії. Див. також: Wikipedia про вебхуки.

Оновлення дизайну

Повне переосмислення дизайну, звісно, дало нам змогу створити значно зручніший і більш упорядкований інтерфейс. Судячи з відгуків, які ми вже отримали, хоча їх поки що небагато, нам це вдалося. Схожі функції, які раніше були розподілені між різними частинами однієї сторінки або навіть різними сторінками, тепер об’єднані в одному розділі. Зайві або незрозумілі опції було прибрано. Там, де все могло залишитися як раніше, воно загалом таким і залишилося, адже попри свої недоліки старий дизайн також отримував чимало позитивних відгуків.

У попередніх дописах у блозі ми вже докладно показували окремі частини нового інтерфейсу. Для цієї статті важливо інше: оновлення дизайну також передбачає відмову від деяких зайвих, невдало продуманих або фактично контрпродуктивних функцій.

Перелік функцій, які ще не реалізовано

Нижче наведено перелік функцій старого інтерфейсу, які ще не реалізовано в новому, у деяких випадках із додатковими поясненнями. Якщо певної функції в цьому переліку немає, найімовірніше, її вже реалізовано.

Функції, які точно буде реалізовано, але яких поки що немає

Цілі сторінки

• Загальна сторінка пошуку зображень об’єктів ще не реалізована
• Підрахунок відвідувачів

Навігація

• Система сповіщень

Інші інструменти

У старому інтерфейсі вони доступні в розділі «Інструменти» на інформаційній панелі або в однойменному підменю навігації.

• Генератор QR-кодів
• Календар
• Список процесів
• Список завдань
• Управління знаннями / міні-вікі
• Перевірка гіперпосилань
• Скорочення URL
• Перевірка узгодженості під час перенесення даних із полів вільного тексту до контрольованих полів

Функції, доступні в кількох розділах musdb

• Нотатки (для будь-якої сторінки)
• Інтеграція з Nextcloud
• Інтерфейс для користувачів з обмеженими правами
  Інтерфейс має приховувати кнопки надсилання та інші елементи, якщо користувач не має права виконувати відповідну дію. Наразі це реалізовано лише в небагатьох випадках, хоча на рівні бекенду права доступу вже застосовуються.

Сторінки об’єктів

• Оглядові сторінки
  • Меню сортування
  • Список спостереження
  • Перегляд списком / редагування більшості полів у табличному вигляді
• Бічна панель
  • Попередження, якщо об’єкт наразі зарезервований
  • Статус редагування запису про об’єкт, наприклад відкритий, заблокований або архівований
  • Налаштування експорту для XML; швидкий експорт уже працює
  • Пропозиції щодо покращення
• Вкладка основних даних
  • Редагування перекладів
  • Пропозиції тегів на основі зображення об’єкта
  • Пропозиції тегів на основі опису об’єкта
  • Можливість додавати джерела / посилання на джерела для подій
• Вкладка додаткових даних
  • Налаштування статусу публікації для окремих полів даних
• Вкладка адміністрування
  • Вилучення об’єкта з фондів
• Вкладка місцезнаходження
  • Посилання на управління позиками
• Більша частина вкладки реставрації / консервації
• Вкладка історії даних
  • Інтерфейс керування версіями
• Власний / налаштований користувачем інтерфейс редагування об’єктів
• Порівняння об’єктів

Сторінки установ

• Сторінка редагування установи
  • Вкладка для самокатегоризації установ / опитування
• Налаштування на рівні установи
  • Налаштування запланованого автоматичного створення експортів

Сторінки колекцій

• Ієрархія та сортування
• Сторінка редагування
• Додавання тегів до колекцій

Серії

• Сторінки редагування серій
  • Ієрархія
  • Сортування об’єктів серії
  • Бічна панель
    • Налаштування видимості серії на публічній сторінці установи
    • Можливість групувати пов’язані записи словника для редагування в nodac

Налаштування користувачів

• Сторінки редагування інших користувачів
  • Налаштування прав користувачів
• Налаштування власного облікового запису
  • Експорт даних власного облікового запису
  • Налаштування WebDAV (для підготовки самостійно запущених імпортів даних)
  • Налаштування сповіщень

Контакти / адресна книга

• Сторінки редагування контактів
  • Експорт vCard
  • Список пов’язаних бібліографічних записів (буде реалізовано на сторінці пошуку літератури)

Приміщення

• Ієрархія
• Сторінки редагування
  • Відображення даних датчиків

Виставки

• Сторінки редагування
  • Вкладка для публікацій, пов’язаних із виставкою

Словники / довідкові дані

• Ще не опублікована функція каталогу-резоне
• Твердження

Функції, які вже реалізовано, але які ще точно потрібно вдосконалити

• Сторінка редагування об’єкта
  • Прив’язування нещодавно прив’язаних сутностей на вкладці основних даних

Функції, які буде видалено

• Загальні функції сторінок
  • Закладки
    Браузери значно краще працюють із закладками, ніж musdb. А musdb у будь-якому разі працює в браузері.
• Сторінка об’єкта
  • Вкладка «Дослідження провенансу»
    Відгуки дослідників провенансу, а також здоровий глузд і наш власний досвід показали, що нинішня реалізація загалом невдала. У майбутньому в musdb може з’явитися окремий загальний розділ для управління дослідницькими проєктами, який справді виконуватиме завдання, для яких ми створили цю функцію.
  • Введення даних у вигляді вільного тексту за допомогою відповідно підготовленого QR-коду
  • Інструмент «Запитати експерта»
• Розділ статей (майже не використовувався)
• Функції для подкастів (ніколи не публікувалися)
• Сторінка серії
  • Офлайн-каталог HTML
    Це рішення належним чином не підтримувалося вже близько десяти років. Крім того, завдяки значно ширшій доступності інтернет-з’єднання рішення на основі API стали набагато гнучкішими.
  • Налаштування режимів відображення опублікованих сторінок серій
• Чат
• Налаштування стартової сторінки користувача після входу
  Основним і найнадійнішим способом повідомляти про оновлення musdb та інших інструментів museum-digital є блог, стрічка якого вбудована в інформаційну панель. Якщо всі користувачі час від часу відкриватимуть інформаційну панель, зростає ймовірність того, що вони дізнаватимуться про оновлення. Крім того, уніфікований процес входу полегшує розуміння повідомлень користувачів про помилки, пов’язані зі входом і запуском системи.

Функції, які ще потрібно обговорити

• Сторінка об’єкта
  • Налаштування кнопок соціальних мереж. З огляду на доступний набір таких кнопок і сучасні тенденції використання соціальних мереж, можливо, доцільніше просто відмовитися від цієї опції.

Що це означає для подальшого плану?

Як легко побачити, роботи ще чимало. Однак основну її частину вже виконано, і ми повністю дотримуємося запланованого графіка. Для всіх, хто залежить від функцій, яких поки що немає в новому інтерфейсі, стара версія залишатиметься доступною приблизно до 22 листопада. Водночас для більшості користувачів musdb у своєму нинішньому стані вже має задовольняти більшість або навіть усі їхні потреби краще, ніж старий інтерфейс.

До 22 листопада обидві версії залишатимуться доступними, щоб користувачі могли поступово перейти на нову. Ми будемо раді Вашим відгукам і продовжуватимемо регулярно оновлювати нову версію.

(Зображення до допису згенеровано за допомогою Anima Base v1)

This content is licensed under a Creative Commons Attribution 4.0 International license.

Масштаб і причини оновлення

musdb як інструмент існує майже від самого початку роботи museum-digital у 2009–2010 роках. Спочатку його створили як інструмент для внесення даних про об’єкти, призначених для публікації. Відтоді цілі та сфера застосування musdb значно розширилися: з простого інструменту для внесення та публікації даних він перетворився на повноцінну систему управління музейними колекціями та роботою музею. Водночас базова архітектура інтерфейсу користувача залишалася майже незмінною.

Упродовж років до системи додавали багато нових функцій. Однак їх зазвичай розміщували так, щоб не заплутувати наявних користувачів і не порушувати усталені робочі процеси. У результаті сам musdb працював добре, проте його інтерфейс роками розвивався без чіткого довгострокового плану та систематичної розробки стабільних універсальних компонентів.

З 2009 року значно змінився й ширший технологічний контекст. Веброзробка стала іншою. Нам більше не потрібно перейматися Internet Explorer, сумісність між браузерами суттєво покращилася, а вебзастосунки сьогодні можуть бути набагато інтерактивнішими. Щоб повною мірою скористатися цими можливостями під час подальшої розробки musdb, необхідно докорінно змінити його архітектуру.

Архітектура musdb переходить від традиційного вебсайту з великою кількістю окремих сторінок до Single Page Application (SPA). Тому йдеться справді про повне переписування інтерфейсу. Замість того щоб генерувати сторінки на сервері й лише відображати їх у браузері, інтерфейс musdb тепер повністю генеруватиметься безпосередньо в браузері, а через відповідні добре задокументовані API завантажуватимуться лише потрібні в конкретний момент дані.

Це означає, що навіть для простого збереження функцій старого дизайну їх, або принаймні спосіб їх представлення, потрібно реалізувати заново. Водночас оновлення дає чудову нагоду зробити інтерфейс більш упорядкованим і зручним, а також переосмислити функції, які раніше залишалися малопомітними або майже не використовувалися.

Хоча в майбутній версії на технічному рівні, принаймні щодо інтерфейсу користувача, практично все буде новим, це не означає, що на концептуальному рівні все має суттєво змінитися. Нова версія musdb збереже знайому базову структуру сторінок: списки, сторінки редагування та сторінки для додавання нових записів. Збережеться і принцип сторінок редагування з вкладками, а також, за кількома винятками, ті самі поля даних і їхня послідовність.

Невеликий попередній огляд

Оскільки багато речей залишаться знайомими, варто поглянути й на те, що зміниться. Нижче ми покажемо кілька таких нововведень у коротких скринкастах. Більшість із них стосується оглядових сторінок і сторінок зі списками, які вже готові до впровадження.

Навігація

Нові можливості фільтрування

Короткий скринкаст із майбутньої версії musdb. Як це вже було розпочато у старому дизайні musdb, тепер не лише об’єкти, а й багато інших типів записів отримають нові можливості фільтрування.

Три режими відображення оглядів

Інфраструктура для пакетної обробки на всіх оглядових сторінках

Інтерактивні огляди

Коли ж з’явиться оновлення?

Наразі розробка просувається без суттєвих труднощів, а необхідні компоненти для майже всіх функцій уже готові. Залежно від того, якими функціями ви користуєтеся, новий інтерфейс уже зараз може замінити старий у більшості типових сценаріїв роботи. Однак для повноцінної підтримки всіх поширених сценаріїв використання необхідно щонайменше повністю завершити сторінку редагування об’єктів. Очікується, що вона буде готова не пізніше кінця вересня. Після цього відбудуться презентації та перехідний період, протягом якого стару й нову версії можна буде використовувати паралельно. Це має забезпечити плавний перехід від старого інтерфейсу користувача до нового.

This content is licensed under a Creative Commons Attribution 4.0 International license.

Зображення до публікації створено за допомогою Anima Base v1.