diff --git a/README.rst b/README.rst index 4545b9ce78..8578fbdaac 100644 --- a/README.rst +++ b/README.rst @@ -60,9 +60,9 @@ Requires Java 1.8 or later. Contributing ------------------ -* Download and install svn or git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle +* Download and install git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle -* Check out the code from svn or git +* Check out the code from git * Import the project into Eclipse or your favorite IDE diff --git a/src/documentation/RELEASE-NOTES.txt b/src/documentation/RELEASE-NOTES.txt index 53f99f52b5..c394295b0a 100644 --- a/src/documentation/RELEASE-NOTES.txt +++ b/src/documentation/RELEASE-NOTES.txt @@ -29,7 +29,7 @@ This release comes in source form: All release artifacts are accompanied by SHA checksums and PGP signatures that you can use to verify the authenticity of your download. The public key used for the PGP signature can be found at -https://svn.apache.org/repos/asf/poi/tags/@RELEASE_TAG@/KEYS +https://downloads.apache.org/poi/KEYS About Apache POI ----------------------- diff --git a/src/documentation/content/xdocs/components/diagram/index.xml b/src/documentation/content/xdocs/components/diagram/index.xml index b14c8fcf56..5f060e8318 100644 --- a/src/documentation/content/xdocs/components/diagram/index.xml +++ b/src/documentation/content/xdocs/components/diagram/index.xml @@ -38,7 +38,7 @@
Currently, HDGF provides a low-level, read-only api for accessing Visio documents. It also provides a - way + way to extract the textual content from a file.
At this time, there is no usermodel api or similar, @@ -50,7 +50,7 @@ to get a feel for how Visio files are structured.
To get a feel for the contents of a file, and to track down
where data of interest is stored, HDGF comes with
- VSDDumper
+ VSDDumper
to print out the contents of the file. Users should also make
use of
vsdump
@@ -58,8 +58,8 @@
Currently, there are only a handful of example programs using HWPF and XWPF
available. They can be found in svn in the examples section, under
- HWPF
+ HWPF
and
- XWPF.
+ XWPF.
Both HWPF and XWPF have fairly high levels of unit test coverage, which
provides examples of using the various areas of functionality of both
modules. These can be found in svn, under
- HWPF
+ HWPF
and
- XWPF.
+ XWPF.
Contributions of more examples, whether inspired by the unit tests or
not, would be most welcomed!
For now, there are a limited number of XWPF examples in the - Examples Package. + Examples Package. Beyond those, the best source of additional examples is in the unit - tests. + tests. Browse the XWPF unit tests.
HWPF is still in early development. It is in the + href="https://github.com/apache/poi/tree/trunk/poi-scratchpad/"> scratchpad section of the SVN. You will need to ensure you either have a recent SVN checkout, or a recent SVN nightly build (including the scratchpad jar!)
@@ -80,7 +80,7 @@ do end up with macros in them.For now, the best source of additional examples is in the unit tests. + href="https://github.com/apache/poi/tree/trunk/poi-scratchpad/src/test/java/org/apache/poi/hwpf/"> Browse the HWPF unit tests.
To get a feel for the contents of a file, and to track down where data of interest is stored, HMEF comes with - HMEFDumper + HMEFDumper to print out the contents of the file.
diff --git a/src/documentation/content/xdocs/components/hpbf/file-format.xml b/src/documentation/content/xdocs/components/hpbf/file-format.xml index eb092444cd..e23df62cc2 100644 --- a/src/documentation/content/xdocs/components/hpbf/file-format.xml +++ b/src/documentation/content/xdocs/components/hpbf/file-format.xml @@ -189,7 +189,7 @@ PL 62 1a 00 00 48 00 00 00 // PL from: 1a62 (6754), len: 48 (72)Type 8 has 7 2 byte unsigned ints, then a pair of 4 byte unsigned ints for each entry.
Type 12 holds hyperlinks, and is very much more complex.
- See org.apache.poi.hpbf.model.qcbits.QCPLCBit
+ See org.apache.poi.hpbf.model.qcbits.QCPLCBit
for our best guess as to how the contents match up.
There is an example MSG textual renderer, which shows how to access the common parts such as sender, subject, message body and examples. This is in the - HSMF examples area + HSMF examples area of SVN. You may also wish to look at the unit tests for more use guides.
Small sample programs using the POI API are available in the - src/examples - (viewvc) directory of the source distribution. + src/examples + (viewvc) directory of the source distribution.
All of the examples are included in POI distributions as a poi-examples artifact. @@ -408,7 +408,7 @@
See POI Ruby Bindings and other code in the poi-contrib module + href="https://github.com/apache/poi/tree/trunk/src/contrib/">poi-contrib module
- The POI-Ruby module sits under the POI Subversion - (viewvc). Running make + The POI-Ruby module sits under the POI Subversion + (viewvc). Running make inside that directory will create a loadable ruby extension poi4r.so in the release subdirectory. Tests are in the tests/ subdirectory, and should be run from the poi-ruby directory. Please read the tests to figure out the usage.
diff --git a/src/documentation/content/xdocs/components/poifs/how-to.xml b/src/documentation/content/xdocs/components/poifs/how-to.xml index 8899994806..234838608e 100644 --- a/src/documentation/content/xdocs/components/poifs/how-to.xml +++ b/src/documentation/content/xdocs/components/poifs/how-to.xml @@ -619,7 +619,7 @@ } ]]>For an example of an in-place change to one stream within a file, you can see the example - + org/apache/poi/hpsf/examples/ModifyDocumentSummaryInformation.java
diff --git a/src/documentation/content/xdocs/components/slideshow/index.xml b/src/documentation/content/xdocs/components/slideshow/index.xml index 6c2b1c5d39..b963d928a7 100644 --- a/src/documentation/content/xdocs/components/slideshow/index.xml +++ b/src/documentation/content/xdocs/components/slideshow/index.xml @@ -43,8 +43,8 @@For rendering slideshow (HSLF/XSLF), WMF, EMF and EMF+ pictures, POI provides an utility class - + PPTX2PNG:
diff --git a/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml b/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml index 8bde9a2697..4f72295b5f 100644 --- a/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml +++ b/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml @@ -30,8 +30,8 @@This page offers a short introduction into the XSLF API. More examples can be found in the - XSLF Examples - in the POI SVN repository. + XSLF Examples + in the POI Git repository.
All sample source is available in SVN
+All sample source is available in SVN
In addition, there are a handful of
HSSF only and
XSSF only examples as well.
@@ -73,7 +73,7 @@
The BusinessPlan
+ The BusinessPlan
application creates a sample business plan with three phases, weekly iterations and time highlighting. Demonstrates advanced cell formatting
(number and date formats, alignments, fills, borders) and various settings for organizing data in a sheet (freezed panes, grouped rows).
The Calendar
+ The Calendar
demo creates a multi sheet calendar. Each month is on a separate sheet.
The LoanCalculator
+ The LoanCalculator
demo creates a simple loan calculator. Demonstrates advance usage of cell formulas and named ranges.
The Timesheet
+ The Timesheet
demo creates a weekly timesheet with automatic calculation of total hours. Demonstrates advance usage of cell formulas.
The ConditionalFormats
+ The ConditionalFormats
demo is a collection of short examples showing what you can do with Excel conditional formatting in POI:
The CalculateMortgage
+ The CalculateMortgage
example demonstrates a simple user-defined function to calculate
principal and interest. The CheckFunctionsSupported
+ The CheckFunctionsSupported
example shows how to test what functions and formulas aren't
supported from a given file. The SettingExternalFunction
+ The SettingExternalFunction
example demonstrates how to use externally provided (third-party)
formula add-ins. The UserDefinedFunctionExample
+ The UserDefinedFunctionExample
example demonstrates how to invoke a User Defined Function for a
given Workbook instance using POI's UDFFinder implementation. The AddDimensionedImage
+ The AddDimensionedImage
example demonstrates how to add an image to a worksheet and set that
images size to a specific number of millimetres irrespective of the
width of the columns or height of the rows. The AligningCells
+ The AligningCells
example demonstrates how various alignment options work. The CellStyleDetails
+ The CellStyleDetails
example demonstrates how to read excel styles for cells. The LinkedDropDownLists
+ The LinkedDropDownLists
example demonstrates one technique that may be used to create linked
or dependent drop down lists. The SSPerformanceTest
+ The SSPerformanceTest
example provides a way to create simple example files of varying
sizes, and to calculate how long they take. Useful for benchmarking
your system, and to also test if slow performance is due to Apache
@@ -176,14 +176,14 @@
The ToHtml
+ The ToHtml
example shows how to display a spreadsheet in HTML using the classes for spreadsheet display.
The ToCSV
+ The ToCSV
example demonstrates one way to convert an Excel spreadsheet into a CSV file.
All the HSSF-only examples can be found in
- SVN All the XSSF-only examples can be found in
- SVN
@@ -124,23 +124,23 @@
-