pashko/apache-poi
1
0
Fork 0
mirror of https://github.com/apache/poi.git synced 2026-02-27 20:40:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
PJ Fanning 2025-07-08 03:50:24 +01:00
commit a4d5cf642d
29 changed files with 53 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.asf.yaml
View File

@ -44,4 +44,3 @@ notifications:
publish:
whoami: asf-site

5
content/broken-links.xml
View File

@ -1,2 +1,7 @@
<broken-links>
<link message="No pipeline matched request: components/spreadsheet/error:site:subversion">components/spreadsheet/error:site:subversion</link>
<link message="No pipeline matched request: error:site:subversion">error:site:subversion</link>
<link message="No pipeline matched request: components/hpsf/error:site:subversion">components/hpsf/error:site:subversion</link>
<link message="No pipeline matched request: help/error:site:subversion">help/error:site:subversion</link>
<link message="No pipeline matched request: devel/error:site:subversion">devel/error:site:subversion</link>
</broken-links>

2
content/components/hpsf/how-to.html
View File

@ -346,7 +346,7 @@ document.write("Last Published: " + document.lastModified);
<strong>Please note:</strong> HPSF's writing functionality is
<strong>not</strong> present in POI releases up to and including 2.5. In
order to write properties you have to download a 3.0.x POI release,
or retrieve the POI development version from the <a href="../../devel/subversion.html">Subversion repository</a>.</div>
or retrieve the POI development version from the <a href="error:site:subversion">Subversion repository</a>.</div>
</div>
<a name="sec1" id="sec1"></a><a name="Reading+Standard+Properties"></a>
<h3 class="boxed">Reading Standard Properties</h3>

2
content/components/poi-jvm-languages.html
View File

@ -345,7 +345,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../devel/subversion.html">Subversion Repository</a>
<a href="../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../devel/guidelines.html">Contribution Guidelines</a>

2
content/components/poi-ruby.html
View File

@ -345,7 +345,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../devel/subversion.html">Subversion Repository</a>
<a href="../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../devel/guidelines.html">Contribution Guidelines</a>

2
content/components/spreadsheet/diagram1.html
View File

@ -345,7 +345,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/components/spreadsheet/how-to.html
View File

@ -1225,7 +1225,7 @@ The latest version is always available from
<em>In POI versions before 3.0.3, this code lived in the scratchpad section.
If you're using one of these older versions of POI, you will either
need to include the scratchpad jar on your classpath, or build from a</em>
<a href="../../devel/subversion.html">subversion checkout</a>.
<a href="error:site:subversion">subversion checkout</a>.
</p>
<a name="xssf_sax_api" id="xssf_sax_api"></a><a name="XSSF+and+SAX+%28Event+API%29"></a>
<h3 class="boxed">XSSF and SAX (Event API)</h3>

4
content/devel/subversion.html → content/devel/git.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menupage">
<div class="menupagetitle">Subversion Repository</div>
<div class="menupagetitle">Git Repository</div>
</div>
<div class="menuitem">
<a href="../devel/guidelines.html">Contribution Guidelines</a>
@ -288,7 +288,7 @@ document.write("Last Published: " + document.lastModified);
</div>
<div id="feedback">
Send feedback about the website to:
<a id="feedbackto" href="mailto:dev@poi.apache.org?subject=Feedback%C2%A0devel/subversion.html">dev@poi.apache.org</a>
<a id="feedbackto" href="mailto:dev@poi.apache.org?subject=Feedback%C2%A0devel/git.html">dev@poi.apache.org</a>
</div>
<!--+
|end bottomstrip

6
content/devel/guidelines.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../devel/subversion.html">Subversion Repository</a>
<a href="../devel/git.html">Git Repository</a>
</div>
<div class="menupage">
<div class="menupagetitle">Contribution Guidelines</div>
@ -280,7 +280,7 @@ document.write("Last Published: " + document.lastModified);
<li>Join the <a href="../help/index.html">mailing lists</a> and share your knowledge with others.</li>
<li>Get <a href="../devel/subversion.html">Subversion</a> and check out the POI source tree</li>
<li>Get <a href="error:site:subversion">Subversion</a> and check out the POI source tree</li>
<li>Documentation is always the best place to start contributing, maybe you found that if the documentation just told you how to do X then it would make more sense, modify the documentation.</li>
@ -482,7 +482,7 @@ document.write("Last Published: " + document.lastModified);
<h3 class="boxed">Approach 3 - the git way</h3>
<p>
If you are working on a Git clone of Apache POI (see the
<a href="../devel/subversion.html">Version Control page</a> for
<a href="error:site:subversion">Version Control page</a> for
more on the read-only Git mirrors), it is possible to generate
a patch of your changes (including new binary files) using Git.
</p>

2
content/devel/history/changes-3x.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/history/changes-pre3x.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/history/index.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

4
content/devel/index.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../devel/subversion.html">Subversion Repository</a>
<a href="../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../devel/guidelines.html">Contribution Guidelines</a>
@ -232,7 +232,7 @@ document.write("Last Published: " + document.lastModified);
<p>
The main Apache POI build was traditionally done with <a href="https://ant.apache.org/">Apache Ant</a>.
In 2021, we moved to using <a href="https://gradle.org/">Gradle</a>.
After <a href="subversion.html">checking out</a> the POI code, you will find <strong>gradlew</strong> and
After <a href="git.html">checking out</a> the POI code, you will find <strong>gradlew</strong> and
<strong>gradlew.bat</strong>. These command files are used for running Gradle on Linux/Mac and Windows respectively.
Gradlew checks if you the right version of Gradle installed and will install it if you don't.
</p>

2
content/devel/nightly.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<div class="menupagetitle">Nightly Builds</div>
</div>
<div class="menuitem">
<a href="../devel/subversion.html">Subversion Repository</a>
<a href="../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/plan/index.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/plan/vision10.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/plan/vision20.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/references/index.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/references/logocontest.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/resolutions/index.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/resolutions/res001.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../../devel/subversion.html">Subversion Repository</a>
<a href="../../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../../devel/guidelines.html">Contribution Guidelines</a>

2
content/devel/who.html
View File

@ -114,7 +114,7 @@ document.write("Last Published: " + document.lastModified);
<a href="../devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="../devel/subversion.html">Subversion Repository</a>
<a href="../devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="../devel/guidelines.html">Contribution Guidelines</a>

2
content/help/faq.html
View File

@ -207,7 +207,7 @@ System.out.println("POI Scratchpad came from " + path);</pre>
<a href="../components/">the components overview section</a>
for the artifact details to have maven download it for you.
If you download the source release of POI, and/or checkout the
source code from <a href="../devel/subversion.html">subversion</a>,
source code from <a href="error:site:subversion">subversion</a>,
then you can run the ant task "compile-ooxml-xsds" to have the
OOXML schemas downloaded and compiled for you (This will also
give you the XMLBeans generated source code, in case you wish to

2
content/index.html
View File

@ -392,7 +392,7 @@ document.write("Last Published: " + document.lastModified);
hard-working, talented folks to help us on the project, no matter your
background. So if you're motivated, ready, and have the time: Download the
source from the
<a href="devel/subversion.html">Subversion Repository</a>,
<a href="error:site:subversion">Subversion Repository</a>,
<a href="devel/index.html">build the code</a>, join the
<a href="help/index.html">mailing lists</a>, and we'll be happy to
help you get started on the project!

4
content/linkmap.html
View File

@ -345,7 +345,7 @@ document.write("Last Published: " + document.lastModified);
<a href="devel/nightly.html">Nightly Builds</a>
</div>
<div class="menuitem">
<a href="devel/subversion.html">Subversion Repository</a>
<a href="devel/git.html">Git Repository</a>
</div>
<div class="menuitem">
<a href="devel/guidelines.html">Contribution Guidelines</a>
@ -943,7 +943,7 @@ document.write("Last Published: " + document.lastModified);
<ul>
<li>
<a href="devel/subversion.html">Subversion Repository</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>subversion</em>
<a href="devel/git.html">Git Repository</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>git</em>
</li>
</ul>

0
src/documentation/content/xdocs/devel/subversion.xml → src/documentation/content/xdocs/devel/git.xml
View File

2
src/documentation/content/xdocs/devel/index.xml
View File

@ -62,7 +62,7 @@
<p>
The main Apache POI build was traditionally done with <a href="https://ant.apache.org/">Apache Ant</a>.
In 2021, we moved to using <a href="https://gradle.org/">Gradle</a>.
After <a href="subversion.html">checking out</a> the POI code, you will find <strong>gradlew</strong> and
After <a href="git.html">checking out</a> the POI code, you will find <strong>gradlew</strong> and
<strong>gradlew.bat</strong>. These command files are used for running Gradle on Linux/Mac and Windows respectively.
Gradlew checks if you the right version of Gradle installed and will install it if you don't.
</p>

2
src/documentation/content/xdocs/site.xml
View File

@ -124,7 +124,7 @@ See https://xml.apache.org/forrest/linking.html for more info
<community label="Getting Involved" href="devel/" tab="community">
<howtobuild label="How To Build" href="index.html"/>
<nightly label="Nightly Builds" href="nightly.html"/>
<subversion label="Subversion Repository" href="subversion.html"/>
<git label="Git Repository" href="git.html"/>
<guidelines label="Contribution Guidelines" href="guidelines.html"/>
<whoweare label="Who We Are" href="who.html"/>
<plan label="Planning Documents" href="plan/">

23
src/documentation/publish-poi-site.txt
View File

@ -47,15 +47,28 @@ Building and Deploying the Site
It is recommended that you open a command prompt and set up Java 8 as your default. The web site build will fail
if you use a very recent Java version.
In your local copy of the POI svn (https://github.com/apache/poi/tree/trunk), run:
In your local copy of the POI git (https://github.com/apache/poi/tree/trunk), run using Java 8:
ant site
After this completes, you can copy the files in `build/site` to the `publish` directory in your poi-site checkout
(https://github.com/apache/poi/tree/asf-site).
If you use a newer version, you will get warnings and the output will have issues.
After this completes, you can switch to the `asf-site` branch.
The `ant site` command will have created a directory called `build/site` in your local POI git checkout.
You can copy the files in `build/site` to the `content` directory.
This `content` directory is where the files for the web site are stored
and only appears in the `asf-site` branch.
A command like this might work.
cp -r ~/poi/build/site/* ~/poi-site/publish/
cp -R build/site/* content/
I would recommend that you use `git status` and `git diff` before committing the changes to poi-site.
I would recommend that you use `git status` and `git diff` before committing the changes to asf-site.
It is probably a good idea to check the site locally before committing the changes by opening the
content/index.html file in a browser.
Once you are happy with the changes, you can commit them to the `asf-site` branch.
It is probably a good idea to merge the changes to the `trunk` branch as well but that won't affect the web site.