Проект

Общее

Профиль

Улучшение #1138

Создание README.html

Добавил(а) LastDragon около 8 лет назад. Обновлено больше 7 лет назад.

Статус:
Новый
Приоритет:
Высокий
Назначена:
Категория:
-
Версия:
Дата начала:
04.01.2011
Дата завершения:
04.01.2011
Готовность:

0%


Описание

  1. Примерный вид см. во вложении
  2. Должен генерироваться автоматически1
  3. Свойства должны подставляться автоматически
  4. Должна поддерживаться локализация2
Приблизительная структура (что должно быть):
  • Свойства
  • Лицензия (ссылка на неё)
  • Требования (см. #1045)
  • Описание
  • Изменение

Возможно, есть смысл генерировать этот файл на основе xml файла с информацией о модификации (см. #1043)


1 Лучше всего создать отдельный ресурс

2 Легче всего создать несколько файлов на разных языках

ReadMe.html Просмотреть - черновик файла (7,02 КБ) LastDragon, 08.08.2010 06:48


Связанные задачи

предыдущая IPB3 Toolkit (toolkit) - Улучшение #1541: Удалить ресурс versionfiles Закрыт 25.12.2010 03.01.2011

История

#1 Обновлено LastDragon почти 8 года назад

Как должно работать (приблизительно):
  • У каждого объекта есть стандартное описание (ссылка на файл описание)
  • У проекта есть набор требований
  • У каждого объекта есть набор требований (если нет - наследуются от проекта)
  1. Создаем XML файл со всей информации об объекте
    • Описание
    • Требования (из проекта)
  2. Используя XSLT конвертируем его в HTML файл с описанием

Часть описания можно взять из БД (и локализовать его с использованием ресурсов - если локализации нет - используем из БД, если есть - её). Часть удобнее всего сохранять, например, в textile (конвертировать в HTML перед использованием). Важно предусмотреть возможность "присоединения" сразу нескольких текстовых файлов (чтобы выкинуть одинаковые данные в них).

Важно: Было бы удобно иметь возможность включения изображений сразу в файл (на IE6 можно забить, т.к. официально он уже не поддерживается).

Самое сложное - формирование XML файла для трансформации, как сделать - идей пока нет.

#2 Обновлено LastDragon больше 7 лет назад

  • Параметр Приоритет изменился с Нормальный на Высокий

Экспортировать в Atom PDF