Read Me for Weather Protocol v0.3.2.13



*** NOTICE ***
Starting from v0.3.1.5, the ini's will not be included in the download package.  You must
download them seperately from the plugin download page, or just simply search for
"Weather" in the file listing.

Currently available INI's (Alphabetical Order):
GISMETO.ru (by 3OJIOTO)
Weather Channel XML (by sirius)
Weather Underground (by noname)
Yahoo Weather (by noname)
>> Search for more


File Content Features Latest Changes Files Included System Requirement Installation Frequently Asked Questions
Features - Retrieve weather information and display them on your Miranda contact list. - Provide a contact information page for viewing the current weather conditions. - Display PopUp when information is retrieved. - Log weather conditions to a file or in history. - Quick links for viewing complete forecast and weather maps. Latest Changes Version 0.3.2.13 2004/05/08 - Changed some linker options to prevent plugin not loading Version 0.3.2.12 2004/05/08 - Assign fog icon to the sand conditions Version 0.3.2.11 2004/05/07 - Really ignore the "Ignore" item in the ini file - Fix crash when unloading ini's (at reload or shutdown) - Change in weather alert popup - Few minor changes Version 0.3.2.10 2004/05/02 - Rebuild using Visual C++ Version 0.3.2.9 2004/04/29 - Attempt to fix crash when searching for cities by name - Display a list of custom variables - Fix memory leak when reloading strings from ini files - Changes in the code for parsing weather info and loading ini files - Other minor changes Version 0.3.2.8 2004/04/28 - Fix on loading ini strings, support for v1.1a again - Fix in weather station search - Fix crash when not connected to internet - Add a new debug function (need DB Editor) - A few other minor fixes and changes Version 0.3.2.7 2004/04/19 - Fixing the crash on startup bug one more time :( Version 0.3.2.6 2004/04/19 - Attempt to fix an crash on startup bug again. - Temporary remove support for v1.1a of the INI file. :( Version 0.3.2.5 2004/04/19 - Attempt to fix an crash on startup bug. Version 0.3.2.4 2004/04/19 - Fix some error while loading weather ini file. - Obtain station name from the net in edit dialog. - Display N/A when temperature is unavail. and the string retrieved is not "N/A" - Some minor changes. Version 0.3.2.3 2004/04/18 - Automatically suppress online notification for all weather contact when upgrade. - Fixed crash when adding new contact. - Fixed crash when importing contact using mContacts. - Some minor changes. Version 0.3.2.2 2004/04/18 - Change the way weather handles status, now properly display NA for def stn. - Protocol status can be changed freely if "Do not display weather conditions as protocol status" is enabled. - More memory leak fixes and crash fixes. Version 0.3.2.1 2004/04/17 - Reduce memory use by more than 60% and fixed some memory leaks - Support a revision of v1.1 ini file (the length string now can be unlimited) - Incrase the maximun text length to 4k (but try keep it as short as possible) - A few minor fixes and changes - Updated readme file. Version 0.3.2.0 2004/04/12 - Support new variable %% (same as \%) and %[..] (see here) - Now with the complete support of weather INI v1.1 (more detail here) - Very basic support of weather alert notifications if the INI supports it (see here) - Add browse, view webpage, and reset to default buttons edit settings dialog - Interface changes and fixed tab order for all dialogs - Display information for the weather INI files - Some other monor changes and fixes - Updates Read Me, and now it is in HTML format. For a somewhat more complete but messy history, look here. Files Included - plugins\weather.dll - The core to the weather plugin. Required component - langpack_defweather.txt (stored in the documentation folder by default) - Langpack for weather icon assignment, containing documentation - plugins\weather-doc\*.txt, *.ini - Documentation directory includes readme, translation, and sample files Note for advanced users: For the format of icon assignment langpack file, please refer to langpack_defweather.txt For the format of the update ini's, please refer to sample_ini.ini in the documentation. System Requirement - Miranda IM (v0.3.3.0 or later) - Weather icons - Numerous choices available in icon downloads. - PopUp plugin by Hrk or PopUpPlus plugin by zazoo (Recommended: latest version) Installation For installation of weather protocol, it is recommended for installing it using Miranda Installer. For manual installation, please following these steps: 1. Copy weather.dll into plugins directory. 2. Get the ini's from file listing and place them into plugin\weather directory. 3. If you want external file for status icon selection, copy the content of langpack_defweather.txt into your language pack and (optionally) enable "Disable internal icon selection" from the option page. IMPORTANT UPGRADE NOTICE Due to the changes made in this version, Weather 0.3.x is not compatible with older releases (v0.2.x). Therefore, you should delete your weather contacts before upgrading to this new version. Frequently Asked Question I have remove all the other sections for the readme and add this FAQ section that contains all the necessary information. These question are the one I think the most important and the ones that has been asked in the forum quite a few times. Q1. How do I add new stations? A1. Use the find/add dialog box. You can either search for station ID (see the readme for the ini file to see how it can be obtained) or search by city name by entering the name in either one of the Nickname, Firstname, or Lastname field. Q2. I can't find my station! Any help? A2. Make sure you have installed the plugin and ini file correctly. At least one INI file must exist in the plugins\weather directory in order for the plugin to funciton properly. For more information, click here. Q3. I have installed the plugin properly, and it still doesn't work. I have noticed that there is no traffic generated by the plugin. A3. Check you proxy setting, some proxy does not work properly under Miranda IM 0.3.3.0. If your proxy is having problem connecting, you need to upgrade to Miranda IM 0.3.3.1 or try the nightly builds (Note: They are experimental builds!) Also, if you are using traffic counter plugin, please make sure that you are using the latest version. The old version stops Weather and some other plugin from working. Q4. What are those INI files for? A4. The INI files contain information for downloading and parsing weather information from a particular weather station. At least one INI file must exist for the plugin to work. For a list of available INI's, click here. Q5. Can I install or modify the INI files without restarting Miranda? A5. Yes. After finish making the changes, choose: M (main menu) -> Weather -> Reload Weather Data Q6. I want to retrieve weather information from a different source. How can this be done? A6. You can write your own INI file. For more information, click here. Q7. I wrote/downloaded an ini file that retrieve weather in (a language) and weather protocol doesn't seems to reconize the weather conditions and assign icons for them. A7. You can use translation string for assigning the icons. For more information, click here. Q8. Can I hide Weather from status bar and protocol menu? A8. Go to Options->Plugins->Weather, enable "Hide Weather in status bar and status menu". Q9. I can't find Weather in the icon option drop-down list. How can I change weather icons? A9. Weather icon cannot be changed if "Hide Weather in status bar and status menu" is enabled. To change icon, disable the option (see A7), make your change, then re- enable it. Q10. How does weather assign status icons for each status? A10. Online = Sunny Away = Partly Cloudy NA = Cloudy Occupied = Rain DND = Rain Shower Free for Chat = Snow / Wintery Conditions Invisible = Lightning / Thunderstorm On the Phone = Snow Shower Out to Lunch = Fog / Haze Offline = No Data Available Q11. I can't find the options for changing display text. A11. Go to Options->Plugins->Weather, then click on the icon beside "Change display texts" Q12. Does weather protocol retreve weather forecasts? A12. Support of this feature depend on the ini file you use. If it is supported, the most likely variable you use for it is %[Forecast Day #] where # is the day you want the forecast for. See the readme of the inidvidual INI file for more information. Q13. How long should the time between update be? A13. This depend on the update interval on the website. Generally, this field should set to a value between 10 to 30 minutes. If the value is too small, a lot of traffics will be generated by the protocol. Q14. How can I temporary disable weather procotol? A14. Switch the weather status to OFFLINE, but this will not work if you have "Do not display weather condition as protocol status" option enabled. To enable the protocol again, switch it to a status other than OFFLINE. Q15. How can I change the display name of my city? A15. Right-click on the city and select "Edit Settings". Change the field "Description" to the new display name. Q16. How can I change the default station? A16. Use the Edit Settings dialog (See A15). Note that only 1 station can be default. Q17. What is the %[..] variable for? A17. They are the custom variables. Replace the ".." with a setting name that can be found in \Weather in the database. For more information about the availability of the settings, use Database Editor or refer to the readme of the ini file. Q18. Why are the name of some weather contacts italic on my contact? A18. There are weather alerts issued for those cities. To see the alert title, use the %[Alert] variable. Q19. What are the "Extra Text" for? A19. The field has no use internally. However, it can be useful for some other plugin to obtain a weather information string that is already parsed. Q20. I want weather protocol to have the same status as the other protocols. Is such option available? A20. Enable the option "Do not display weather condition as protocol status", then you will be able to change the status freely. Q21. Is there any beta version of Weather Protocol available? A21. Some beta version are posted in here occasionally. However, please backup your database before trying those versions. Q22. There are some status that the weather plugin doesn't seems to reconize and always shows as N/A on the contact list. What can I do? A22. If you encouter this problem, notify me (see Q23) and try use a langpack translation if you wish until the updated version is released. Q23. I have some question about the plugin that is not covered here, how can I contact you? A23. PM "noname" or post a message on the Miranda IM forum before I fix my sf e-mail ;)