Warning, /office/calligraplan/src/convert/README is written in an unsupported language. File is not indexed.

0001 Basics
0002 ------
0003 
0004 planconvert converts some project file formats into Calligra Plan file format.
0005 It is written in Java and uses MPXJ for reading other file formats, see:
0006 https://www.mpxj.org
0007 
0008 This means that planconvert *should* be able to convert from all the file formats MPXJ supports, but:
0009 * Planner has it own importer.
0010 * Primavera suretrack and Sage 100 Contractor has unknown extensions so cannot be imported.
0011 
0012 Testing is limeted since available files are limeted.
0013 See test files in testdata.
0014 
0015 Note that the MS .mpd files (database files) need a java-odbc bridge which I don't think is available on linux.
0016 
0017 Dependecies
0018 -----------
0019 To run anything you need a  jave runtime environment, version 8
0020 e.g: openjdk-8-jre for ubuntu systems.
0021 
0022 This is also needed to run filters.
0023 
0024 To run tests, build new stuff etc you need ant.
0025 
0026 Schema classes
0027 --------------
0028 Schema classes are generated from the plan-<version>.dtd file.
0029 See property 'plan.dtd.dir' in build.xml.
0030 
0031 Jobs execution
0032 --------------
0033 Everything is done using 'ant' and the different jobs are defined in build.xml.
0034 
0035 Making changes
0036 --------------
0037 You need to update the build.xml file:
0038 
0039 1) New mpxj version:
0040     a) In build.xml: Change property 'mpxj.version' to the new version.
0041     b) Execute: 'ant get-mpxj'
0042        This will download and unsip mpxj into 'mpxj.dir'.
0043 
0044 2) New plan dtd version:
0045     a) In build.xml: Change property 'plan.version' to the new version
0046     b) If mpxj is not present, execute 'ant get-mpxj'
0047     c) Execute: 'ant xjc'
0048        This will create new schema classes.
0049     d) Update PlanWriter to deal with changes
0050     e) Execute 'ant jar'
0051     f) Commit when everything works ;)
0052 
0053 Regenerate everything
0054 ---------------------
0055 Execute: 'ant all'
0056 
0057 Changes to planConvert
0058 ----------------------
0059 Execute: 'ant jar'
0060 
0061 Run tests
0062 ---------
0063 Note: These are not auto tests, you must run them manually AND check results manually!
0064 
0065 Execute: 'ant test'
0066 
0067 The test is run on files found in: ${test.data.dir}
0068 
0069 You can also test any single file using this command:
0070 java -cp jar/planconvert.jar TestConvert <test file> <result file>
0071 
0072 Mpxj has a lot of test files in: ${mpxj.dir}/junit/data
0073 You can have all these files converted if you change ${test.data.dir} to point there.
0074 
0075 
0076 The test writes result files to ${result.dir} and a log file to ${test.dir}
0077 
0078 Running
0079 -------
0080 Execute: 'ant run'