mirror of https://github.com/apache/poi.git
changed CRLF to LF in src/documentation
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@781839 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Josh Micich
parent
afe8827155
commit
48d660d0ae
|
|
@ -1,34 +1,34 @@
|
||||||
<?xml version="1.0"?>
|
<?xml version="1.0"?>
|
||||||
<!--
|
<!--
|
||||||
====================================================================
|
====================================================================
|
||||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||||
contributor license agreements. See the NOTICE file distributed with
|
contributor license agreements. See the NOTICE file distributed with
|
||||||
this work for additional information regarding copyright ownership.
|
this work for additional information regarding copyright ownership.
|
||||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||||
(the "License"); you may not use this file except in compliance with
|
(the "License"); you may not use this file except in compliance with
|
||||||
the License. You may obtain a copy of the License at
|
the License. You may obtain a copy of the License at
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
See the License for the specific language governing permissions and
|
See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
====================================================================
|
====================================================================
|
||||||
-->
|
-->
|
||||||
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd">
|
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd">
|
||||||
|
|
||||||
<book software="POI Project"
|
<book software="POI Project"
|
||||||
title="OpenXML4J"
|
title="OpenXML4J"
|
||||||
copyright="@year@ POI Project">
|
copyright="@year@ POI Project">
|
||||||
|
|
||||||
<menu label="Apache POI">
|
<menu label="Apache POI">
|
||||||
<menu-item label="Top" href="../index.html"/>
|
<menu-item label="Top" href="../index.html"/>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu label="OpenXML4J">
|
<menu label="OpenXML4J">
|
||||||
<menu-item label="Overview" href="index.html"/>
|
<menu-item label="Overview" href="index.html"/>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
</book>
|
</book>
|
||||||
|
|
|
||||||
|
|
@ -1,42 +1,42 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<!--
|
<!--
|
||||||
====================================================================
|
====================================================================
|
||||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||||
contributor license agreements. See the NOTICE file distributed with
|
contributor license agreements. See the NOTICE file distributed with
|
||||||
this work for additional information regarding copyright ownership.
|
this work for additional information regarding copyright ownership.
|
||||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||||
(the "License"); you may not use this file except in compliance with
|
(the "License"); you may not use this file except in compliance with
|
||||||
the License. You may obtain a copy of the License at
|
the License. You may obtain a copy of the License at
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
See the License for the specific language governing permissions and
|
See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
====================================================================
|
====================================================================
|
||||||
-->
|
-->
|
||||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd">
|
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd">
|
||||||
|
|
||||||
<document>
|
<document>
|
||||||
<header>
|
<header>
|
||||||
<title>POI-OpenXML4J - Java API To Access Office Open XML documents</title>
|
<title>POI-OpenXML4J - Java API To Access Office Open XML documents</title>
|
||||||
<subtitle>Overview</subtitle>
|
<subtitle>Overview</subtitle>
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<section>
|
<section>
|
||||||
<title>Overview</title>
|
<title>Overview</title>
|
||||||
<p>OpenXML4J is the POI Project's pure Java implementation of the Open Packaging Conventions (OPC) defined in
|
<p>OpenXML4J is the POI Project's pure Java implementation of the Open Packaging Conventions (OPC) defined in
|
||||||
<link href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">ECMA-376</link>.</p>
|
<link href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">ECMA-376</link>.</p>
|
||||||
<p>Every OpenXML file comprises a collection of byte streams called parts, combined into a container called a package.
|
<p>Every OpenXML file comprises a collection of byte streams called parts, combined into a container called a package.
|
||||||
POI OpenXML4J provides a physical implementation of the OPC that uses the Zip file format.</p>
|
POI OpenXML4J provides a physical implementation of the OPC that uses the Zip file format.</p>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<title>History</title>
|
<title>History</title>
|
||||||
<p>OpenXML4J was originally developed by <link href="http://openxml4j.org/">http://openxml4j.org/</link> and contributed to POI in 2008.
|
<p>OpenXML4J was originally developed by <link href="http://openxml4j.org/">http://openxml4j.org/</link> and contributed to POI in 2008.
|
||||||
Thanks to the support and guidance of Julien Chable</p>
|
Thanks to the support and guidance of Julien Chable</p>
|
||||||
</section>
|
</section>
|
||||||
</body>
|
</body>
|
||||||
</document>
|
</document>
|
||||||
|
|
|
||||||
|
|
@ -1,180 +1,180 @@
|
||||||
POI Release Guide
|
POI Release Guide
|
||||||
|
|
||||||
|
|
||||||
(I) Prerequisites
|
(I) Prerequisites
|
||||||
|
|
||||||
1. You should read the <a href="http://apache.org/dev/release.html">Apache Release FAQ</a>
|
1. You should read the <a href="http://apache.org/dev/release.html">Apache Release FAQ</a>
|
||||||
2. You must have shell access to people.apache.org
|
2. You must have shell access to people.apache.org
|
||||||
3. Release manager must have his public key appended to the KEYS file checked in to SVN and the key published on one of the public key servers.
|
3. Release manager must have his public key appended to the KEYS file checked in to SVN and the key published on one of the public key servers.
|
||||||
More info can be found here: <a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a>
|
More info can be found here: <a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a>
|
||||||
4. You must have <a href="java.sun.com">JDK 1.4 / 1.5</a>
|
4. You must have <a href="java.sun.com">JDK 1.4 / 1.5</a>
|
||||||
5. You must have the following utilities installed on your local machine and available in your path:
|
5. You must have the following utilities installed on your local machine and available in your path:
|
||||||
* <a href="www.openssh.com">ssh</a>
|
* <a href="www.openssh.com">ssh</a>
|
||||||
* <a href="www.gnupg.org">gnupg</a>
|
* <a href="www.gnupg.org">gnupg</a>
|
||||||
* <a href="www.openssl.org">openssl</a>
|
* <a href="www.openssl.org">openssl</a>
|
||||||
For Windows users, install Cygwin and make sure you have the above utilities
|
For Windows users, install Cygwin and make sure you have the above utilities
|
||||||
6. The POI build system requires two components to perform a build
|
6. The POI build system requires two components to perform a build
|
||||||
* <a href="ant.apache.org">Ant</a>
|
* <a href="ant.apache.org">Ant</a>
|
||||||
* <a href="http://forrest.apache.org/">Forrest</a>.
|
* <a href="http://forrest.apache.org/">Forrest</a>.
|
||||||
POI 3.0.2 and 3.1 were built using Ant 1.6.2 and Forrest 0.5
|
POI 3.0.2 and 3.1 were built using Ant 1.6.2 and Forrest 0.5
|
||||||
|
|
||||||
(II) Making release artefacts
|
(II) Making release artefacts
|
||||||
1. Update version id in build.xml
|
1. Update version id in build.xml
|
||||||
{code:xml}
|
{code:xml}
|
||||||
<property name="version.id" value="3.1-beta1"/>
|
<property name="version.id" value="3.1-beta1"/>
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
2. Tag current version. Include the current revision number in the comment
|
2. Tag current version. Include the current revision number in the comment
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
$ svn cp https://svn.apache.org/repos/asf/poi/trunk \
|
$ svn cp https://svn.apache.org/repos/asf/poi/trunk \
|
||||||
https://svn.apache.org/repos/asf/poi/tags/$TAG \
|
https://svn.apache.org/repos/asf/poi/tags/$TAG \
|
||||||
-m "tag r649911 as 3.1-beta1"
|
-m "tag r649911 as 3.1-beta1"
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
where $TAG is the release tag, for example, REL_3_1_BETA1
|
where $TAG is the release tag, for example, REL_3_1_BETA1
|
||||||
|
|
||||||
3. Checkout the tagged version
|
3. Checkout the tagged version
|
||||||
{code}
|
{code}
|
||||||
cd tags
|
cd tags
|
||||||
svn checkout https://svn.apache.org/repos/asf/poi/tags/$TAG
|
svn checkout https://svn.apache.org/repos/asf/poi/tags/$TAG
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
4. Merge (if required)
|
4. Merge (if required)
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
cd $TAG
|
cd $TAG
|
||||||
$ svn merge https://svn.apache.org/repos/asf/poi/tags/$TAG \
|
$ svn merge https://svn.apache.org/repos/asf/poi/tags/$TAG \
|
||||||
https://svn.apache.org/repos/asf/poi/trunk
|
https://svn.apache.org/repos/asf/poi/trunk
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
5. Start a new section in sites.xml and status.xml.
|
5. Start a new section in sites.xml and status.xml.
|
||||||
|
|
||||||
6. Build as if the vote had passed. The build date must be +7 days from current.
|
6. Build as if the vote had passed. The build date must be +7 days from current.
|
||||||
{code}
|
{code}
|
||||||
ant build
|
ant build
|
||||||
{code}
|
{code}
|
||||||
After build you should have the following files in the build/dist:
|
After build you should have the following files in the build/dist:
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
poi-$TAG-$DATE.jar
|
poi-$TAG-$DATE.jar
|
||||||
poi-bin-$TAG-$DATE.tar.gz
|
poi-bin-$TAG-$DATE.tar.gz
|
||||||
poi-bin-$TAG-$DATE.zip
|
poi-bin-$TAG-$DATE.zip
|
||||||
poi-contrib-$TAG-$DATE.jar
|
poi-contrib-$TAG-$DATE.jar
|
||||||
poi-scratchpad-$TAG-$DATE.jar
|
poi-scratchpad-$TAG-$DATE.jar
|
||||||
poi-src-$TAG-$DATE.tar.gz
|
poi-src-$TAG-$DATE.tar.gz
|
||||||
poi-src-$TAG-$DATE.zip
|
poi-src-$TAG-$DATE.zip
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
where $TAG is the release tag specified in build.xml in the version.id property, $DATE is the release date (typically +7 days from the actual build date).
|
where $TAG is the release tag specified in build.xml in the version.id property, $DATE is the release date (typically +7 days from the actual build date).
|
||||||
7. Build Mavn POM files
|
7. Build Mavn POM files
|
||||||
{code}
|
{code}
|
||||||
ant maven-dist
|
ant maven-dist
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
8. Signing the release artifacts:
|
8. Signing the release artifacts:
|
||||||
{code}
|
{code}
|
||||||
cd build/dist
|
cd build/dist
|
||||||
for i in *.zip ; do
|
for i in *.zip ; do
|
||||||
gpg --armor --output $i.asc --detach-sig $i;
|
gpg --armor --output $i.asc --detach-sig $i;
|
||||||
done
|
done
|
||||||
for i in *.gz ; do
|
for i in *.gz ; do
|
||||||
gpg --armor --output $i.asc --detach-sig $i;
|
gpg --armor --output $i.asc --detach-sig $i;
|
||||||
done
|
done
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
Verify the signatures:
|
Verify the signatures:
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
gpg --multifile --verify *.asc
|
gpg --multifile --verify *.asc
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
9. Create MD5 checksums for all artifacts to be published:
|
9. Create MD5 checksums for all artifacts to be published:
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
for i in *.zip ; do
|
for i in *.zip ; do
|
||||||
openssl md5 < $i > $i.md5
|
openssl md5 < $i > $i.md5
|
||||||
done
|
done
|
||||||
for i in *.gz ; do
|
for i in *.gz ; do
|
||||||
openssl md5 < $i > $i.md5
|
openssl md5 < $i > $i.md5
|
||||||
done
|
done
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
10. Upload to your area at people.apache.org.
|
10. Upload to your area at people.apache.org.
|
||||||
There should be two directories:
|
There should be two directories:
|
||||||
main
|
main
|
||||||
maven
|
maven
|
||||||
|
|
||||||
Make sure that the all files have read permission.
|
Make sure that the all files have read permission.
|
||||||
|
|
||||||
(III) After the vote:
|
(III) After the vote:
|
||||||
|
|
||||||
Log-in on people.apache.org
|
Log-in on people.apache.org
|
||||||
|
|
||||||
1. Go to ~/POI-3.1-BETA1
|
1. Go to ~/POI-3.1-BETA1
|
||||||
|
|
||||||
zap previous version first.
|
zap previous version first.
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
cd ~/POI-3.1-BETA1/main
|
cd ~/POI-3.1-BETA1/main
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
BETA and ALPHA releases:
|
BETA and ALPHA releases:
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
cp *-src-* /www/www.apache.org/dist/poi/dev/src
|
cp *-src-* /www/www.apache.org/dist/poi/dev/src
|
||||||
cp *-bin-* /www/www.apache.org/dist/poi/dev/bin
|
cp *-bin-* /www/www.apache.org/dist/poi/dev/bin
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
FINAL release:
|
FINAL release:
|
||||||
{code}
|
{code}
|
||||||
cp *-src-* /www/www.apache.org/dist/poi/release/src
|
cp *-src-* /www/www.apache.org/dist/poi/release/src
|
||||||
cp *-bin-* /www/www.apache.org/dist/poi/release/bin
|
cp *-bin-* /www/www.apache.org/dist/poi/release/bin
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
cd ~/POI-3.1-BETA1/maven
|
cd ~/POI-3.1-BETA1/maven
|
||||||
cp -r org.apache.poi /www/people.apache.org/repo/m1-ibiblio-rsync-repository/
|
cp -r org.apache.poi /www/people.apache.org/repo/m1-ibiblio-rsync-repository/
|
||||||
cp -r poi/poms /www/people.apache.org/repo/m1-ibiblio-rsync-repository/poi
|
cp -r poi/poms /www/people.apache.org/repo/m1-ibiblio-rsync-repository/poi
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
2. Make sure that the files are owned by the unix group apcvs and that they are writable by this group.
|
2. Make sure that the files are owned by the unix group apcvs and that they are writable by this group.
|
||||||
|
|
||||||
3. Wait for the distributions to appear on your favourite mirror
|
3. Wait for the distributions to appear on your favourite mirror
|
||||||
|
|
||||||
4. test maven
|
4. test maven
|
||||||
create a simple project and make sure the release artifacts are accessible by maven:
|
create a simple project and make sure the release artifacts are accessible by maven:
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
$ mvn archetype:create -DgroupId=org.apache.poi.scratchpad -DartifactId=maven-test
|
$ mvn archetype:create -DgroupId=org.apache.poi.scratchpad -DartifactId=maven-test
|
||||||
cd maven-test
|
cd maven-test
|
||||||
{code}
|
{code}
|
||||||
edit pom.xml and add the release artefacts to the project dependencies:
|
edit pom.xml and add the release artefacts to the project dependencies:
|
||||||
|
|
||||||
{code:xml}
|
{code:xml}
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.poi</groupId>
|
<groupId>org.apache.poi</groupId>
|
||||||
<artifactId>poi</artifactId>
|
<artifactId>poi</artifactId>
|
||||||
<version>3.1-beta1</version>
|
<version>3.1-beta1</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.poi</groupId>
|
<groupId>org.apache.poi</groupId>
|
||||||
<artifactId>poi-scratchpad</artifactId>
|
<artifactId>poi-scratchpad</artifactId>
|
||||||
<version>3.1-beta1</version>
|
<version>3.1-beta1</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
{code}
|
{code}
|
||||||
mvn compile
|
mvn compile
|
||||||
{code}
|
{code}
|
||||||
|
|
||||||
You should see [INFO] BUILD SUCCESSFUL in the end.
|
You should see [INFO] BUILD SUCCESSFUL in the end.
|
||||||
|
|
||||||
5. Don't forget to upload the latest version of the site and javadocs
|
5. Don't forget to upload the latest version of the site and javadocs
|
||||||
|
|
||||||
6. Send announcements:
|
6. Send announcements:
|
||||||
- to poi-user and poi-dev lists
|
- to poi-user and poi-dev lists
|
||||||
- to announcement@apache.org, announcements@jakarta.apache.org
|
- to announcement@apache.org, announcements@jakarta.apache.org
|
||||||
|
|
||||||
Note, announcements should be sent from your @apache.org e-mail address.
|
Note, announcements should be sent from your @apache.org e-mail address.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue