Modding:Интерфейс программы CreateReadMe

Материал из Tiarum
Перейти к: навигация, поиск

Интерфейс программы CreateReadMe


CreateReadMe About.png



Общие сведения

CreateReadMe v1.3 - небольшая удобная программа для создания стильных ридми-файлов в формате .htm от Олега Барса. Программа позволяет стандартизировать процесс их написания и выработать единый стиль с максимально полным количеством информации. Ведь не секрет, что модостроители не всегда уделяют должное внимание этому аспекту модостроения. Подчас, создав великолепный глобальный мод, в ридми можно видеть лишь пару невнятных строк, заставляя игроков самим разбираться, что к чему. Чтобы исключить подобные "проколы", вы вполне можете использовать данную программу для своих нужд.


Программа написана для локализаторов и создателей плагинов сайта Fullrest.ru, однако, если снять галочку в одном из пунктов диалогового окна, то, согласно лицензионному соглашению (вкладка "О программе"), она может использоваться и всеми остальными модостроителями. Программа позволяет включать в итоговый файл скриншоты, просматривать текстовые и html-файлы, а также содержит страницу помощи по работе с программой.


В данной статье подробно рассматривается интерфейс программы CreateReadMe v1.3.


О том, как работать с данной программой и создавать качественные ридми-файлы, вы можете прочитать на форуме сайта Фуллрест в теме "Создание "фирменных" ридми для Морровинда, стандарт оформления.". Автором данного руководства является Menorra. В руководстве подробно описан процесс создания readme-файла для команды Fullrest-team.

Если у вас возникли вопросы по работе с этой программой, вы вполне можете задать их непосредственно в данной теме на форуме.


Интерфейс

CreateReadMe Interface.png

Интерфейс программы дружественный и достаточно прост. Диалоговое окно имеет фиксированные размеры и содержит следующие элементы интерфейса:

  • Кнопки:
  • "Новый"
  • "Открыть"
  • "Сохранить"
  • Закладки:
  • "Просмотр"
  • "Параметры1"
  • "Параметры2"
  • "База данных"
  • "Справка"
  • "О программе"

Кнопка "Новый"


При нажатии все установленные ранее галочки в чек-боксах сбрасываются к значениям по умолчанию, а набранный текст удаляется.

Кнопка "Открыть"


При активации кнопки "Открыть" открывается диалоговое окно загрузки файла. По умолчанию установлен тип "Текстовые файлы (*.txt)". Однако, если выбрать опцию "Все файлы", то можно открыть и просмотреть на закладке "Просмотр", например, сгенерированные программой исходные коды в формате html.

Кнопка "Сохранить"


Кнопка "Сохранить" предназначена для сохранения созданного файла в формате *.htm. Html-код, сгенерированный программой, может быть отредактирован в дальнейшем в любом текстовом редакторе, например, Блокноте. Иногда это бывает необходимо, чтобы выровнять расположение скриншотов, или увеличить их количество свыше трех, допускаемых программой.

Закладка "Просмотр"


Закладка "Просмотр", содержащая текстовое окно, предназначена для просмотра текстовых файлов, копирования информации, а также просмотра сгенерированных программой файлов в формате htm. Обычно это окно очень удобно при преобразовании уже имеющегося файла readme.txt в файл readme.htm.

Выделите требуемый текст и нажмите правую кнопку мыши. В открывшемся контекстном подменю выберите нужное действие. У вас есть возможность вставить скопированный текст в соответствующее выбранное вами поле, заменив тем самым его прежнее содержание.


CreateReadMe Autor.png


Вы можете также добавить выбранный текст к существующим данным. Другими словами, команда "Вставить" полностью заменяет текст, а команда "Добавить" добавляет выделенный текст к уже существующему.


CreateReadMe Email.png


Вы можете частично отредактировать одну или несколько строк или даже удалить часть текста, однако эти правки никак не скажутся на открытом вами файле - опция сохранения для текстовых файлов в программе не предусмотрена.

