office-gobmx/chart2/NOTES

#*************************************************************************
#
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
# 
# Copyright 2008 by Sun Microsystems, Inc.
#
# OpenOffice.org - a multi-platform office productivity suite
#
# $RCSfile: NOTES,v $
#
# $Revision: 1.6 $
#
# This file is part of OpenOffice.org.
#
# OpenOffice.org is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License version 3
# only, as published by the Free Software Foundation.
#
# OpenOffice.org 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 Lesser General Public License version 3 for more details
# (a copy is included in the LICENSE file that accompanied this code).
#
# You should have received a copy of the GNU Lesser General Public License
# version 3 along with OpenOffice.org.  If not, see
# <http://www.openoffice.org/license.html>
# for a copy of the LGPLv3 License.
#
#*************************************************************************

NOTES
=====

Activate the New Chart
----------------------

After installation of an Office, you will still get the old chart
implementation.  In order to get the new implementation you have to activate it
via the configuration.

Set the boolean Config-Item Office.Common/Internal:DevelopmentChart to true.

HOW-TO:

* Open the file Common.xcu of the Registry.

Location on Unix:
$HOME/StarOffice8/user/registry/data/org/openoffice/Office/Common.xcu 

Location on Windows:
"%UserProfile%\Application Data\StarOffice8\user\registry\data\org\openoffice\Office\Common.xcu"

* Under the configuration-node "Internal" (see <node oor:name="Internal"> tag)
  you have to add the property "DevelopmentChart" and set this to "true":

* Add the following after the "Internal"-node:

  <prop oor:name="DevelopmentChart" oor:type="xs:boolean">
   <value>true</value>
  </prop>

After that, your Common.xcu may look like this:

,----[ Common.xcu example ]
| <?xml version="1.0" encoding="UTF-8"?>
| <oor:component-data xmlns:oor="http://openoffice.org/2001/registry" xmlns:xs="http://www.w3.org/2001/XMLSchema" oor:name="Common" oor:package="org.openoffice.Office">
|  <node oor:name="Internal">
|   <prop oor:name="DevelopmentChart" oor:type="xs:boolean">
|    <value>true</value>
|   </prop>
|   <prop oor:name="CurrentTempURL" oor:type="xs:string">
|    <value/>
|   </prop>
|  </node>
|  <node oor:name="Help">
|   <node oor:name="Registration">
|    <prop oor:name="ReminderDate" oor:type="xs:string">
|     <value xsi:nil="true"/>
|    </prop>
|    <prop oor:name="RequestDialog" oor:type="xs:int">
|     <value>0</value>
|    </prop>
|   </node>
|  </node>
|  <node oor:name="Misc">
|   <prop oor:name="FirstRun" oor:type="xs:boolean">
|    <value>false</value>
|   </prop>
|  </node>
| </oor:component-data>
`----

* To switch back, you can either replace the "true" by a "false", or you can
  delete the complete "DevelopmentChart" property (the three lines) you
  inserted.

FileDataSource
--------------

For testing the FileDataSource:  Currently the following files are read (hard-coded)
* Win:  D:\files\data.chd
* Unix: /work/data/data.chd

You can find sample data in workbench/sampledata

Testing
-------

* To create a chart using the abovementioned file for data, Call the menu item
  'File/Save all'.  To rebuild the chart call 'File/Save'.

* You can also create a chart from spreadsheet data.

* To run a test for the old API run "dmake" in the qa subdirectory.  Note that
  you have to deliver the private chart2.rdb (just type "deliver") and call the
  workbench/officeintegration/install.pl script for registering the private
  Chart API at the global registry in order to run the test.  Currently the test
  has to use new API, but in the future this will of course no longer be
  necessary.

  For running the API-test you must have a running office with the correct
  parameters that allow remote access from external components (like the API
  test).  Use the following command-line argument:

  "-accept=socket,host=0,port=8100;urp"

  With host=0 you allow access only from your local machine, so this should be
  no network security problem.