РУКОВОДСТВО для SB.ProgramsTool 1.0.2

Содержание

1. Режимы работы утилиты.

2. Подключение к программе-носителю (руководство).

3. Файлы на сервере.

4. Примеры вызова утилиты с командной строкой для разных языков программирования.

----------------------------------------

Онлайн версия руководства >>>

Связаться с автором программы

1. Режимы работы утилиты.

Режимы работы утилиты:
  • Проверка наличия обновлений.



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

  • Настройка параметров проверок.



    В данном режиме можно настроить параметры проверок наличия обновлений.

  • Возможность написать отзыв о программе.



    В данном режиме пользователь вашей программы может написать отзыв/пожелание о вашей программе на заданный вами e-mail (ни каких сторонних программ при этом не требуется).

  • Возможность отправить на указанный вами e-mail описание ошибки и текстового файла с отчетом.



    В данном режиме пользователь вашей программы может написать описание ошибки в вашей программе на заданный вами e-mail (ни каких сторонних программ при этом не требуется), также к письму можно прикрепить текстовый файл (размер не более 100 КБ) с данными об ошибке.

  • Возможность оповещать пользователей программы сообщением о каком-либо событии.



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

2. Подключение к программе-носителю (руководство).


Общие правила:

Работа утилиты с программой-носителем реализована, через запуск утилиты с командной строкой.
Все параметры, передающиеся в командной строке, должны быть в кавычках ("параметр"). Параметры должны быть разделены пробелом.
Не рекомендуется использовать в параметрах русские символы.
В папке "Settings" должен быть файл "UMessages.ini", в нем задается частота проверки обновления сообщения, по умолчанию раз в 7 суток. Вы можете изменить частоту в пределах 1-30 суток.
Рекомендуется в установочный пакет добавлять файл "ProgramsTool.ini" (в папке Settings), с настройками для вашей программы.
Утилита совместима с ОС Windows 2000 и выше, при запуске на более ранних версиях Windows в папке "Settings" будет создан файл "NotSupportedOS.ini".

Если программа-носитель работает в полноэкранном режиме, то окна утилиты не будут видны, учитывайте это, особенно при запуске утилиты в режимах "Написать отзыв" и "Отправка отчета об ошибке".

Расшифровка параметров:


ProName - название программы *
ProVers - версия программы *
Lang - язык (только "Russian" или "English") *
EMail - e-mail на который будут отправляться отзывы и отчеты об ошибках *
PatchToExe - путь (абсолютный) к exe-файлу программы носителя *
PatchToFile - путь (абсолютный) к файлу прикрепляемому к отчету об ошибке, файлы только текстовые, не более 100 кб.
URLtoFile - папка с файлом обновления *

     Пример: "http://sbgames.narod.ru/newversion/"
     Имя файла обновления = ProName+'_'+ProVers+'.txt' для русского языка и ProName+'_'+ProVers+'Eng.txt' для английского.
     Если файл на сервере отсутствует, то утилита считает, что обновления программы не было.

URLtoMSG - папка с файлом с датой последнего изменения сообщения.

     Пример: "http://sbgames.narod.ru/messages/"
     имя файла с датой обновления русской версии сообщения = 'Messages_LastEdit.txt'
     имя файла с русским сообщением = 'Messages.txt'
     и / или
     имя файла с датой обновления английской версии сообщения = 'MessagesEng_LastEdit.txt'
     имя файла с английским сообщением = 'MessagesEng.txt'

* - обязательные параметры.
Если вы не используете какой-нибудь режим работы утилиты, то всё равно заполните обязательные поля, при отсутствии файлов на сервере утилита будет нормально работать.


Режимы запуска:
  • Режим - проверка обновлений, сообщений и вывод окон пользователю, если обновилось/появилось сообщение или вышла новая версия программы.
    С такой командной строкой рекомендуется запускать утилиту при запуске вашей программы и при её закрытии.
    Утилита в этом режиме не показывает своё окно, если нет обновления или сообщения.

    Командная строка в этом режиме:

    '0 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+URLtoFile+' '+URLtoMSG


  • Настройка параметров проверок.
    Рекомендуется сделать в вашей программе кнопку "Настроить проверку наличия обновлений" и вызывать утилиту с этой командной строкой при нажатии на кнопку.
    Этот режим используется по умолчанию, если был запуск утилиты без командной строки.

    Командная строка в этом режиме:

    '1 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+URLtoFile


  • Написать отзыв о программе.
    Рекомендуется сделать в вашей программе кнопку "Написать отзыв о программе" и вызывать утилиту с этой командной строкой при нажатии на кнопку.

    Командная строка в этом режиме:

    '2 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+EMail


  • Отправить на указанный вами e-mail описание ошибки и текстовый файл с отчетом.
    Если у вас есть обработчик ошибок, то вы можете сделать в его окне кнопку "Сообщить автору об ошибке" и при нажатии на неё вызывать утилиту с этой командной строкой.
    В этом режиме окна обновлений/сообщений не показываются.

    Командная строка в этом режиме:

    '3 '+ProName+' '+ProVers+' '+Lang+' '+PatchToExe+' '+EMail+' '+PatchToFile


  • Удаление данных утилиты.
    Утилита может хранить свои настройки в папке Application Data (если запись в папку Settings не возможна), для удаления настроек из папки Appication Data нужно вызвать утилиту в этом режиме.

    Командная строка в этом режиме:

    'UnInstall '+ProName

3. Файлы на сервере.

Правила заполнения файлов на сервере:
  • Файл при выходе новой версии программы.

    Имя файла должно быть равно ProName+'_'+ProVers+'.txt' для русского языка и ProName+'_'+ProVers+'Eng.txt' для английского.


    1.1.0.2k.ru.update
    16.08.2010
    http://sbgames.narod.ru/program.html
    43709
    Программа изменилась ))

    Номер новой версии
    Дата выхода новой версии
    Ссылка на страницу с новой версией
    Размер новой версии в байтах
    Описание изменений в новой версии (считывает до конца файла)

    Пример заполненного файла >>>


  • Файл последнего изменения сообщения.

    Имя файла 'Messages_LastEdit.txt' для русского языка и 'MessagesEng_LastEdit.txt' для английского.


    2010.01.21

    Дата изменения (год, месяц, день)

    Пример заполненного файла >>>


  • Файл сообщения.

    Имя файла 'Messages.txt' для русского языка и 'MessagesEng.txt' для английского.

    Файл в формате HTML. Утилита скачивает только этот файл, но если будут вставлены ссылки на изображения с сервера, то они будут показаны в сообщении (но вообще это не рекомендуется))

4. Примеры вызова утилиты с командной строкой для разных языков программирования.

  • Delphi


    uses ShellApi;
    ...
    ShellExecute(0, nil, pChar(ExtractFiledir(paramStr(0))+'\SB.ProgramsTool.exe'), pchar(CmStr), nil, 5);

РУКОВОДСТВО для SB.ProgramsTool 1.0.2