Возможности редактирования в этом окне немного ограничены. Например, комбинации клавиш CTRL-A (выделить все) и ENTER (перевод строки) в этом окне не работают. Однако для перевода строки предусмотрена комбинация CTRL-ENTER

Остальные привычные комбинации клавиш работают, например, CTRL-Z (отмена), CTRL-X (вырезать), CTRL-C (копировать) и CTRL-V (вставить).


Закладка "Параметры 1"


Содержит 5 отдельных секций:

  • Плагин
  • Требует
  • Скриншоты
  • Установка
  • Удаление

CreateReadMe Param1.png

Плагин:

  • Название: Название плагина.
  • Имя файла: Имя файла плагина с расширением. Воспользуйтесь кнопкой поиска CreateReadMe-Folder.jpg или введите имя вручную.
  • Поле редактирования: Описание плагина. Можно использовать копирование и вставку буфера обмена. Для перевода строки используйте Ctrl+Enter. В документе одиночные переводы строки будут заменены пробелами, двойные - тегом перевода строки <br>.

Требует:

  • Установите отметки возле требуемых мастер-файлов.
  • Если ваш плагин использует собственные архивы bsa, также установите галочку.
  • При необходимости установите отметку «Другое» и введите свой текст в поле ниже.

Скриншоты:

  • В выпадающем списке установите количество скриншотов.
  • Укажите имена файлов скриншотов.
  • Лучше воспользоваться кнопками поиска, которые находятся справа от каждого текстового поля для имени CreateReadMe-Folder.jpg.

Установка:

  • Стандартная: Будет создан стандартный текст установки.
  • Другое: При необходимости установите отметку «Другое» и введите свой текст в поле ниже.

Удаление:

  • Стандартное: Будет создан стандартный текст удаления.
  • Другое: При необходимости установите отметку «Другое» и введите свой текст в поле ниже.


Закладка "Параметры 2"


Содержит 5 отдельных секций:

  • Как играть
  • Авторы
  • Примечание
  • Предупреждение
  • Параметры записи

CreateReadMe Param2.png

Как играть:

  • При необходимости добавить эту секцию в документ установите галочку.
  • Введите свой текст в поле, расположенное ниже.

Авторы:

Введите информацию об авторе(ах) плагина.

Примечание:

При необходимости добавить эту секцию в документ установите галочку и введите свой текст в поле ниже.

Предупреждение:

Секция содержит два чек-бокса. Установите нужное значение. Одновременно поставить галочки не удастся. Если вы член команды Fullrest-team, то выберите Стандартное предупреждение, если нет - то Другое.

  • Стандартное: Если установить галочку, то в ридми будет создано стандартное предупреждение:
Вы не можете распространять данный плагин без разрешения администрации сайта.
За дополнительной информацией обращаться к Lord Alex (alexzx@yandex.ru).
Если у Вас есть интересный собственный плагин или адаптация, и Вы хотите разместить его на нашем сайте, то обращайтесь к Lord Alex (alexzx@yandex.ru) или другим членам команды FullRest-Team.
  • Другое: При необходимости заменить стандартный текст установите отметку и введите свой текст в поле ниже.

Параметры записи:

Установите отметки по необходимости.


Закладка «База данных»


Данная закладка создавалась для заполнения базы плагинов сайта Fullrest.ru (пример). Однако закладка неактивна. Впрочем, приводим авторское описание данной закладки (на случай новой версии, например).

База данных:

  • Создать запись базы данных: Включите при необходимости.
  • Название плагина (копия): Название плагина (с первой закладки).
  • Тип плагина: Выберите из списка.
  • Скриншот 200 х 150: Имя файла скриншота для OnLine-версии. Лучше воспользоваться кнопкой поиска. Разрешение скриншота указано рекомендуемое. Вы вполне можете загрузить изображение с любым разрешением, но лучше все-таки придерживаться разумных значений.

