symhelp/helpmodel/group/RELEASE.TXT
changeset 0 1f04cf54edd8
equal deleted inserted replaced
-1:000000000000 0:1f04cf54edd8
       
     1 HELP MODEL RELEASE NOTES
       
     2 ========================
       
     3 Release:044
       
     4 Release by: Waiman Tang
       
     5 Date:23/12/2009
       
     6 ------------------
       
     7 * fix for defect : PDEF134629: ONB : Fix for some leavescan errors in defect_misc build
       
     8 ------------------
       
     9 Release:043
       
    10 Release by: Shazia Murtaza
       
    11 Date:23/12/2008
       
    12 ------------------
       
    13 * fix for defect : DEF131491: hlpmodel - manual test TDUMPER fails.
       
    14 ------------------
       
    15 Release:042
       
    16 Release by: James Aley
       
    17 Date:25/09/2008
       
    18 ------------------
       
    19 * fix for defect : DEF126532: [Coverity] - SYMBIAN.CLEANUP - app-services/hlpmodel/
       
    20 ------------------
       
    21 Release:041
       
    22 Release by: Prabodh Depala
       
    23 Date:06/11/2007
       
    24 ------------------
       
    25 * fix for defect : PDEF113759: It appears HlpLauncher does not work properly
       
    26 ------------------
       
    27 Release:040
       
    28 Release by: Waiman Tang
       
    29 Date:27/02/2007
       
    30 ------------------
       
    31 * fix for defect : PDEF100094: HlpLauncher class description inaccurate
       
    32 ------------------
       
    33 Release:039
       
    34 Release by: Konstantin Zheludev
       
    35 Date:29/09/2006
       
    36 ------------------
       
    37 * fix for defect : DEF093327: Tag Scan Error Report for Pim component
       
    38 ------------------
       
    39 Release:038
       
    40 Release by: Shazia Murtaza
       
    41 Date:09/05/2006
       
    42 ------------------
       
    43 * fix for defect : DEF085630: Help application does not switch to the correct language for helpfiles. 
       
    44 ------------------
       
    45 Release:037
       
    46 Release by: Peter Chan
       
    47 Date:10/03/2006
       
    48 ------------------
       
    49 * fix for defect :  DEF082340: STAB-Agenda (Calendar) help can crash
       
    50 - prevent a new search starting when one is currently being conducted.
       
    51 ------------------
       
    52 Release:036
       
    53 Release by: Kelly Hon
       
    54 Date:15/12/2005
       
    55 -------------------
       
    56 * fix for defect :  DEF075741: STAB-Agenda (Calendar) help can crash.
       
    57 
       
    58 Release:035
       
    59 Release by: Daniel Yuen
       
    60 Date:23/11/2005
       
    61 ------------------
       
    62 * fix for defect :DEF074050: Helpmodel has never been updated for multi-digit locale codes
       
    63 
       
    64 KHlpFileSpec now uses *.h* instead of *.h?? for multi-digit locale search.
       
    65 ------------------
       
    66 Release:034
       
    67 Release by: Krishna Vasudevan
       
    68 Date:27/05/2005
       
    69 -------------------
       
    70 * fix for defect : DEF061683  CHlpDatabase::FileName doesn't work 
       
    71 -------------------
       
    72 Release:033
       
    73 Release by: Krishna Vasudevan
       
    74 Date:17/05/2005
       
    75 -------------------
       
    76 * fix for defect : INC057477 - HlpLaunch hard-codes application path
       
    77 
       
    78 The resource file is included into the hlpmodel's IBY File.
       
    79 The hlplaunch MMP file contains the resource file information.
       
    80 There is a error check on return value of RFs::Connect().
       
    81 The Resource File literal name is made unique.
       
    82 -------------------
       
    83 Release:032
       
    84 Release by: Robert Williamson
       
    85 Date:18/03/2005
       
    86 -------------------
       
    87 * fix for defect : INC057477 - HlpLaunch hard-codes application path
       
    88 
       
    89 Path is now stored in lch.rss. The path set in lch.rss in this change
       
    90 is "z:\\sys\\bin\\cshelp.exe".
       
    91 -------------------
       
    92 Release:031
       
    93 Release by: Prabodh Depala
       
    94 Date:15/02/2005
       
    95 -------------------
       
    96 * fix for defect : INC051624 - NTT App-services\hlpmodel\ test case tsearch fails.
       
    97 -------------------
       
    98 Release:030
       
    99 Release by: Loughlin Spollen
       
   100 Date:03/02/2005
       
   101 -------------------
       
   102 * fix for defect : DEF049948 - Core Apps Test Server improvement
       
   103 -------------------
       
   104 Release:029
       
   105 Release by: Steve Childerley
       
   106 Date:11/11/2004
       
   107 -------------------
       
   108 Minor Change TSearch  - modified to handle different drives encountered in Lubbock & H2
       
   109 The major changes made within SearchOrderTest.CPP & H
       
   110 
       
   111 Release:028
       
   112 Release by: Steve Childerley
       
   113 Date:07/10/2004
       
   114 -------------------
       
   115 Modified TSearch to include test for PlatSec drive search order.
       
   116 The added test is only run when __SECURE_DATA__ is defined.
       
   117 
       
   118 Release: 027
       
   119 Release by: Johan Nareskog
       
   120 Date: 11/10/2004
       
   121 -------------------
       
   122 DEF050046 - THelpView and TLCH don't start
       
   123 -------------------
       
   124 
       
   125 Release: 026
       
   126 Release by: Nikolay Budantsev
       
   127 Date: 11/09/2004
       
   128 -------------------
       
   129 MS3.1.1  GT0215   PREQ277 PS6.4 Replacement APIs (Also PS8.1)
       
   130 MS3.6    GT0215   PREQ728 Base API Improvements
       
   131 -------------------
       
   132 
       
   133 Release: 025
       
   134 Release by: Nichola Turner
       
   135 Date: 26/11/2003
       
   136 -------------------
       
   137 * fix for defect : DEF040449 - Missing copyright statements in files
       
   138 -------------------
       
   139 Release: 024
       
   140 Release by: Dominic Pinkman
       
   141 Date: 17/11/2003
       
   142 -------------------
       
   143 * fix for defect : DEF039936 - Mistakes in Doxygen tagging
       
   144 -------------------
       
   145 Release: 023
       
   146 Release by: Andy Newman
       
   147 Date: 08/10/2003
       
   148 -------------------
       
   149 * fix for defect : DEF038750 - build file errors
       
   150 -------------------
       
   151 Release: 022
       
   152 Release by: Andy Newman
       
   153 Date: 17/09/2003
       
   154 -------------------
       
   155 * fix for defect : DEF037970 - TSearch looks for files on C, not Z, on lubbock and assabet
       
   156 -------------------
       
   157 Release: 021
       
   158 Release by: Johan Nareskog 
       
   159 Date: 09/15/2003
       
   160 -------------------
       
   161 * fix for defect : DEF037971  hlpmodel/tloader - missed from hlpmodelTest.iby file
       
   162 -------------------
       
   163 Release: 020
       
   164 Release by: Bob Rosenberg
       
   165 Date: 06/20/2002
       
   166 -------------------
       
   167 * fix for defect : INC035325 - TSTORE fails in Lubbock (urel)
       
   168 
       
   169 -------------------
       
   170 Release: 019
       
   171 Release by: Sindhu Melkote
       
   172 Date: 05/12/2002
       
   173 -------------------
       
   174 * fix for defect : INC002647 - Help:Results of a search are still displayed after search is cancelled
       
   175 
       
   176 -------------------
       
   177 Release: 018
       
   178 Release by: NicholaT
       
   179 Date: 28/02/2002
       
   180 -------------------
       
   181 * fix for defect "Cannot add 3'rd party help files"
       
   182   (PEN-55HDL6)
       
   183 
       
   184 -------------------
       
   185 Release: 017
       
   186 Release by: NicholaT
       
   187 Date: 30/01/2002
       
   188 -------------------
       
   189 * fix for defect "Exported headers #include "" non-exported headers"
       
   190   (BAD-56VLDN)
       
   191 
       
   192 -------------------
       
   193 Release: 016
       
   194 Release by: NicholaT
       
   195 Date: 28/01/2002
       
   196 -------------------
       
   197 * fix for defect "Cannot add 3'rd party help files"
       
   198   (PEN-55HDL6)
       
   199 
       
   200 -------------------
       
   201 Release: 015
       
   202 Release by: NicholaT
       
   203 Date: 06/09/2001
       
   204 -------------------
       
   205 * Fix for defect "duplicate UIDs"
       
   206   (TUR-4ZWFHV)
       
   207 
       
   208 -------------------
       
   209 Release: 014
       
   210 Release by: GeraldoT
       
   211 Date: 06/08/2001
       
   212 -------------------
       
   213 * Fix for defect "HlpModel: Javadoc Symbian OS release version number are incorrect"
       
   214   (WIR-4YYN4E)
       
   215 
       
   216 -------------------
       
   217 Release: 013
       
   218 Release by: AlexW
       
   219 Date: 13/07/2001
       
   220 -------------------
       
   221 * Fix for defect "HlpModel: zooming rounding errors producing strange 
       
   222   zoomed bitmaps" (WIR-4YLK77)
       
   223 
       
   224 -------------------
       
   225 Release: 012
       
   226 Release by: NicholaT
       
   227 Date: 04/07/2001
       
   228 -------------------
       
   229 * Added support for localisable language downgrade path of help files
       
   230 
       
   231   - all drives are scanned for any help files.
       
   232   - for each file found, it's nearest language file is loaded by using
       
   233     BaflUtils::NearestLanguageFile.
       
   234 
       
   235 * New test help files added
       
   236 
       
   237   - test help files for various locales added
       
   238 
       
   239 -------------------
       
   240 Release: 011
       
   241 Release by: AlexW
       
   242 Date: 08/06/2001
       
   243 -------------------
       
   244 * Added multiple bitmap zooming support. 
       
   245 
       
   246   - If an MBM file contains 1 bitmap, then only regular zooming is available.
       
   247   - If an MBM file contains 2 bitmaps, then again, only regular bitmap zooming
       
   248     is available (i.e. GDI stretches the bitmap as its drawn at different zoom
       
   249     sizes).
       
   250   - If an MBM file contains 3 bitmaps, then depending on the zoom size the
       
   251     help model is in, the corresponding bitmap is drawn to the screen without
       
   252     any streching.
       
   253   - If an MBM file contains more than 3 bitmaps then only the first 3 are utilized.
       
   254 
       
   255 * New API's
       
   256   - See GT109 API documentation.
       
   257 
       
   258 -------------------
       
   259 Release: 010
       
   260 Release by: AlexW
       
   261 Date: 21/07/2000
       
   262 -------------------
       
   263 * Removed extra notification that a CategoryUidSearch is complete. This is 
       
   264   not required and results in *EXACTLY* two Search complete messages being 
       
   265   reported to the model observer (in the case where a match is found, or 
       
   266   *EXACTLY* one notification in the case where no match is found). Updated 
       
   267   TSearch to verify that only one notification is ever sent regardless of
       
   268   how many help files are present, or how many help files are searched.
       
   269 
       
   270 -------------------
       
   271 Release: 009
       
   272 Release by: AlexW
       
   273 Date: 14/07/2000
       
   274 -------------------
       
   275 * Implemented fix for defect "hlpmodel allows 3rd party app writer to override internal help file"
       
   276   (EDNAMIE-4LXJJ2)
       
   277 * Implemented fix for defect "HlpModel will ignore foreign locale help files" (EDNAWIR-4LZG56)
       
   278 * In both cases, these fixes were merged in from TLoader
       
   279 * Updated TLoader to support optional logging
       
   280 
       
   281 -------------------
       
   282 Release: 008
       
   283 Release by: AlexW
       
   284 Date: 10/07/2000
       
   285 -------------------
       
   286 * NOTE: HELP FILES WILL NEED REBUILDING AS THIS IS NOT A DATA-COMPATIBLE RELEASE. 
       
   287   Data compatibility had to be broken to fix defect "Getting topics from an 
       
   288   index won't work" (EDNGHAS-4LVEJV)
       
   289 * Fix for defect "CHlpModel should produce only one ETopicListAvailable event
       
   290   for each call to CHlpModel::CategoryUIDSearchL?" (EDNMPEN-4LNDJ8)
       
   291 * Fix for defect "Getting topics from an index won't work" (EDNGHAS-4LVEJV)
       
   292 * Fix for defect "Missing CleanupStack interaction in DbWriter" (EDNAWIR-4LVEXY)
       
   293 * TSearch has been updated to include better checking of help model search results.
       
   294 * Removed image files from Test source data as these are generated by the compiler.
       
   295 
       
   296 -------------------
       
   297 Release: 007
       
   298 Release by: AlexW
       
   299 Date: 07/07/2000
       
   300 -------------------
       
   301 * Another attempt at fixing defect "CHlpModel should produce only one ETopicListAvailable event 
       
   302   for each call to CHlpModel::CategoryUIDSearchL?" (EDNMPEN-4LNDJ8)
       
   303   This time, added extra ReportEventL(ESearchComplete)
       
   304 * Improved TSearch full text searching to panic when in the case where the help model
       
   305   returns incorrect results for the test help files.
       
   306 
       
   307 -------------------
       
   308 Release: 006
       
   309 Release by: AlexW
       
   310 Date: 04/07/2000
       
   311 -------------------
       
   312 * Updated fix for defect "Epoc currently assumes one help file language" (EDNJHET-4HGNYZ)
       
   313   The previous fix was not tested for the use case where D: contains a file which is
       
   314   subsequently overridden by a better file on C:
       
   315   
       
   316   E.g. D:\System\Help\SomeHelp.hlp
       
   317        C:\System\Help\SomeHelp.h01 (this is better than the D: counterpart)
       
   318 
       
   319   This required the insertion of a missing 'break' statement in the loading code. This has
       
   320   been tested by running TLoader using this use-case setup.
       
   321 * Changed CHlpModel::CategoryUIDSearchL(TUid aCategoryUID) to use DoSearchL(...) directly
       
   322   because previous release called SearchL() which was over-writing the transient category
       
   323   uid value
       
   324 
       
   325 -------------------
       
   326 Release: 005
       
   327 Release by: AlexW
       
   328 Date: 29/06/2000
       
   329 -------------------
       
   330 * Fix for defect "CHlpModel should produce only one ETopicListAvailable event 
       
   331   for each call to CHlpModel::CategoryUIDSearchL?" (EDNMPEN-4LNDJ8)
       
   332 * Fix for defect "Loading an index list fails in HlpModel" (EDNAWIR-4LPE8Q)
       
   333 * Fix for defect "Link warnings from hlpmodel" (EDNSCHM-4L2P7H)
       
   334 * Fix for defect "Epoc currently assumes one help file language" (EDNJHET-4HGNYZ)
       
   335 * The last defect requires that all help files are named *.h?? where ?? can be hlp or 
       
   336   a locale specific two digit code (e.g. 01 for UK English). 
       
   337 
       
   338 
       
   339 -------------------
       
   340 Release: 004
       
   341 Release by: AlexW
       
   342 Date: 02/06/2000
       
   343 -------------------
       
   344 * Fix for defect "hlpmodel returns the same help topic for the same 
       
   345   TopicId in different help databases" (EDNJHET-4HLH8N)
       
   346 * 2nd and 3rd Uids switched, so all help files will need to be rebuilt.	
       
   347 * Added export to allow an asynchronous search to be cancelled.
       
   348 * Fixed full text searching so that asynchronous searching is now enabled.
       
   349 * Help application authors should take note of the new exports to CHlpItem
       
   350   and the new topic location export in CHlpModel as this is the *ONLY* means of
       
   351   restoring a help entry.
       
   352 * Source & BC
       
   353 
       
   354 
       
   355 -------------------
       
   356 Release: 003
       
   357 Release by: AlexW
       
   358 Date: 16/05/2000
       
   359 -------------------
       
   360 * Fix for defect "HlpModel panics if help requested when no helpfiles installed"
       
   361   (EDNJHET-4KDEP4)
       
   362 
       
   363 
       
   364 -------------------
       
   365 Release: 002
       
   366 Release by: AlexW
       
   367 Date: 04/05/2000
       
   368 -------------------
       
   369   Major update to support pictures in rich text. Most recent changes first:-
       
   370 
       
   371 * Updated DBWriter to provide more robust long text column writing (without leading length bytes).* Updated HlpModel to read using corresponding new schema.* Updated TDumper to extract further content from the help file.* Updated THelpView to reset the contents of the search window after a search has been completed.
       
   372 * Changed the DB writer to allow longer synonynms (now have a max length of 200 chars).* Updated the KHlpMaxTextColLength constant to 200 just in case (was 120).
       
   373 * Slight optimisation in the help file loading code which checks to see that  the model is not attempting to load a directory(!).* Added zooming support to reference help viewer
       
   374 * Remove bad code from CHlpModel::LoadTopicL() which was not using the correct  column name* In THelpView, added extra call to ensure that the rich text edwin's scrollbars  are resized after loading a new topic.* Removed commented out code from CHlpPict.cpp
       
   375 * Updated mmp file to link against CONE - this is required in order to retrieve the  current screen device without changing source compatibility. This might have to  be updated to something a little more sensible in the near future.* Fix for defect "HlpModel poor performance when obtaining lists   of topics from the help databases" (EDNJHET-4HGMPF)* Added an __ASSERT_DEBUG that meta data uid's read from the help  file must not duplicate each other (context Id's must be unique).
       
   376 * The version breaks file compatibilty in order to add improved picture and  rich text restoration. All help files will need to be regenerated.* Added new picture restoration code to help model so that a glass door   viewing application is no longer required.* Added new code to the context sensitive help backend to write picture Id's  to the CHelpPicture header. Pictures are now externalised as rows in a help  files image table. This reduces the size of help files by preventing multiple  copies of the same image from appearing multiple times in a help file. Images  are now looked up in the Image table.* Extended TContext to perform more testing* Cleaned-up HlpModel and THelpView
       
   377 * Fix for defect "Context search in hlpmodel does not seem to work" (EDNAFRD-4HQE7H)* Added completed test for context sensitive searching (TContext)
       
   378 * Updated DBWriter to provide more robust long text column writing (without leading length bytes).* Updated HlpModel to read using corresponding new schema.* Updated TDumper to extract further content from the help file.* Updated THelpView to reset the contents of the search window after a search has been completed.
       
   379 * Changed the DB writer to allow longer synonynms (now have a max length of 200 chars).* Updated the KHlpMaxTextColLength constant to 200 just in case (was 120).
       
   380 * Slight optimisation in the help file loading code which checks to see that  the model is not attempting to load a directory(!).* Added zooming support to reference help viewer
       
   381 * Remove bad code from CHlpModel::LoadTopicL() which was not using the correct  column name* In THelpView, added extra call to ensure that the rich text edwin's scrollbars  are resized after loading a new topic.* Removed commented out code from CHlpPict.cpp
       
   382 * Updated mmp file to link against CONE - this is required in order to retrieve the  current screen device without changing source compatibility. This might have to  be updated to something a little more sensible in the near future.* Fix for defect "HlpModel poor performance when obtaining lists   of topics from the help databases" (EDNJHET-4HGMPF)* Added an __ASSERT_DEBUG that meta data uid's read from the help  file must not duplicate each other (context Id's must be unique).
       
   383 * The version breaks file compatibilty in order to add improved picture and  rich text restoration. All help files will need to be regenerated.* Added new picture restoration code to help model so that a glass door   viewing application is no longer required.* Added new code to the context sensitive help backend to write picture Id's  to the CHelpPicture header. Pictures are now externalised as rows in a help  files image table. This reduces the size of help files by preventing multiple  copies of the same image from appearing multiple times in a help file. Images  are now looked up in the Image table.* Extended TContext to perform more testing* Cleaned-up HlpModel and THelpView
       
   384 * Fix for defect "Context search in hlpmodel does not seem to work" (EDNAFRD-4HQE7H)* Added completed test for context sensitive searching (TContext)
       
   385 
       
   386 
       
   387 -------------------
       
   388 Release: 001
       
   389 Release by: AlexW
       
   390 Date: 03/04/2000
       
   391 -------------------
       
   392 * Fixed the incorrect implementation of defect "hlpmodel recognises   help databases by filename" (EDNJHET-4HGNDS)* Finished TDumper project to dump contents of a help database to a text file for  inspection* Minor update to THelpView to adjust comments* Updated bld.inf to export TContext.dat (help database file used in test code)
       
   393 * Fix CHlpTopic::RestoreL(...) so that it can also read the rich text stored   in the db.* Now retrieves rich text from the model (excluding pictures)
       
   394 * New test project THelpView, a minimal EIKON help file viewer* Updated CHlpDatabase to no longer maintain an in memory handle   to the database stream dictionary* Fixed some memory leaks in DbWriter* Added new function SetObserver to CHlpModel* Appended new export to def files
       
   395 * Improved test code for topic listing and category listing.* Implementation for one of the missing functions (CHlpModel::OpenFileL(...))* Added new panic code (EHlpNoCriterion)* Fixed "Non-standard extension used" warning in CHlpTopic::RestoreL(RDbView* aView)  - this is actually part of defect "Various code defects in hlpmodel"  (EDNJHET-4HGP3S)* Added assert always to check for null category list * Fixed another part of defect "Various code defects in hlpmodel" (EDNJHET-4HGP3S)  - CHlpModel::MatchUidL(TUid aUid)* Made some internal functions inline and converted to references.* Optimised CHlpDatabase to used an array key on the iUids array.* Removed trailing L off of non leaving functions* Fixed a potential resource leak in CHlpDatabase whereby internal 'R'  classes were't closed.
       
   396 * Changed panic code THlpPanic::ENoRowAtCursor to EHlpNoRowAtCursor* Boiler plated header* Removed dodgy tabbing* Made CHlpDatabase::ViewHasRecordsL() inline (it was anyway, it just didn't  explicitly say inline).