From a70382b0e8bed265a1d314d9f6aae8f2dd48d20b Mon Sep 17 00:00:00 2001 From: George Hazan Date: Wed, 28 Nov 2012 18:45:54 +0000 Subject: ex-protos moved to the Plugins folder git-svn-id: http://svn.miranda-ng.org/main/trunk@2545 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c --- plugins/Weather/docs/license.txt | 340 +++++++++++ plugins/Weather/docs/sample_ini.ini | 421 ++++++++++++++ plugins/Weather/docs/weather-history.txt | 930 +++++++++++++++++++++++++++++++ plugins/Weather/docs/weather-readme.html | 230 ++++++++ 4 files changed, 1921 insertions(+) create mode 100644 plugins/Weather/docs/license.txt create mode 100644 plugins/Weather/docs/sample_ini.ini create mode 100644 plugins/Weather/docs/weather-history.txt create mode 100644 plugins/Weather/docs/weather-readme.html (limited to 'plugins/Weather/docs') diff --git a/plugins/Weather/docs/license.txt b/plugins/Weather/docs/license.txt new file mode 100644 index 0000000000..45645b4b53 --- /dev/null +++ b/plugins/Weather/docs/license.txt @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/plugins/Weather/docs/sample_ini.ini b/plugins/Weather/docs/sample_ini.ini new file mode 100644 index 0000000000..dc36eda754 --- /dev/null +++ b/plugins/Weather/docs/sample_ini.ini @@ -0,0 +1,421 @@ +[Weather 0.3.x Update Data 1.4] + +; This file contains the information required for the weather protocol to obtain update. +; For the plugin to function properly, at least one of these file must be present. +; The proper location of these files is: plugins\weather + +; Note that for the entire file, DO NOT put spaces before or after the "=". The groups +; and setting names (for example, [Header] and Name) are not case sensitive; however, +; the values set for each settings ARE case sensitive. + +; Also note that the first line of this file must be either one of the following: +; [Weather 0.3.x Update Data] (min. req. v0.3.0.0) +; [Weather 0.3.x Update Data 1.1] (min. req. v0.3.1.8) +; [Weather 0.3.x Update Data 1.1a] (min. req. v0.3.2.8) +; [Weather 0.3.x Update Data 1.2] (min. req. v0.3.5.0) +; [Weather 0.3.x Update Data 1.3] (min. req. v0.3.8.0) +; [Weather 0.3.x Update Data 1.4] (min. req. v0.3.8.12) + +; Minimun version for not crashing Miranda (Set to this version to prevent the ini from +; loading in an old version of weather plugin and crash Miranda) +; 1.1a String longer than 256 characters. +; 1.1 More than 16 data items in the ini +; Not using [/...] footer at the end of the list +; 1.0 All other features + +; Minimun version for using the new features (Set to this version to prevent invalid data +; for user with old version of weather plugin. However, the other features still works) +; 1.4 Using "Cookie=" +; 1.3 Using "Update Url2=" & "Update Url3=" +; 1.2 Using the operation "Break Data=" +; Using the setting "Hidden=" for each data item +; Assign weather icons from ini +; 1.1a Support for the units: Day, Month, %, Deg, Cond +; 1.1 Using the operation "Set Data=" +; 1.0 All other features + +; Revision history: +; 1.4 (Updated in v0.3.8.12) +; New "Cookie=" +; 1.3 (Updated in v0.3.8.0) +; New "Update Url2=" & "Update Url3=" +; 1.2 (Updated in v0.3.5.0; minimun req. v0.3.5.0) +; New operation "Break Data=" +; New setting "Hidden=" that hide the data item from the mor data list +; Weather icon assignment from the ini +; 1.1a (Updated in v0.3.4.0; minimun req. v0.3.2.8) +; Support for Day, Month units +; 1.1a (Updated in v0.3.3.0; minimun req. v0.3.2.8) +; Support the %, Deg, Cond units +; 1.1a (For v0.3.2.8; minimun req. v0.3.2.8) +; Now the string can be unlimited long (at least when it's within 4096 characters) +; 1.1 (For v0.3.2.0; minimun req. v0.3.1.8) +; No more need to use [/...] headers (now it just like a normal INI file) +; Support more weather data, and the number of data is no longer limited to 16 +; New operation "Set Data=" that assign data items without download the info +; 1.0 (For v0.3.0.0; minimun req. v0.3.0.0) +; Initial version. + +; ====================================================================================== + +; INI Headers + +[Header] +; The name field contains the string that will appear to the user. Please be unique. +; (for example, "Yahoo Weather") +Name= + +; The internal name is the string that will be used to set the weather ID, and are used +; internally to obtain the weather update information. This string should be short and +; unique. +; (for example, "yw" for "Yahoo Weather") +Internal Name= + +; The following 3 fields are used in the plugin for INI information only, but it also +; gives user some information about the file. +Description= +Author= +Version= + +; For the following three default fields, %s is used for station ID (the one with the +; internal name taken away, for example, CAXX0001) +[Default] +; The default URL for getting more weather information from contact menu or brief info +; dialog. This setting is the default one assigned to the weather contact when it is +; added, but can be changed by user in the Edit Settings dialog. +Default URL= + +; The default URL for getting weather map from contact menu. Same as above. +Default Map= + +; The URL for retrieving weather updates. +Update URL= +Update URL2= +Update URL3= +Update URL4= + +; Set cookie(s) when retrieving weather updates. +Cookie= + +; ====================================================================================== + +; Weather Data Fields + +; The following section list the data fields that are used to assign the data to be stored +; in the database. These fields should be placed in the order of appearance in the +; download information. For each item searched, the string before the item are discarded +; so if the order is wrong, no information can be obtained from the latter item. + +; Format (not all settings are necessary): +; [Field Name] +; Start= +; End= +; Set Data= +; Break Data= +; Source= +; Unit= +; Hidden= + +; Default Fields: +; [Condition] Current condition, to assign condition icon +; [Update] For display of the update time of the weather data +; [Temperature] Current temperature +; [Feel] Feel-like temperature +; [High] Today's high +; [Low] Today's low +; [Sunrise] Sun rise time +; [Sunset] Sun set time +; [Wind Direction] Wind direction (not including speed) +; Be careful to consider the no wind situation (ie. calm) +; [Wind Speed] The speed of the wind +; [Pressure] Barometer pressure +; [Visibility] Visibility, if the value is 0 or non-numerical value, then unit conversion +; for this will not run and original string is retained +; [Humidity] Humidity, without a % sign. + +; Special Fields: +; [Alert] +; Special item for weather alert. +; If the data retrieved for this field is non-empty, then a special alert popup will +; display and the city on the contact list will be in a special state (using the +; setting for "Contact to whom you have a different visibility". +; This will be reset to normal once the alert field becomes empty. +; [Ignore] +; Special item for the plugin to ignore what the value it gets and all errors when +; getting it. The value obtained for this field will not be written into the +; database, and no popup and notification will be raised. This is useful to skip +; some specific text or end the download script. Multiple placement of this field +; is allowed. +; Note: For prevent the popup of error message, v0.3.2.11 is required + +; Custom Fields: +; [%name%] +; Where %name% can be any string you want. + + +; Settings: +; Settings for obtaining data: "Start=", "End=", "Set Data=", "Break Data=", "Source=" + +; There are 3 ways for the plugin to obtain the information string: +; 1. Parse directly from the webpage by specifying start and end strings. Note that these +; strings are case sensitive. + +; When parsing the information, the following items are removed: +; HTML tags example: +; symbols example:   +; linefeed and tabs +; multiple spaces, spaces at the beginning and at the end of the string +; Also, if the start field is blank, that means the information starts immediately +; after the string from the last "End=" field. If the end field is blank, that means +; the information ends at the first space the plugin encounters (even if it is inside +; a HTML tag). + +; An example, for parsing +; "Partly   Cloudy +; The code to give "Partly Cloudy" (without quotation): +; [Condition] +; Start= +; End= + +; 2. Concatenate strings, using "Set Data=", can merge various string together by placing +; them around the operator " & " (without the quotation mark but with the 2 spaces). +; For the variable strings (ie. the data item retrieved previously), use [] +; For constant strings, use "" + +; For example, merging two condition strings "Condition 1" and "Condition 2": +; [Condition] +; Set Data=[Condition 1] & " and " & [Condition 2] + +; Another example, copy the content of "Condition +; [Copy of Condition] +; Set Data=[Condition] + +; 3. Break a string into 2, using "Break Data=", by specifying the string in between the +; two substrings. The first half will store into the name specify by the header, and +; the second half will be specified by "End=" + +; An example, to reverse what we did in Example 2 (the two condition strings): +; [Condition 1] +; Break Data= and +; Source=Condition +; End=Condition 2 + +; Other Settings: +; Unit= +; Specify the unit for the data, for use in unit conversion. The conversion to use +; depends on the value assigned. +; For temperature conversion: C, F, K +; For speed conversion: km/h, m/s, mph, knots +; For pressure conversion: hPa, kPa, mb, torr, mm, in +; For distance conversion: km, miles +; For adding a percent sign at the end: % +; For adding a degree sign at the end: Deg +; Convert condition str to proper case: Cond +; For weekday string length: Day +; For month string length: Month + +; Hidden= +; Acceptable values: true, false +; Using this on any field will prevent it from being displayed in the "More Info" +; list, but its value will still be stored in the database. + +; Url= +; Acceptable values: 1, 2, 3 +; Specifies the url on where to look for data item +; If parameter is not specified item is searched on all urls, the last found will be used + +; Here's an example: +[Condition] +Start= +End= +Unit=Cond + +[Temperature] +Start= +End= +Unit=C + +[Humidity TEMP] +Start= +End= +Hidden=true + +[Humidity] +Set Data=[Humidity TEMP] & "%" + +; - or - + +[Humidity] +Start= +End= +Unit=% + + +; ====================================================================================== + +; The setting for find and add contacts. + +; ID search is used when the user type in the ID in the "Station ID" field and pressed +; "Search" +[ID Search] + +; This can be "true" or "false" (without quotation, not case sensitive) +; If this is set to "false", all the following strings are ignored and the ID are NOT +; going to search for this weather service. +; If this field is set to FALSE, no matter what the user type for station ID, the +; plugin will always return a result with station name empty and ID the same as what +; the user has typed. +Available= + +; The URL for ID search. Note that %s is used for placing the ID. +Search URL= + +; The string appeared in the downloaded information when there is no match +; (ie. "Document not found") +; If this string is found while searching, the search process quit and return no result. +Not Found Str= + +; Similar to weather information retrival above. This is the string preceeding the +; station name obtained from searching. Note that the parsing is the same as above, and +; spaces can be used. +Name Start= + +; This is what's after the station name. +Name End= + +; END ID SEARCH + +; Name search is used when the user type in any of the name field (Nick, First, Last) and +; click on the "search" button. +[Name Search] + +; This can be "true" or "false" (without quotation, not case sensitive) +; If this is set to "false", then the plugin igmore the information stated in the Single +; fields (ie. from "Single Name Start" to "Single ID End") +Single Result= + +; This can be "true" or "false" (without quotation, not case sensitive) +; If this is set to "false", then the plugin igmore the information stated in the Multiple +; fields (ie. from Multiple Name Start" to Multiple ID End") +; Note that if both single and multiple are disabled, the Name search are disabled for +; this weather service. +Multiple Result= + +; The URL for doing the name search. %s will be replaced by the station name input from +; the user. +Search URL= + +; The string appeared in the downloaded information when there is no match +; (ie. "Document not found") +; If this string is found while searching, the search process quit and return no result. +Not Found Str= + +; This field determines whether the search will return a single result or multiple result +; If the string stated in this field is found and Single Result is enabled from above, the +; settings for single result will be used. Otherwise, the settings in multiple result +; will be used. +Single Result Str= + +; These fields are for the single result + +; Determine which item is the first to appear in the download search result file +; This field can be ID or Name (not case sensitive). +; For example, if ID is used here, it means that station ID appears before the station +; name in the downloaded document. +Single First= + +; The start and end string for station name. Parsing using the same way as discribed +; above for weather information. +; Note that if both fields are empty, then whatever the user type into the search field +; will be used for the station name. +Single Name Start= +Single Name End= + +; The start and end string for station name. Parsing using the same way as discribed +; above for weather information. +Single ID Start= +Single ID End= + +; The multiple result is similar to the single result as described above. +; For this search, the plugin will loop until no more Name's and ID's can be founded +; in the downloaded file. +Mult First= +Mult Name Start= +Mult Name End= +Mult ID Start= +Mult ID End= + +; END NAME SEARCH + +; For a workaround of URL forwarding issue: +; If the page retrieved contains URL forward (ie. the 302 code), the download content +; will appears as: +; Moved/Location: +; This might be useful for writing the start/end string settings for the single result +; Name Search. +; A typical use of this is: +; Single Result Str=Moved/Location: +; Single First=ID (this isn't really matter) +; Single Name Start= +; Single Name End= (this will use whatever user type in as stn name) +; Single ID Start=/newpages/ (what's before the station ID in the URL) +; Single ID End=.html (what's after the station ID) + +; ====================================================================================== + +; INI Defined Icon Assignments (new in v1.2) + +; These assignment will take the highest priority (before the internal and the langpack +; defined assignment) when matching the condition (icon) to the current condition. +; These settings are INI specific, which means that the setting in one INI will not affect +; the stations that are associated to another INI. + +; Format: +; {icon name}={string to search} + +; The "icon name" is the icon to assigned with the condition string containing the string +; specified in "string to search" is found. + +; Available icon names are (in order of assigning priority): +; Lightning, Fog, Snow Shower, Snow, Rain Shower, Rain, Partly Cloudy, Cloudy, Sunny, N/A + +; For examples, mimicking what internal icon selection and langpack_defweather do (of +; course, putting these in an actual INI is not needed and is waste of space and memory). + +[Icons] +Sunny=Sunny +Sunny=Clear +Sunny=Fair + +Partly Cloudy=Mainly Sunny +Partly Cloudy=Mainly Clear +Partly Cloudy=Partly +Partly Cloudy=Mostly +Partly Cloudy=Clouds + +Cloudy=Cloudy +Cloudy=Overcast + +Rain=Drizzle +Rain=Rain + +Rain Shower=Rain Shower +Rain Shower=Shower + +Snow=Snow +Snow=Ice +Snow=Freezing +Snow=Wintery + +Snow Shower=Snow Shower +Snow Shower=Flurries + +Ligntning=Thunder +Ligntning=T-storm + +Fog=Fog +Fog=Mist +Fog=Smoke +Fog=Haze +Fog=Sand +Fog=Dust diff --git a/plugins/Weather/docs/weather-history.txt b/plugins/Weather/docs/weather-history.txt new file mode 100644 index 0000000000..ff936f56f2 --- /dev/null +++ b/plugins/Weather/docs/weather-history.txt @@ -0,0 +1,930 @@ +Weather Protocol - Version History +================================== +Version 0.3.8.19 2011/09/03 + - Fixed Brief window update on weather station update + - Fixed No ini window no show + +Version 0.3.8.18 2010/08/20 + - Specialized translations for all weather conditions + - Fixed possible crashes + +Version 0.3.8.17 2010/05/29 + - Added possibility to add specialized translations for weather conditions + format: #condition Weather + - Added 32x32 icon support + - 32x32 icon is used in a frame in a frame if no avatar present + - Added support for Miranda 0.9 persistent http trasactions + - Changed Breif dialog appearence + - Fixed translation issues + - Fixed keyborad navigation in UserInfo dialog + - Requires Miranda 0.8 or higher + +Version 0.3.8.16 2009/08/09 + - Increased allowed size of station id + - Removed built-in support for HTTP compression (compression not supported with pre 0.8 Miranda any longer) + - Fixed crash with no ini files + - x64 port + +Version 0.3.8.15 2009/03/22 + - Added support for gif avatars + - Added support for 4 urls per ini + - Added supoort for html metadata (utf8) + - Fixed rounding with fractional reading display + - Added more http redirection support + - Allow to draw forced avatar in frame + +Version 0.3.8.14 2009/01/10 + - Fixed Set Data failures + - Fixed crashes with http + - Fixed http errors processing + - Added support for temperature in format - + +Version 0.3.8.13 2008/12/25 + - Changed search UI to have more descriptive labels + - Documentation updates + +Version 0.3.8.12 2008/12/22 + - Added support for cookies (cakes and ice cream) + +Version 0.3.8.10 2008/12/07 + - Fixed temperature display + +Version 0.3.8.9 2008/12/06 + - Added support for deflate compressed http streams + - Fixes for weather crashes + - Added option to round all values to nearest integer + +Version 0.3.8.8 2008/11/22 + - Improved formatting for numerical values + - Fixed crashes due to compressed http stream + - Added support for gzip encoded http stream + +Version 0.3.8.7 2008/08/02 + - Fixed crash for people measuring speed in km/h + +Version 0.3.8.6 2008/08/01 + - Added display fraction of temperature and wind speed when available + - Added handling of UTF8 pages (needed for GisMeteo) + +Version 0.3.8.5 2008/07/27 + - Fixed option dialog layout + - Fixed ini version display + - Fixed memory leak with multiurl ini + - Fixed plugin version number + +Version 0.3.8.3 2008/07/24 + - Fixed url tag + - Added headers to variable view + - Fixed options dialog layout + +Version 0.3.8.2 2008/06/08 + - Fixed ini version display in User Info + - Fixes for wind in Weather Underground ini to work correctly + +Version 0.3.8.1 2008/05/25 + - Added ability to parse upto 3 URL per ini file for weather data + - Fixed break data and parameters with units + - Added ability to skin weather frame with clist_modern ("Main,ID=WeatherFrame") + - Added display "nickname" in the first line of the frame + - Added avatar display in the weather frame + +Version 0.3.7.2 2008/01/19 + - Fixed updates in normal mode + - Fixed option dialog layout + +Version 0.3.7.1 2007/12/22 + - Partial workaround for core HTTP problem + - Tabbed option dialog + +Version 0.3.7.0 2007/12/21 + - Added icolib support + - Added frames support + - New icons by Angeli-Ka + - Compatible with Miranda 0.7 and later + +Version 0.3.6.5 2007/08/17 + - Workaround for tray icon + +Version 0.3.6.4 2007/07/27 + - Fixed caching problems + +Version 0.3.6.3 2007/07/08 + - Fixed error message at stratup (with updater) + - Increased possible weather variable size + - More generic couldy definition + +Version 0.3.6.2 2007/06/02 + - More sensible autoupdate Enable/Disable operation + +Version 0.3.6.1 2007/06/01 + - Fixed popup click action + - Fixed translation + +Version 0.3.6.0 2007/05/18 + - New icons by Angeli-Ka + - Protocol icons split into separate dll + - Option dialog and menus redesign + - Instant avatar update + - Ini file display name now used as client ID (MirVer) + - Moved ini file list into View/Change My Details + - Support for new plugin interface + - Fixed few parsing issues + +Version 0.3.5.19 2007/01/27 + - Fixed translation + +Version 0.3.5.18 2007/01/26 + - Fixed translation + - Fixed resource leaks + - Fixed crash + - Partial unicode support + +Version 0.3.5.17 2007/01/20 + - Reduced GDI resource utilization + - Fixed memory leak with old ini files + - Fixed search function for stations with special characters + +Version 0.3.5.16 2006/11/27 + - Fixed units conversion + - Fixed memory corruption + - Added ability to show clickable links in Brief window + +Version 0.3.5.15 2006/11/16 + - Fixed web page parsing (Wind Speed in Yahoo) + - Fixed "No wind" condition handling + - Performance improvments for HTTP transfers + - Fixed memory corruption + +Version 0.3.5.14 2006/10/31 + - Fixed status message operation + +Version 0.3.5.13 2006/10/29 + - Fixed non english alphabets operation + - Fixed Weather condition update issues + - Added option to keep station status from reflecting weather condition + (should resolve avatar overlay problems with clist modern) + - Moved Weather main menu entry into the protocol group + - Improvements for forecast window sizing + +Version 0.3.5.12 2006/07/23 + - Fixed non english alphabets operation + +Version 0.3.5.11 2006/07/22 + - Fixed text corruption + - Added ability to display avatars for each weather condition + - Fixed Win95 operation + +Version 0.3.5.10 2006/07/16 + - Changed Current Date/Time display (%d) according to locale + - Changed handling of HTTP redirect requests + +Version 0.3.5.9 2006/04/08 + - Fixed misplaced buttons on forecast view window + - Fixed weather history incorrect source + - Fixed incorrect PopUp notification text in the menu + +Version 0.3.5.8 2005/09/20 + - Fixed automatic set of deafult station logic failure and as a result crash at power-up + - Fixed INI info dialog layout and ini version information + - Fixed rare crash on exit + - Fixed resource leak + - Fixed few memory leaks + - Fixed crash at power-up with corrupted ini file + - A lot of code robustness updates + +Version 0.3.5.7 2005/09/18 + - Fixed few resource leaks + - Fixed gloabal status + - Fixed weather alert format + - Fixed very rare crash on exit + +Version 0.3.5.6 2005/09/14 + - Fixed few crashes on exit and + - A lot of code robustness updates + - Updater compatibility + - Fixed resource leaks + +Version 0.3.5.5 2005/09/11 + - Fixed crash on exit + - Support for custom "Status Messages" + +Version 0.3.5.4 2005/09/08 + - Fixed crash in my User details + - Fixed endless "updating user info ..." + - Fixed search function regression + +Version 0.3.5.3 2005/09/07 + - Fixed crash at Powerup + - Fixed crash on Miranda exit + - Fixed numerous other crashes + - Fixed numerous memory leaks + - Fixed memory corruption + - Fixed resource leak + +Version 0.3.5.2 2005/09/07 + - Fixed crash on Miranda exit + - Fixed numerous other crashes + - Fixed numerous memory leaks + - Fixed memory corruption + - Fixed resource leak + +Version 0.3.5.0 2005/03/21 + - New Option: Disable update on startup + - New Option: Enable/Disable popups by type: update, alert, error + - INI Option: Support breaking string + - INI Option: Support hidden fields + - INI Option: Support icon assignment from ini + - Updated sample_ini.ini and translation + - Some other minor changes that I can't remember + +Version 0.3.4.4 2004/12/28 + - Load window list correctly, fix problem with brief info and edit dlg not showing + - Some internal changes with new service functions + +Version 0.3.4.3 2004/12/26 + - Minor change in INI loading + +Version 0.3.4.2 Beta 2004/12/16 + - Bug fix: Miranda cannot quit after forkthread is used + - Bug fix: The unit % does not work anymore + - Bug fix: No longer crash when the link settings is not set + - Update the weather ini download link to the new location + +Version 0.3.4.1 Beta 2004/12/09 + - ESC now works in weather dialogs + - More changes to forkthread + - Document updated: weather-translation, sample_ini + +Version 0.3.4.0 Beta 2004/11/21 + - Change the threading to forkthread + - New option: Custom status when condition is unavailable + - New option: Convert day/month string into 2 char or 3 char format + - Some internal changes + - Minor change in ini format + +Version 0.3.3.17 2004/11/19 + - Condition translated correctly when writing into database + - Correctly restore the windows position for edit setting dialog + +Version 0.3.3.16 2004/11/10 + +Version 0.3.3.15 2004/10/21 + - Remember the window position for edit settings dialog + - Minor change in dialog (I still can't get the close on ESC to work...) + +Version 0.3.3.14 Beta 2004/10/20 + - Fix the crash in option page bug (hopefully) + - Fix the support for \n in text input + - Minor change in dialog + +Version 0.3.3.13 2004/10/16 + - Another fix for default station + - Some changes to reduce database read/write for default station changes + - Now the plugin is correctly registered in known module list for DBEditor++ + - Save the setting for popup and update enable/disable directly after menu click + - Some update in readme, more changes in translation (thanks smyle again) + +Version 0.3.3.12 2004/10/16 + - Fix 2 possible crashes regarding default station + +Version 0.3.3.11 2004/10/15 + - Fix a bug with global status + - Updated translation list (thanks smyle) + +Version 0.3.3.10 2004/10/14 + - Changes in default station handling, hopefully will fix a crash in option page + - Add new sound event: Weather alert + - Add new menu item: Add new weather station (call up the find/add dialog) + - Document updated: weather_translation.txt + +Version 0.3.3.9 2004/09/26 + - Some changes in code. + +Version 0.3.3.8 2004/09/24 + - Now uses default system text for brief info and setup dialog. + +Version 0.3.3.7 (Beta) + - Test releases for crash in option page + +Version 0.3.3.6 2004/09/24 + - Add a sound event when weather condition is updated + - Use the default system color for brief info and setup dialog + - Minor change in unit conversion + - Fix in brief info when there is no data for current conditions + - Add entry to Database Editor++ known module + +Version 0.3.3.5 2004/08/14 + - Fix apply button in option pages + - Fix "Humidity" in default settings + - Ignore the sample ini file if it is placed in plugin\weather dir + - Minor changes in update timer and option dialog + +Version 0.3.3.4 (Beta) 2004/07/23 + - Fix some bug in text option + - Take proto_weather.dll icon into account when auto-assigning icon + - Option to disable automatic icon assignment + - Few minor changes + - Document updated: weather_translation.txt + +Version 0.3.3.3 2004/07/21 + - Automatically set to default weather icon if no custom one is set + - Add a ini setup information dialog to help setup weather protocol + - Update in brief info now retrieve new data from the internet + - Few minor changes + - Document updated: weather_translation.txt + +Version 0.3.3.2 (Beta) 2004/07/14 + - Show error detail on update errors + - Includes simple set of 16-colors weather icons in the dll file + - Option to disable italic display for station with alert issued + - Option to disable warning dialog if ini is not found at startup + - Attempt to fix the black bar bug in brief info + - Fix the bug that shows connecting as weather status + - Document updated: weather_translation.txt + +Version 0.3.3.1 2004/06/19 + - Minor change in the brief info dialog + - More info items are now translatable + - Case conversion in condition to make them translatable (use unit: Cond) + - Save window size for the brief info dialog + - Fix crash when invalid ID or ini file for the station is not found + - Few minor changes + - Document updated: sample_ini + +Version 0.3.3.0 (Beta) 2004/06/12 + - A new feature that erase old data while updating for new data + - A change in the brief information dialog (thanks micron-x for last seen plugin) + - Double click a contact shows brief info dialog (thanks Matrix and JdGordon) + - Add brief info title setting + - Change in the weather, text, and popup options dialogs + - Add reset to default and preview for all display text field + - Change the way the plugin handles protocol status + - Enable/disable auto-update from the main menu + - Reconizes dust conditions and assign a fog icon (thanks Klenje) + - Support the units "%" and "Deg" + - Fix a crash if miranda32.exe is renamed + - Fix crashes in between updating of 2 stations (thanks Targaff) + - Update links in the readme and DLL to the new weather category (thanks lynlimz) + - Other bug fixes and minor changes + - Document updated: weather-translation, langpack_defweather, sample_ini + +Version 0.3.2.16 2004/05/27 + - Reconizes condition in lower case + - Few changes. + +Version 0.3.2.15 2004/05/24 + - Now reconizes the condition string "T-storm" + - No longer skip hidden weather contact while updating + - Bug fix when previewing weather popups + - Bug fix in parsing the HTML content (in cases where "&" exists) + - Few other minor fixes and changes. + +Version 0.3.2.14 2004/05/12 + - Popup preview include a preview of popup text settings (use default station) + - Fix memory leaks in various places. + +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 the 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 readme) + - Now with the complete support of weather INI v1.1 + - Very basic support of weather alert notifications (if the INI supports it) + - 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. + +Version 0.3.1.8 2004/04/09 + - "My Notes" text are copied to "Current\WeatherInfo" (might be useful for some plugins) + - Increase the length of display texts from 512b to 4k + - Bug Fix: when temperature is N/A, display N/A + - Bug Fix: rounding in unit conversion, err... + - Bug Fix: crash with new ini setting "Set Data=" + +Version 0.3.1.7 2004/04/08 + - Now correctly support the new ini files. + +Version 0.3.1.6 2004/04/04 + - Support escape characters "\%" for displaying % + - Changes in warning popups + +Version 0.3.1.5 2004/04/02 + - New option: Consider weather info updated only when cond and temp are changed + - Support v1.1 of weather ini files - only support loading, but not the new features ;) + - Rounding is used when converting units + - Attempt to fix the crash on exit and reload weather data bug + - The default update time is changed to 20 min + - Other minor fixes and changes that I don't remember + +Version 0.3.1.1 2004/03/27 + - Fix the crash when opening brief info dialog + - The default for "Support online notification" is on when adding new station + +Version 0.3.1.0 2004/03/25 + - Change the way popup is handled, no longer need to enable the threading option + - Manually add station without searching by entering "#" in the ID field + - Always provide a search result if the weather service has no ID search available. + - Some error handling and popups to prevent crashes. + - New hookable event: ME_WEATHER_UPDATED + - Bug fix: Translation of retrieved data + - Bug fix: Search don't work for city that has more than 1 word + - Bug fix: Speed conversion is wrong + - Bug fix: weatherch.ini: Crash if adding/updating a station in US Eastern timezone + - Updated: weatherch.ini, Read Me, Translation, Sample INI, m_weather.h + +Version 0.3.0.1 (Beta) 2004/03/23 + - Do not update contacts that are hidden from list (see it as "disabled" contacts) + - Give error message box when selecting more info and weather map before setting the URL + - Bug fix: Find and search contacts (no result found + crashes) + - Bug fix: Issue with StartupStatus, now weather will update at least once on startup + regardless of what's the setting there. + - Bug fix: Visibility unit conversion + - Bug fix: Weather contacts appear offline if langpack is installed + - Bug fix: Some spelling error + - Bug fix: Feel-like temperature can't be displayed by mToolTip + - Bug fix: WU: Find and search for station that doesn't have current condition + - Updated: All 4 INI files, Read Me, Translation + +Version 0.3.0.0 (Beta) 2004/03/22 + - Combine the weather dll's into one + - Using external file for getting update (in plugins\weather directory) + - Added user detail page for weather contacts + - New and improved option pages + - Proxy support (now uses netlib) + - Unit conversion for pressure, visibility, and wind + - Optimization in the edit setting dialog - Allow multiple window + - Changes in brief info dialog - able to open multiple brief info + - Reduce the number of DB access for getting settings + - Add more variables such as feel-like temperature, pressure + - Add menu item for enable/disable popup + - Support weather icon determination for site in other languages using langpack + - Support for plugin uninstaller + - Optimization in weather update - now update using a queue and minimize DB access + - Optimizaiton in add/search - now don't do unnecessary searches + - Other code optimization and reduce file size + - Reload weather update data file from the main menu + - Some other major and minor UI change + - Remove some useless features + - Bug fix: temperature conversion (thanks to sirius) + - Bug fix: crash on adding new station + - Some minor changes and fixes in webpage downloading. + - Includes documentation for INI update data file and icon selection translation. + - Major changes in translation strings. + - Some update in the readme documentation. + - Included in this version: + Weather Channel, Weather Underground (both US and International), Yahoo Weather. + +Version 0.2.5.2 + +Version 0.2.5.1 2003/07/19 + - Minor bug fixes + +Version 0.2.5.0 2003/06/09 + - New feature: short weather information as status message and/or note. + - New option: display weather options inside plugin options. + - Create a seperate page for text and display options. + - Other minor changes and bug fixes + +Version 0.2.4.5 2003/06/12 + - Bug fix: Backup/restore protocol icon (including rebuild icon) if status is hidden. + - Bug fix: Popup only condition changes. + +Version 0.2.4.4 2003/06/08 + - Fixed typo in option + - Weather underground: Retrieve data for high/low temperature even if + current info is unavailable + - Minor code change. + +Version 0.2.4.3 2003/06/07 + - Fix weather underground searching station + +Version 0.2.4.2 2003/06/06 + - Fixed weather underground station name display problem. + - Changes to make compatible with earlier version in case of downgrading + - Reorganize language pack strings. + +Version 0.2.4.1 (Beta) 2003/05/28 + - New preview using the selected timeout value. + - Modified timeout warning message box. + +Version 0.2.4.0 (Beta) 2003/05/28 + - Added advanced option page + - New option: Popup timeout + - Restore the hide icons in status / task bar option + - Use old weather information if new data is unavailable + - Add the debug setting in advanced option page + - Major internal / weather update / DB settings change + +Version 0.2.3.13 2003/05/30 + - Fixed searching weather underground station + - Few minor changes + +Version 0.2.3.12 2003/05/28 + +Version 0.2.3.11 (Beta) 2003/05/27 + - Fixed Weather Channel for the FOURTH time + +Version 0.2.3.10 2003/05/27 + - Third fix for Weather Channel. + - Note: If v0.2.3.9 works, there is no need to upgrade + +Version 0.2.3.9 2003/05/26 + - Fixed download from Weather Channel + - Few minor changes and updates + +Version 0.2.3.8 2003/05/25 + - Removed some unnecessary popup that causes crash and/or confusion + - Minor code change in weather update. + +Version 0.2.3.7 (Beta) 2003/05/08 + - Now compile using latest Miranda source code + +Version 0.2.3.6 (Beta) 2003/04/15 + +Version 0.2.3.5 2003/03/16 + - Fix in "Do not display weather condition as protocol status" option + - Fix in maximun temperature for weather channel plugin. + +Version 0.2.3.4 2003/03/16 + +Version 0.2.3.3 (Beta) 2003/03/10 + - Remove features that are incompatiable with latest version of Miranda + - Bug fix on retrieving weather (again!) + +Version 0.2.3.2 (Beta) 2003/02/28 + - Few minor bug fixes + +Version 0.2.3.1 (Beta) 2003/02/17 + - Bug fix in retrieving high and low temperature. + - Other minor fixes. + +Version 0.2.3.0 2003/02/05 + - New option: Do not display default condition as protocol status + - Support Miranda Installer + - Other minor code changes. + +Version 0.2.2.11 2003/01/31 + - Fixed some weather info parsing problems + +Version 0.2.2.10 2003/01/26 + - Fix some minor errors in weather update + +Version 0.2.2.9 2003/01/25 + - Add some warning messages. + +Version 0.2.2.8 (Beta) 2003/01/25 + - Fixed on popup display. + - More infinite loop prevention. + +Version 0.2.2.7 2003/01/24 + - Forget to update version number in last release + +Version 0.2.2.6 2003/01/24 + - Popup only when condition changes now work properly. + - Minor bug fix in logging + - Smaller file size. + - Other minor changes. + +Version 0.2.2.5 (Beta) 2003/01/23 + - Fixed weatherch.dll for new website format. + +Version 0.2.2.4 (Beta) 2003/01/18 + - Minor code change + +Version 0.2.2.3 2003/01/16 + +Version 0.2.2.2 2003/01/15 + - Show popup action selection when menu is opened. + - Bug fix: Modified weather station now can update normally. + +Version 0.2.2.1 (Beta) 2003/01/12 + - Bug fix: Opening menu when click on PopUp. + - Added link in main menu to the homepage of weathe source. + - New protocol icon. + +Version 0.2.2.0 (Beta) 2003/01/11 + - Move pop-up related options to popup option page. + - New option: Set popup title + - New option: Specify command for popups when mouse is clicked. + - Added variable information popup. + - Some UI changes. + - Added version info. + - Some translation string added / changed. + +Version 0.2.1.6 (Beta) 2003/01/09 + - Shorten code in some functions. + +Version 0.2.1.5 2003/01/08 + - Updated weatherch.dll for data retrieval. + - Bug fix: Searching new weather station. + - Bug fix: Loading default settings. + - Few other minor changes. + +Version 0.2.1.3 (Beta) 2003/01/07 + - Minor bug fix. + +Version 0.2.1.2 2003/01/04 + - New option: Overwrite File upon Update. + - Update in translation doc. + +Version 0.2.1.1 2003/01/03 + - Better support for multiline popups. + - Minor change in codes and readme document. + +Version 0.2.1.0 2002/12/31 + - New option: Override default URL settings for each contact + - Display text are no longer case sensitive. + - Prevent opening two dialogs at the same time. + +Version 0.2.0.5 2002/12/18 + - Few minor changes and bug fixes + +Version 0.2.0.4 (Beta) 2002/12/15 + - Bug fix: changing status and popups. + - Minor change in weather update. + +Version 0.2.0.3 (Beta) 2002/12/14 + - Bug fix: disable popup st startup. + - Other minor changes. + +Version 0.2.0.2 (Beta) 2002/12/12 + - Try to make string compatible between each weather source (not tested) + - Bug fix: crash when not connected (not tested) + - New weather condition in translation string. + - Various other minor bug fixes and changes. + +Version 0.2.0.1 (Beta) 2002/12/11 + - Fix in updating weather information in wunderground.dll + - Various other minor bug fixes and changes. + +Version 0.2.0.0 (Beta) 2002/12/10 + - Completed wunderground.dll + - Bug fix: Update all weather. + - Bug fix: Weather update in weatherch.dll + - Various other bug fixes and improvements. + +Version 0.1.9.5 (Preview) 2002/12/10 + - Completed weatherch.dll + - Weather Underground (wunderground.dll) included - not complete yet. + - Bug fix: Default weather station and weather status. + - Bug fix: Crash when edit weather station. + - Bug fix: Crash when adding new weather station. + - Bug fix: Searching for weather station when no contact found. + - Various other changes and bug fixes. + +Version 0.1.9.0 (Preview) 2002/12/09 + - Split code into different files for easier modification. + - Support for multiple weather protocols (required minimal change + new build) + - Minor changes and bug fixes + +Version 0.1.5.2 2002/12/09 + - Bug fix: crash when "Show multiple icons only when statuses differ" enabled + - Bug fix: some options not saved properly. + - Bug fix: bug fix when adding the first station. + +Version 0.1.5.1 2002/12/07 + - Bug fix in showing notifying messages. + +Version 0.1.5.0 2002/12/06 + - Error detections. + - New option: Show errors on popups. + - Display default station weather condition as status icon. + - Enable / Disable weather update through status. + - New weather conditions. + - Slight change in adding new weather station. + - Fixed tab orders. + +Version 0.1.4.9 2002/12/06 + +Version 0.1.2.0 2002/11/29 + - Add links to weather maps. + - Add option to change Popup text, Log text, and URL links. + - New variables: %d, %s, %S + - New option: open webpage in new window. + - Internal code changes and bug fixes. + +Version 0.1.1.1 2002/11/25 + - Bug fix: Translations + - Minor code change and translation updates. + +Version 0.1.1.0 2002/11/24 + - Brief Information template now translable. + - Add set to default button for Brief Information display. + - UI change in Brief Information dialog. + - Add some control over looping. + - Set default weather station (currently has no use, but it maybe useful later or by + other plugins) + - Bug fix: Searching for station using city names. + - Bug fix: Assigning icon to weather conditions. + - Fixed tab order. + - Other minor UI and code changes (hope this will fix some bugs). + +Version 0.1.0.0 2002/11/23 + - Now add weather station via Find/Add Contact dialog. + - Able to search for station using city name. + - Customize string for showing brief information. + - New option: Log weather station in history. + - New option: Disable popup for specific weather station. + - Bug fix: Update after editing weather station. + - Bug fix: Now correctly update using the new webpage format. + - Updated translation string (both dll and weather condition). + - Updated debug output method. + - Smaller file size. + - Re-organized readme and language files. + - Various other minor bug fixes and improvement. + +Version 0.0.8.5 2002/11/22 + - Bug fix: Hiding icon in task bar. + - New weather condition added (both dll and langpack). + +Version 0.0.8.4 2002/11/22 + - Bug fix: Update issues. + - Updated translation string. + +Version 0.0.8.3 2002/11/21 + - Interface change in option screen. + - Prevent displaying invalid data. + - Minor code change for update weather condition. + - Added missing translation string. + +Version 0.0.8.2 2002/11/20 + - Bug fix: Translation of weather condition on contact list + - Bug fix: Temperature conversion. + - Minor change in option screens and edit setting screen. + +Version 0.0.8.1 2002/11/19 + - Bug fix: Fixed temperature display. + - Fixed tab orders. + +Version 0.0.8.0 (Beta) 2002/11/19 + - Retrieve high and low temperature forecast for the current day. + - Search and display temperature from alternative source when it is unknown. + (For the people who have N/A display beside their city, this ver should work now) + - More customizable contact list name display. + - Bug fix: C and F conversion when temperature < 0 degree C. + - Bug fix: Some update problems. + - Language pack updated: more weather conditions. + +Version 0.0.7.5 (Beta) 2002/11/18 + - Right click -> Update Weather will no longer freeze Miranda. + - New option: Disable popup if condition doesn't change. + - Bug fix: prevent manual update when auto-update is in progress. + - Added missing translation string. + +Version 0.0.7.0 (Beta) 2002/11/17 + - Updating weather will no longer freeze up miranda. + - Add option to disable popup. + - Bug fix: Now saves the degree sign in option. + - Bug fix: Logging weather condition and view log command. + - Bug fix: Update weather condition after modifying weather station. + - Added missing translation string. + - Various other improvements. + +Version 0.0.6.1 (Beta) 2002/11/16 + - Bug fix: Update after modifying weather station. + - Bug fix: No cache (slower but more accurate info). + +Version 0.0.6.0 (Beta) 2002/11/16 + - The plugin has it's own popup (not using NewStatusNotify's anymore) + - Add option to hide icon in status bar and status menu (expreimental release). + - Various minor changes. + +Version 0.0.5.1 (Alpha) 2002/11/16 + +Version 0.0.5.0 (Alpha) 2002/11/15 + +Version 0.0.4.3 (Beta) 2002/11/15 + - Added option to disable main menu item. + - Various minor improvements. + +Version 0.0.4.2 (Beta) 2002/11/15 + - Bug fix: translation strings. + - Bug fix: no longer open miranda directory when no log is found. + +Version 0.0.4.1 (Beta) 2002/11/15 + - Bug fix on retrieving weather information. + - Removed debug string that was accidentally built in the last release. (see above) + +Version 0.0.4.0 (Beta) 2002/11/14 + - Retrieve weather information no longer require temp files. + - Able to modify weather station settings. + - Add link to log file in contact menu. + - Add an option for degree sign (I can't think of a better way to do this). + - Relocate main menu item. + - Bug fix: DB: Attempt to get wrong type of value, word. + - Various other minor bug fixes. + +Version 0.0.3.7 (Beta) 2002/11/14 + - Bug fix: degree signs (sorry for the copy-and-paste error). + - Move the temporary file to miranda directory. + +Version 0.0.3.6 (Beta) 2002/11/14 + - Bug fix: degree signs (changable using language pack) + - Bug fix: DB: Attempt to get wrong type of value, word. + - More weather condition are now able to display with correct icon. + +Version 0.0.3.5 (Beta) 2002/11/13 + - Initial public beta release. + +Version 0.0.3.1 (Beta) 2002/11/13 + +Version 0.0.3.0 (Beta) 2002/11/12 + - Disable auto update option. + - Logging weather condition. + - New option for displaying weather conditions on contact list. + - Bug fix: some tarnslation strings. + - Bug fix: switching between English and metric units. + - Bug fix: time of update. + +Version 0.0.2.1 (Preview) 2002/11/12 + - Bug fix: F to C conversion. + - Bug fix: Display complete forcast page in correct unit system. + +Version 0.0.2.0 (Preview) 2002/11/12 + - Display temperature on contact list. + - Translable strings. + - Display brief weather information as message box. + - Faster information download. + - Various other fixes. + +Version 0.0.1.2 (Pre-Alpha) 2002/11/12 + +Version 0.0.1.1 (Pre-Alpha) 2002/11/11 + - Faster and more reliable download. + - Various bug fixes. + +Version 0.0.1.0 (Pre-Alpha) 2002/11/11 + - Retrieve temperature and update time. + +Version 0.0.0.3 (Pre-Alpha) 2002/11/11 + - Bug fix in weather condition and icons. + - Various other bug fixes. + +Version 0.0.0.2 (Pre-Alpha) 2002/11/11 + - Set the name for city, retrieve weather condition. + +Version 0.0.0.1 (Pre-Alpha) 2002/11/10 + - Initial build diff --git a/plugins/Weather/docs/weather-readme.html b/plugins/Weather/docs/weather-readme.html new file mode 100644 index 0000000000..ff81561171 --- /dev/null +++ b/plugins/Weather/docs/weather-readme.html @@ -0,0 +1,230 @@ + + + + Read Me for Weather Protocol + + + +

