summaryrefslogtreecommitdiff
path: root/plugins/PackUpdater/Docs
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/PackUpdater/Docs')
-rw-r--r--plugins/PackUpdater/Docs/Readme_eng.txt145
-rw-r--r--plugins/PackUpdater/Docs/Readme_rus.txt145
-rw-r--r--plugins/PackUpdater/Docs/Templates/Autoexec_PackUpdater.ini10
-rw-r--r--plugins/PackUpdater/Docs/Templates/File1.ini25
-rw-r--r--plugins/PackUpdater/Docs/ToDo.txt2
5 files changed, 327 insertions, 0 deletions
diff --git a/plugins/PackUpdater/Docs/Readme_eng.txt b/plugins/PackUpdater/Docs/Readme_eng.txt
new file mode 100644
index 0000000000..8dc336f00a
--- /dev/null
+++ b/plugins/PackUpdater/Docs/Readme_eng.txt
@@ -0,0 +1,145 @@
+==================
+Pack Updater 0.1.0
+==================
+
+Miranda IM plugin that do automatic or manual Miranda packs update.
+
+Plugin maybe interesting for packs author, which wants do update of their pack automatically.
+
+0. Changelog
+1. How to use?
+2. How it works?
+3. Copyrights and other
+
+
+-----------------
+0. Changelog
+-----------------
+
+0.1.0
++ now not installed files are not updated
++ added an additional parameter "Force" in the description of the file. With it you an update not installed files
+* Changed FileType parameter type
+
+0.0.9
+* Fixed order in update list
+
+0.0.8
++ Added Icolib support
+
+0.0.7
++ disabled or not existed plugins not updated and not downloaded
++ added FileType 5. It ia as type 4 but without restart
+
+0.0.6
+* All updates shows in one list
+* Fixed bug with no updating files
+* Changeg version comparing algorithm
+
+0.0.5
++ Added x64 version
++ Added Netlib support
++ Added ability to update plugins, icons and other miranda files
++ Added ability to clear folder with downloaded updates
++ Added hotkeys support (Customize-Hotkeys-Pack Updater) as default set Ctrl+F10
++ Added Popup plus actions support
+! Fixed frizing when downloaded files
+* If extension of downloaded file is ".html" it will be opened in browser
+* Fixed activation Apply button even you not change anything
+* Changed name of plugin. now it us PackUpdater
+* Plugin is Unicode now
+* Changed storing format on server - all information about all files stored in one file
+* In Pack for all files - one url for chexking
+* Fixed logic in popups
+- ZeroUpdate.ini not needed anymore, all settings storing in profile
+
+0.0.4
++ Added partly support of popups
+
+0.0.3
++ Added support of Folders plugin
++ Added ability to translate description of update from langpack
+* Changed new version detection
+
+0.0.2
++ Added support of path for dowloaded updates
++ Added ability don't start update automatically
+
+0.0.1
++ Pre-release
+
+--------------------
+1. How to use?
+--------------------
+
+Import settings from Autoexec_PackUpdater.ini to profile and for server (file1.ini) are in Tamplates folder. Probably full langpack in this folder too.
+
+1. Add in your langpack_*.txt strings needed for plugin.
+
+Variables in Autoexec_PackUpdater.ini:
+
+ FileCount - number of files for witch needs to check updates. Plugin supports checking for several files, but most time is only one (Pack setup file)
+
+ AutoUpdate - Check updates automatically with Miranda startup. configured in Events->Pack updates
+
+ File_VersionURL - URL where saved file with infirmation about versions of all files (file1.ini)
+
+[File_x_] (where x - serial number file, begining from 1)
+
+ CurrentVersion - sets 1.0.0 (or another what you wants) and don't change any more
+
+ LastVersion - the same
+
+
+3. Create file with infirmation about versions (file1.ini). One for all checked files
+
+
+Options of file1.ini:
+
+Handle [FileInfo_х], where х - serial number file, begining from 1 (must be equal with number in profile)
+
+
+FileVersion - Current file version (Version of new pack file)
+
+Message - Description that user see when plugin found new version
+
+DownloadURL - URL of Update file
+
+DiskFileName - Name of file saved on user computer.
+
+FileType - type of file. Defines final destination of file. (1 - pack, 2 - plugin (will be installed into Plugins), 3 - icon (will be installed into Icons), 4 - files in miranda root (e.g. langpack, dbtool))
+
+Descr - description witch shows in update list.
+
+InfoURL - Optional. If it writed, message box that user see have button "See information", click on it open this URL.
+
+AdvFolder - Optional. If it writed, set subfolder in folder defined FileType.
+
+Force - Optional. If it writed, the file will be offered for renewal, even if you do not installed.
+
+4. Download file with infirmation and updates on server.
+
+
+--------------------
+2. How it works?
+--------------------
+
+Plugin has two modes: silent and normal. silent is used when checking for updates on startup, normal - click menu item.
+First, plugin downloads file version information and compares the "local" (File_x_CurrentVersion from profile) version with the "remote"
+(FileVersion). If they differ, that:
+a). When you work in silent mode plugin checks the value LastVersion and if it differs from the FileVersion, shows the message about the update.
+if not - there are no messages.
+b). When working in normal mode plugin displays a message in any case.
+If a user downloaded the update, but decided it just did not install, update is still considered to be established.
+
+
+---------------------
+3. Copyrights and other
+---------------------
+
+Plugin written by ZERO_BiT, continued development by Mataes.
+The author is not liable for any damages, the explicit or implied, caused by this plugin. Also wanted to ask not to delete the original copyright.
+
+For questions contacts:
+ e-mail: mataes2007@gmail.com
+ icq: 4618898 \ No newline at end of file
diff --git a/plugins/PackUpdater/Docs/Readme_rus.txt b/plugins/PackUpdater/Docs/Readme_rus.txt
new file mode 100644
index 0000000000..f469d7c07f
--- /dev/null
+++ b/plugins/PackUpdater/Docs/Readme_rus.txt
@@ -0,0 +1,145 @@
+==================
+Pack Updater 0.1.0
+==================
+
+Плагин для Miranda IM, выполняющий автоматическое обновление сборок (паков).
+
+Плагин расчитан, в первую очередь, на создателей паков, которые хотят автоматизировать процесс обновления своих сборок.
+
+0. История версий
+1. Как использовать?
+2. Как оно работает?
+3. Копирайты и прочее
+
+
+-----------------
+0. История версий
+-----------------
+
+0.1.0
++ теперь отсутствующие файлы не обновляются
++ добавлен дополнительный параметр Force в описании файла. С ним можно обновлять отсутсвующие файлы
+* изменен тип параметра FileType
+
+0.0.9
+* Исправлен баг с порядком в списке обновлений
+
+0.0.8
++ Добавлена поддержка Icolib
+
+0.0.7
++ Отключенные или неустановленные плагины большен не обновляются и не загружаются
++ Тип файлов 5. точно такой же как 4, только без перезапуска
+
+0.0.6
+* Все обновления показываются в окне одним списком
+* Поправлен баг с необновлением файлов
+* Изменен алгоритм сравнения версий
+
+0.0.5
++ Добавлена x64 версия
++ Добавлена поддержка Netlib
++ Добавлена возможность обновлять плагины, иконки, ленгпак и прочие компоненты миранды
++ Добавлена возможность очищать папку со скаченными обновлениями
++ Добавлена поддержка горячих клавиш (Тонкая настройка-Горячие клавиши-Обновление сборки) по умолчанию Ctrl+F10
++ Добавлена поддержка действий плагина Popup plus
+! Исправлено замерзание миранды при загрузке файлов
+* Если расширение скачиваемого файла ".html", то он откроется в браузере
+* Исправлен баг с Активацией кнопки применить на странице Всплывающие окна-Обновление сборки
+* Изменено название плагина, теперь - это PackUpdater
+* Теперь плагин стал юникодным
+* Изменен формат хранения данных на сервере - все в одном файле
+* В сборке для разных файлов - одна ссылка
+* Исправлена логика всплывающих окон
+- Убран ZeroUpdate.ini, все настройки теперь в профиле
+
+0.0.4
++ Добавлена частичная поддержка всплывающих окон
+
+0.0.3
++ Добавлена поддержка плагина Folders
++ Добавлена возможность переводить описание файла для загрузки
+* Исправлен показ окна с обновление, даже если версия на сервере меньше текущей
+
+0.0.2
++ Добавлена поддержка путей для сохранения апдейтов
++ Добавлена возможность отключения автоматического запуска скачанного апдейта
+
+0.0.1
++ Собственно, пре-релиз.
+
+--------------------
+1. Как использовать?
+--------------------
+
+Шаблоны всех файлов лежат в папке Templates.
+
+1. Имортируем настройки их Autoexec_PackUpdater.ini в профиль и добавляем в лангпак блок с переводом.
+
+Поясню опции:
+
+ FileCount - количество файлов, для которых нужно проверять апдейты. Плагин поддерживает проверку нескольких файлов, однако чаще всего бавает достаточно одного (сетапа сборки)
+
+ AutoUpdate - Проверять ли апдейты при запуске Миранды. Настраивается в опциях, в разделе События->Обновление сборки
+
+ File_VersionURL - Урл, по которому лежит файл с информацией о версиях для всех файлов(см. дальше)
+
+[File_x_] (где x - порядковый номер файла, начиная с 1)
+
+ CurrentVersion - изначально выставляем в 1.0.0 (или любое другое значение) и больше не трогаем
+
+ LastVersion - то же самое
+
+
+3. Создаём файлы с информацией о версиях (один для всех проверяемых файлов)
+
+
+Описание опций:
+
+Заголовок [FileInfo_х], где х - номер файла, начиная с 1 (должен совпадать с номером, импортированным в профиль)
+
+
+FileVersion - Текущая версия файла (т. е. та, на которую обновляемся)
+
+Message - Сообщение, которое выводит плагин при нахождении этого апдейта
+
+DownloadURL - Урл, по которому лежит собственно файл апдейта (сетап)
+
+DiskFileName - Имя файла на диске.
+
+FileType - тип файла. Определяет конечное его расположение. (1 - сборка, 2 - плагин (будет установлен в папку Plugins), 3 - иконка (будет установлен в папку Icons), 4 - файлы в корне миранды (на пример, langpack, dbtool))
+
+Descr - описание, которое будет выводится в окне обновления.
+
+InfoURL - Опционально. Если присутствует, то в окошке уведомления появляется кнопочка "Смотреть инфо", при нажатии на которую в новом окне откроется эта страница
+
+AdvFolder - Опционально. Если присутствует, то задает подпапку в папке определяемой типом файла.
+
+Force - Опционально. Если присутствует, то файл будет предложен для обновления, даже если отсутствует.
+
+4. Заливаем файл с инфой о версиях и апдейты на сервер.
+
+
+--------------------
+2. Как оно работает?
+--------------------
+
+У плагина есть два режима работы: тихий и обычный. Тихий используется при проверке апдейтов при запуске, обычный - при выборе пункта меню.
+Сначала плагин скачивает файл с информацией о версиях и сравнивает "локальную" (File_x_CurrentVersion из профиля) версию с "удалённой" (FileVersion). Если они отличаются, то:
+а). При работе в тихом режиме плагин проверяет значение LastVersion и если оно отличается от FileVersion, выдаёт сообщение об обновлении, если нет -
+сообщений об отсутствии обновлений не будет.
+б). При работе в обычном режиме плагин выдаёт сообщение в любом случае.
+Если юзер скачал апдейт, но решил сразу его не устанавливать, апдейт всё равно считается установленным.
+
+
+---------------------
+3. Копирайты и прочее
+---------------------
+
+Плагин написал товарищЪ ZERO_BiT, продолжил развитие Mataes.
+Автор не несёт никакой ответственности за ущерб, явный или подразумеваемый, нанесённый этим плагином.
+Также хотелось бы попросить не удалять оригинальный копирайт.
+
+По вопросам обращаться
+ на мыло: mataes2007@gmail.com
+ в аську: 4618898 \ No newline at end of file
diff --git a/plugins/PackUpdater/Docs/Templates/Autoexec_PackUpdater.ini b/plugins/PackUpdater/Docs/Templates/Autoexec_PackUpdater.ini
new file mode 100644
index 0000000000..9375457441
--- /dev/null
+++ b/plugins/PackUpdater/Docs/Templates/Autoexec_PackUpdater.ini
@@ -0,0 +1,10 @@
+[PackUpdater]
+AutoUpdate=b1
+File_VersionURL=uhttp://mataes.googlecode.com/files/Test5.ini
+FileCount=d3
+File_1_CurrentVersion=u0.0.0
+File_1_LastVersion=u0.0.0
+File_2_CurrentVersion=u0.0.0
+File_2_LastVersion=u0.0.0
+File_3_CurrentVersion=u0.0.0
+File_3_LastVersion=u0.0.0 \ No newline at end of file
diff --git a/plugins/PackUpdater/Docs/Templates/File1.ini b/plugins/PackUpdater/Docs/Templates/File1.ini
new file mode 100644
index 0000000000..311c75b3c0
--- /dev/null
+++ b/plugins/PackUpdater/Docs/Templates/File1.ini
@@ -0,0 +1,25 @@
+[FileInfo_1]
+FileVersion = 0.0.1
+Message = "Test Pack"
+DownloadURL = "http://mataes.googlecode.com/files/Miranda%20IM%20Mataes%20Pack%20v0.8.3.exe"
+DiskFileName = "Miranda IM Mataes Pack v0.8.3.exe"
+InfoURL = "http://miranda-planet.com/forum/index.php?showtopic=6121"
+Descr="Test1"
+FileType=1
+Force=1
+
+[FileInfo_2]
+FileVersion = 0.0.1
+Message = "Test Plugin"
+DownloadURL = "http://mataes.googlecode.com/files/Test_Plugin.dll"
+DiskFileName = "Test_plugin.dll"
+Descr="Test2"
+FileType=2
+
+[FileInfo_3]
+FileVersion = 0.0.1
+Message = "Test Icon"
+DownloadURL = "http://mataes.googlecode.com/files/Test_Icon.dll"
+DiskFileName = "Test_Icon.dll"
+Descr="Test3"
+FileType=3 \ No newline at end of file
diff --git a/plugins/PackUpdater/Docs/ToDo.txt b/plugins/PackUpdater/Docs/ToDo.txt
new file mode 100644
index 0000000000..50100bcc4c
--- /dev/null
+++ b/plugins/PackUpdater/Docs/ToDo.txt
@@ -0,0 +1,2 @@
+1. add second variant of update - external app.
+2. add updater support (maybe). \ No newline at end of file