Как отображать кредиты - PullRequest
Новая
       13

Как отображать кредиты

11 голосов
/ 10 ноября 2008

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

Какой способ создания HTML-страницы вы считаете лучшим?

  • Жесткий код HTML-страницы?
  • Переключите управление зависимостями на apache-ivy и напишите некоторую задачу ant для генерации html
  • Используйте maven-ant-tasks и напишите несколько ant-задач для генерации HTML
  • Используйте maven только для обработки зависимостей и HTML один раз, загрузите их и зафиксируйте их. Остальное делают неизмененные муравьиные скрипты
  • Переключиться на maven2 (Эй, босс, я хочу перейти на maven, через 1 месяц сборка может снова заработать ...)
  • ...

Какие элементы должен отображать диалоговое окно about?

  • Название библиотеки
  • Версия
  • Лицензия
  • Автор
  • Главная страница
  • Изменения, сделанные со ссылкой на исходный архив
  • ...

Есть ли какой-нибудь совет лучшей практики? Несколько хороших примеров (в приложениях есть хороший диалог с указанием зависимостей)?

Ответы [ 3 ]

3 голосов
/ 10 ноября 2008

Есть две разные вещи, которые вы должны рассмотреть.

Во-первых, вам может потребоваться определить лицензии стороннего кода. Это часто связано с файлом THIRDPARTYLICENSE. Sun Microsystems делает это много. Посмотрите в директории установки OpenOffice.org, например. Есть примеры .txt и .html версий таких файлов.

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

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

3 голосов
/ 10 ноября 2008

Задача муравья кажется наилучшим способом. Мы делаем подобное в одном из наших проектов. Все библиотеки с открытым исходным кодом находятся в указанной папке. Задача Ant считывает манифест этих библиотек, версий и т. Д. И генерирует HTML, копирует в другую указанную папку, откуда он берется веб-контейнером.

2 голосов
/ 10 ноября 2008

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

...