1<HTML><!-- #BeginTemplate "/Templates/MainTemplate.dwt" --> 2<HEAD> 3<!-- #BeginEditable "doctitle" --> 4<TITLE>Resource Bundle Reporter</TITLE> 5<!-- #EndEditable --> 6<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> 7<STYLE TYPE="TEXT/CSS"> 8<!-- 9.topicHead { font-family: "Times New Roman", Times, serif; font-size: 14pt; font-weight: bold; text-align: center; color: #333333} 10.topicList { font-family: Georgia, "Times New Roman", Times, serif; font-size: 9pt; color: #FF0099; list-style-image: url(images/diamond_bullet.gif); text-decoration: none; font-weight: bold} 11.mainBlock { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 12pt; margin-top: 5px; margin-right: 5px; margin-bottom: 5px; margin-left: 5px; padding-top: 5px; padding-right: 10px; padding-bottom: 5px; padding-left: 10px; text-align: justify} 12--> 13</STYLE> 14</HEAD> 15 16<BODY BGCOLOR="#FFFFFF" LEFTMARGIN="0" TOPMARGIN="0" MARGINWIDTH="0" MARGINHEIGHT="0"> 17<TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0"> 18 <TR> 19 <TD ROWSPAN="2" COLSPAN="2" BACKGROUND="images/template_ul.gif" HEIGHT="75"><IMG SRC="images/spacer.gif" WIDTH="280" HEIGHT="1" HSPACE="0"></TD> 20 <TD HEIGHT="15" WIDTH="100%" BACKGROUND="images/template_u.gif"></TD> 21 </TR> 22 <TR> 23 <TD HEIGHT="60" > 24 <CENTER><IMG SRC="images/TitleLogo_transparent.gif" VSPACE="0"></CENTER> 25 </TD> 26 </TR> 27 <TR> 28 29 <TD WIDTH="200" BACKGROUND="images/template_l.gif" VALIGN="top"> 30 <TABLE WIDTH="180" CELLSPACING="0" CELLPADDING="1"> 31 <TR> 32 <TD CLASS="topicHead">General</TD> 33 </TR> 34 <TR> 35 <TD VALIGN="center"><IMG SRC="images/template_line.gif"></TD> 36 </TR> 37 <TR> 38 <TD CLASS="topicList"> 39 <UL> 40 <LI><A HREF="system_requirements.html">System Requirements</A></LI> 41 <LI><A HREF="faq.html">FAQ</A></LI> 42 <LI><A HREF="future_features.html">Future Releases</A></LI> 43 <LI CLASS="topicList"><A HREF="future_features.html">Version 44 History</A></LI> 45 </UL> 46 </TD> 47 </TR> 48 <TR> 49 <TD CLASS="topicHead">RB Manager</TD> 50 </TR> 51 <TR> 52 <TD VALIGN="center"><IMG SRC="images/template_line.gif"></TD> 53 </TR> 54 <TR> 55 <TD CLASS="topicList"> 56 <UL> 57 <LI><A HREF="index.html">Home</A></LI> 58 <LI><A HREF="tutorial/index.html">Tutorial</A></LI> 59 <LI><A HREF="views/index.html">Functionality and Views</A></LI> 60 <LI><A HREF="lookandfeel.html">Look and Feel</A></LI> 61 <LI><A HREF="menu.html">Menu Items</A></LI> 62 <LI CLASS="topicList"><A HREF="tutorial/step1.html">Preferences</A></LI> 63 </UL> 64 </TD> 65 </TR> 66 <TR> 67 <TD CLASS="topicHead">RB Reporter</TD> 68 </TR> 69 <TR> 70 <TD VALIGN="center"><IMG SRC="images/template_line.gif"></TD> 71 </TR> 72 <TR> 73 <TD CLASS="topicList"> 74 <UL> 75 <LI><A HREF="RBReporter.html">Home</A></LI> 76 <LI>Report Types</LI> 77 <LI><A HREF="scanfile.html">Code Scanning</A></LI> 78 </UL> 79 </TD> 80 </TR> 81 </TABLE> 82 83 <P> </P> 84 </TD> 85 86 <TD COLSPAN="2" VALIGN="top" CLASS="mainBlock"><!-- #BeginEditable "Main" --> 87 <H1 ALIGN="CENTER">Resource Bundle Reporter</H1> 88 <H1 ALIGN="CENTER"><IMG SRC="images/screenshots/RBReporter.gif" WIDTH="600" HEIGHT="600"></H1> 89 <H4 ALIGN="LEFT">What is RBReporter?</H4> 90 <P ALIGN="LEFT">Frequently, managers and developers working on an inernationalized 91 product request the ability to quickly view the status and progress of 92 the translation efforts in their project. RBReporter generates such reports 93 on a periodic basis and stores them to a specified location in a variety 94 of formats. The information included in the reports includes the names 95 and meta data associated with each of the resource files, the number or 96 resources held in each file, the number of untranslated resources in each 97 file, and, if the detail level is set to 'High,' a list of all of the 98 untranslated resource keys for each file.</P> 99 <H4 ALIGN="LEFT">How is RBReporter started?</H4> 100 <P ALIGN="LEFT">From the command line, RBReporter is run by typing in the 101 following command:</P> 102 <P ALIGN="LEFT"><CODE>java com.ibm.rbm.RBReporter</CODE></P> 103 <P ALIGN="LEFT">This will bring up the window seen above. Alternatively, 104 Windows users can run the batch file RBReporter.bat. RBReporter will also 105 take command line arguments that will run the program in a variety of 106 modes. An equivalent command line argument to the one above is:</P> 107 <P ALIGN="LEFT"><CODE>java com.ibm.rbm.RBReporter -gui</CODE></P> 108 <P ALIGN="LEFT">This argument works the same as the first, bringing up the 109 Graphical User Interface. This is the only way to set the properties of 110 the reporter, such as the bundle to report on, the types of reports generated, 111 and the interval between report generation.</P> 112 <P ALIGN="LEFT">Another option is to run the reporter with the following 113 argument:</P> 114 <P ALIGN="LEFT"><CODE>java com.ibm.rbm.RBReporter -now</CODE></P> 115 <P ALIGN="LEFT">When the -now option is used, the interval setting between 116 reports is ignored, and the reports are generated immediately according 117 to the other saved settings. This option does not bring up the window 118 for changing settings. Using this option is helpful if you would like 119 to use you operating system instead of RBReporter to schedule the generation 120 of reports.</P> 121 <P ALIGN="LEFT">The last option is the following:</P> 122 <P ALIGN="LEFT"><code>java com.ibm.rbm.RBReporter -line</CODE></P> 123 <P ALIGN="LEFT">When this option is used, the reporter is run through the 124 command line only. None of the settings will be accessible for changing. 125 Whenever it is time for a report to be generated, a message will appear 126 on the command line. Another message will appear when the reports have 127 been successfully written. This last message will include the date and 128 time of the next report generation.</P> 129 <H4 ALIGN="LEFT">What do the settings mean?</H4> 130 <P ALIGN="LEFT">When the graphical user interface is initially brought up, 131 the reporter may not be active. An indication at the top of the window 132 indicates whether or not the reporter will report at the time that has 133 been specified. The 'Started' message does not indicate that report generation 134 has started; it merely indicates that the reporter has started and will 135 generate reports according to the other settings. To toggle whether or 136 not the reporter is running press the 'Start' or 'Stop' button near the 137 top of the window. To generate a report immediately, press the 'Update 138 Now' button.</P> 139 <P ALIGN="LEFT">The report interval determines when a report is generated. 140 There are two main options for determining the interval. Either an amount 141 of time is specified that must pass in between reports, or a specific 142 time during the week or day is specified at which time the report is generated 143 regardless of when the last report was generated.</P> 144 <P ALIGN="LEFT">The Resource Bundle setting is an indication of the base 145 file from concerning which the report is generated. To change the base 146 file, either type in the new file path to a resource bundle, or select 147 the 'Choose' button immediately to the right to bring up the graphical 148 file chooser. The output directory is the file directory into which the 149 reports are saved. Note that the reports are overwritten each time they 150 are newly generated.</P> 151 <P ALIGN="LEFT">The output format has three options. Any combination of 152 these options is permissible, though it makes little sense to turn them 153 all off. The 'Text' format produces a simple text file in English reporting 154 on the status of each of the resource files. The 'HTML' format produces 155 a page that is viewable in a web browser. The 'XML' format produces a 156 well formed XML report that can be imported into a database, transformed 157 into another format, or used in a variety of other ways.</P> 158 <P ALIGN="LEFT">Each output format has associated with it a file name. This 159 name can be chosen as appropriate for the project to which the bundle 160 belongs. Also, these file names can be modified in order to place the 161 files in a directory other than the one specified in the output directory. 162 For instance, a UNIX user might change the text file name to '../../log/report.txt'. 163 A detail level is also associated with each report. The 'High' detail 164 level merely includes each of the resource keys that are untranslated 165 or duplicated instead of just reporting the number of such resources.</P> 166 <P ALIGN="LEFT">The last button saves the settings currently being displayed 167 to a preferences file so that these settings will be in place the next 168 time the program is run. If the settings are not meant to be saved as 169 such, do not click this button. The reporter will still run according 170 to the displayed settings as long as the RBReporter program is running.</P> 171 <H4 ALIGN="LEFT">What is the code scan?</H4> 172 <P ALIGN="LEFT">Starting with version 0.3a, the reporter included a function 173 that can scan text files looking for instances of resource bundle usage 174 and compare those instances with the selected resource bundle. This scan 175 can then report on any resource keys called on by a program but not existing 176 in a resource bundle, as well as point out resources in the bundle that 177 are potentially not used at all by the code.</P> 178 <P ALIGN="LEFT">The reporter is turned on by selecting the check box next 179 to the text 'Scan Code File' and pointing the scan to a properly specified 180 scan XML file. The report generated is appended to the normal reports 181 generated in text, HTML, or XML. The report is also sensitive to the detail 182 level selected for each of these three output formats.</P> 183 <P ALIGN="LEFT">The scan XML file provides the configuration information 184 for the code scan. In it rules for what directories and files to scan 185 are set as well as what type of text is looked for to find a resource 186 key. More <A HREF="scanfile.html">detailed information on setting up a 187 scan XML file</A> can be found by following the link.</P> 188 <P ALIGN="LEFT"> </P> 189 <!-- #EndEditable --></TD> 190 </TR> 191 <TR> 192 <TD BACKGROUND="images/template_ll.gif" HEIGHT="40" WIDTH="200"> 193 <!-- Comment --> 194 </TD> 195 <TD WIDTH="80"> 196 <!-- Comment --> 197 </TD> 198 <TD> 199 <CENTER><SPAN CLASS="Copyright">Copyright 2000-2001 International Business Machines, All Rights Reserved</SPAN></CENTER> 200 </TD> 201 </TR> 202</TABLE> 203 204</BODY> 205<!-- #EndTemplate --></HTML> 206
