OVERVIEW------------------------------------------------------------------------------------------------- This is release 2.3.0.11 of the command-line Rendering Engine, or simply "the renderer". It produces HTML and other files identical to the corresponding version of the rendering engine as installed at the SEC's EDGAR web site and Interactive Data previewer. Therefore, you can use it on your own machine to fine-tune your rendered output, without relying on the SEC interactive data previewer. The renderer is not a validator and does not test for EDGAR Filer Manual nor XBRL 2.1 Validity. INSTALLATION------------------------------------------------------------------------------------- The file cr-renderer.zip is a zip format archive. When downloading from the web site, either "Open" or "Save" to a convenient location on your own machine, and then Open it. You will then "Extract" the zip file to a destination folder of your choice, such as "My Documents" It will create a subfolder there called "Renderer" that contains, among other files, one main executable program called: ReportBuilderRenderer.exe More important, it contains a folder called "Examples" (and a copy of this readme file). TEN EXAMPLES------------------------------------------------------------------------------------------------------- The folder "Examples" contains ten examples, each in its own sub folder. There is a ".bat" file for each folder that illustrates how the renderer is invoked from the command line. Double-click on each .bat file and the output will appear in a subfolder called "Reports". Note that the renderer will not overwrite any files in the destination "Reports" folder unless you answer "y" to the prompt. To run without such interruptions, delete the "Reports" folder before rendering. First, the examples should help you become comfortable with the renderer. For example: * edgar2011 - a small filing that accesses all the 2011 us-gaap and dei taxonomy files. Output file R1.htm contains all there is in the filing. * zip - example using the renderer to process, and produce, a zip file. This filing has a bit more data and comes out as three reports R1.htm, R2.htm and R3.htm. Look at the FilingSummary.xml file to see the correspondence of report names with file names. Second, they illustrate new features of the rendering engine: * flowthru- other information such as removal of columns due to flow-through suppression. This is found toward the bottom of the FilingSummary.xml file, in the section starting with . The content of is not displayed to end users on the EDGAR Viewer. * graphic - how to use graphics and reference them from text blocks * horizontal - shows how the order of equity statement columns can be controlled by presentation links. * qlabel- Some elements have values that are XML QNames, and those QNames can now have labels. * restated - Illustrates the use the 2011 us gaap taxonomy for adjustments and restated values. Third, they illustrate some of the information, warning and error messages that may appear in the portion of output file FilingSummary.xml, but not displayed to end users: * decimals - information about how scaling was applied to "drop zeroes" in reports. * embedding - warnings about badly formed embedding commands in summary prospectuses. * vertical - illustrates that equity statement layout will fail unless there are start and end labels. COMMAND LINE ARGUMENTS----------------------------------------------------------------------------------------------- If you are writing your own batch script or use the renderer interactively at a windows command prompt, you can run the program without any arguments: ReportBuilderRenderer.exe to see the following message: The syntax of this command is: ReportBuilderRenderer.exe /Instance="[drive:][path]instance.xml" [/Instance="[drive:][path]instance.xml"] [...] - or - ReportBuilderRenderer.exe /Instance="[drive:][path]package.zip" [/Instance="[drive:][path]package.zip"] [...] Optional parameters: Set the base output path: /ReportsFolder=[drive:][path\to\]folder Set the report output format(s): /ReportFormat=(Xml|Html|HtmlAndXml) If format contains Html, set the html format: /HtmlReportFormat=(Complete|Fragment) Set the caching policy of remote files: Value descriptions can be found at 'http://msdn.microsoft.com/en-us/library/system.net.cache.requestcachelevel.aspx' /RemoteFileCachePolicy=(Default|BypassCache|CacheOnly|CacheIfAvailable|Revalidate|Reload|NoCacheNoStore) Set quiet mode, the application will not interact with the user: /Quiet Set the output format for all filings in this session: /SaveAs=(Xml|Zip) TROUBLESHOOTING HINTS------------------------------------------------------------------------------------------------ The message "Error Parsing the Taxonomy" often means that the renderer is unable to get a file it needs from the Internet. There may be nothing wrong with your filing. Try typing the URL of the file it cannot find into your browser's address bar. If, for example, you cannot reach http://www.xbrl.org/dtr/type/numeric-2009-12-16.xsd from your browser then the renderer cannot reach it either. The date format of the output and thousands separators are determined by Windows locale settings on the machine where the renderer runs. The SEC previewer and EDGAR Viewer use the US locale. Your machine must be set to the US locale to produce correct results. Avoid including images with names such as "barchart1.jpg", "BarChart2.jpg" or variations thereof. If you notice other discrepancies between your renderer and the SEC previewer, be sure to check that the version numbers agree. The version number appears at the top of the FilingSummary.xml file. You can see the version of your renderer without needing to run a test file, by right-clicking on ReportBuilderRenderer.exe and looking for the details tab. There is no standalone renderer for versions prior to 2.3.0.9. MORE DETAILS--------------------------------------------------------------------------------------------------------- Instead of passing many arguments on the command line, edit the file ReportBuilderRenderer.exe.config to set the argument defaults. Note that the config file MUST be in the same folder as where you extracted the renderer. The file TaxonomyAddonManager.xml and the folder Taxonomy do not contain a full copy of all EDGAR taxonomies, only their "documentation" and "reference" files; these files are referenced by the pop-ups in the output Html. The "Xml" format of the output appears on the EDGAR web site for older filings but will be phased out in favor of the HTML output produced by the renderer. The source code of the renderer is available from the same website where this was posted. For additional information contact EDGAR Filer Support by phone or http://www.sec.gov/cgi-bin/contact_risk_fin form.