Архив плагина:

  • Имя с расширением: Воспользуйтесь кнопкой поиска CreateReadMe-Folder.jpg.
  • Размер: Размер файла архива с плагином. При использовании кнопки поиска заполняется автоматически.

Автор и Адаптор:

  • Имя и E-mail автора и адаптора.

Описание:

Копия описания плагина с первой закладки.

Оценки:

Выберите из списка оценки плагина в трех категориях.

Ссылка на оригинал:

  • Адрес страницы сайта с плагином.
  • FullRest: при установленной отметке будет создана ссылка на главную страницу сайта FullRest.


Закладка «Помощь»


Краткая помощь по работе с программой. Именно ее содержание легло в основу данной статьи.


Закладка "О программе"


Содержит следующие пункты:

  • Лицензионное соглашение
  • Объем лицензии
  • Авторские права
  • Отказ от гарантий
  • Благодарности
ЛИЦЕНЗИОННОЕ СОГЛАШЕНИЕ

Настоящее лицензионное соглашение с отказом от гарантий является юридическим документом, заключенным между вами (физическим или юридическим лицом) с одной стороны и Олегом Барсом с другой стороны (далее "автор") относительно использования данного программного продукта и материалов, которые в него входят или к нему относятся. Устанавливая, копируя, загружая, осуществляя доступ или иным образом используя указанную программу, вы тем самым принимаете на себя условия настоящего соглашения. Если вы не принимаете условий данного соглашения, не копируйте, не устанавливайте и не используйте данную программу.

ОБЪЕМ ЛИЦЕНЗИИ

Настоящее соглашение не является договором купли-продажи программы или ее копии. 
Программа поставляется бесплатно на условиях “КАК ЕСТЬ”. Вы используете программу на собственный страх и риск. Вы можете свободно и бесплатно использовать и распространять программу при соблюдении следующих условий:
1) Вы принимаете все положения данного лицензионного соглашения.
2) Вы не изменяете содержимое архива с программой, не изменяете
и не удаляете файлы, поставляемые в составе архива с программой.
3) Вы не получаете материальной выгоды от использования или распространения
программы.

АВТОРСКИЕ ПРАВА

Автор сохраняет за собой все права, титул и прочие имущественные и неимущественные права в отношении программы. Программа защищена законами и международными соглашениями об авторских правах, а также другими законами и договорами, регулирующими отношения авторского права. Все права защищены. 

Запрещается любое коммерческое использование программы без письменного разрешения автора. Запрещается продавать, предоставлять в прокат, аренду или иным образом получать прибыль за использование программы или саму программу или какие-либо компоненты программы. Запрещается изменять или создавать на основе данной программы измененные изделия. Запрещается декомпиляция и дизассемблирование программы.

ОТКАЗ ОТ ГАРАНТИЙ

Программа поставляется условиях “КАК ЕСТЬ”. Вы используете программу на собственный страх и риск. Автор не предоставляет никаких гарантий, явных или подразумеваемых. Автор не предоставляет никаких гарантий относительно качества или производительности программы или сопровождающих ее материалов. Автор не гарантирует, что программа будет удовлетворять вашим требованиям, что в ней будут отсутствовать дефекты или ошибки или что работа программы будет бесперебойной. Ни при каких обстоятельствах автор не несет ответственности, за какой либо опосредованный, случайный, прямой, косвенный или иной ущерб или убытки, возникающие в связи с использованием или невозможностью использования программы.

БЛАГОДАРНОСТИ

Лорду Алексу (alexzx@yandex.ru) за помощь в создании программы.
Сайту Fullrest (http://www.fullrest.ru) - Российский сайт по миру «The Elder Scrolls III».


(c) Олег Барс (Oleg Bars) olegbars@bk.ru


Результат работы программы

На скриншоте ниже показано начало ридми-файла, сгенерированного программой CreateReadMe v1.3 и открытого в интернет-браузере:


CreateReadMe Result.png