Read Me for Weather Protocol

+
+ 
+
+*** IMPORTANT NOTICE ***
+Be cautious when choosing the "special status" selection for selecting the status
+assign to contact whose current condition is unavailable.  This feature is not
+officially support by Miranda and may cause a lot of plugins to crash. Be sure to
+backup your profile before you try this feature.
+
+
+
+
+
+
+File Content
+
+Features
+Files Included
+System Requirement
+Installation
+Frequently Asked Questions
+License
+
+
+
+
+
+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.
+
+
+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 for how to use
+ - plugins\weather-doc\weather-readme.html
+    Documentation and FAQ for Weather Protocol (this file).
+ - plugins\weather-doc\sample_ini.ini
+    Documentation of the format of the weather INI file.
+ - plugins\weather-doc\weather-translation.txt
+    A file that contains a translation of hopefully all string used in Weather Protocol.
+
+
+System Requirement
+
+ - Miranda IM  (v0.7.3.0 or later)
+ - Weather INI file
+ - Weather icons (Optional)
+     Numerous choices available in icon downloads.
+ - YAPP plugin by sje or PopUp Plus plugin by nullbie (Optional)
+
+
+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.
+   4. In icon option, customize the weather icon or use the default one in the dll
+
+ 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
+
+Setting Up Weather Protocol
+For installation, follow the steps describe in the installation section of the readme.
+
+Q1-1. Weather Protocol does not do anything after I installed it, and it
+      cannot go online.
+A. You need to add a new station before you can go online.
+
+Q1-2. How do I add new stations?
+A. 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.
+
+Q1-3. I can't find my station! Any help?
+A. 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.
+
+Q1-4. I have installed the plugin properly, and it still doesn't work.  I have
+      noticed that there is no traffic generated by the plugin.
+A. 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.
+
+INI and Development Related Questions
+
+Q2-1. What are those INI files for?
+A. The INI files contain information for downloading and parsing weather information
+   from a particular weather site.  At least one INI file must exist in order for the
+   plugin to work.  For a list of available INI's, click here.
+
+Q2-2. Can I install or modify the INI files without restarting Miranda?
+A. Yes, choose: M (main menu) -> Weather -> Reload Weather Data
+
+Q2-3. I want to retrieve weather information from a different source than those
+      that are currently available.  How can this be done?
+A. You can write your own INI file.  For more information, click here.
+
+Q2-4. I wrote/downloaded an ini file that retrieve weather condition in a
+      language that weather protocol doesn't seems to reconize and always
+      display N/A. What should I do?
+A. You can use translation string for assigning icons. For more information, click here.
+
+Q2-5. How does weather assign status icons for each status?
+A.  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
+
+Obtaining Weather Data
+
+Q3-1. Does weather protocol retreve weather forecasts?
+A. 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 #] or %[FD#] where # is the day you
+   want the forecast for.  See the readme supplied in the INI file package for more
+   information.
+
+Q3-2. How long should the time between update be?
+A. 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.
+
+Q3-3. How can I temporary disable weather procotol?
+A. 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.  Automatic update of
+   weather condition can be disabled through menu and option page.
+
+Q3-4. Why are the name of some weather contacts italic on my contact?
+A. There are weather alerts issued for those cities. To see the alert title, use the
+   %[Alert] variable.  You can disable this function in option page.
+
+Q3-5. 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?
+A. If the source of weather info is in a language other than English, please check the
+   INI package for instruction of how to install language pack.  If the source is in
+   English, notify me.
+
+Customizing the Weather Protocol
+
+Q4-1. Can I hide Weather from status bar and protocol menu?
+A. Go to Options->Plugins->Weather, enable "Hide Weather in status bar and status menu".
+
+Q4-2. I can't find Weather in the icon option drop-down list.  How can I change
+      weather icons?
+A. Weather icon cannot be changed if "Hide Weather in status bar and status menu" is
+   enabled. To change icons, disable the option (see Q4-1), make your change, then re-
+   enable it.
+
+Q4-3. I can't find the options for changing display text.
+A. Go to Options->Plugins->Weather, then click on the icon beside "Change display texts"
+
+Q4-4. How can I change the display name of my city?
+A. Right-click on the city and select "Edit Settings".  Change the field "City name"
+   to the new display name.
+
+Q4-5. How can I change the default station?
+A. Use the Edit Settings dialog (See A4-4).  Note that only 1 station can be default.
+
+Q4-6. What is the %[..] variable for?
+A. 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.
+
+Q4-7. What are the "Extra Text" for?
+A. 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.
+
+Q4-8. I want weather protocol to have the same status as the other protocols.
+      Is such option available?
+A. 
+Disable the option "Use weather condition as protocol status", then you will be
+   able to change the status freely.
+
+Q4-9. How do I create avatars for each weather condition?
+A. Put the following files into the Miranda\Plugins\Weather folder:
+	Light.png, Fog.png, SShower.png, Snow.png, RShower.png, Rain.png
+	PCloudy.png, Cloudy.png, Sunny.png, NA.png
+
+
+License 
+
+This plugin is released under GPL.
+
+ + -- cgit v1.2.3