You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2021/01/19 23:44:17 UTC
svn commit: r1885706 - in /poi/site/src/documentation:
content/xdocs/devel/nightly.xml content/xdocs/download.xml
content/xdocs/site.xml skinconf.xml
Author: kiwiwings
Date: Tue Jan 19 23:44:17 2021
New Revision: 1885706
URL: http://svn.apache.org/viewvc?rev=1885706&view=rev
Log:
apply @announce comments
Added:
poi/site/src/documentation/content/xdocs/devel/nightly.xml
- copied, changed from r1885697, poi/site/src/documentation/content/xdocs/devel/index.xml
Modified:
poi/site/src/documentation/content/xdocs/download.xml
poi/site/src/documentation/content/xdocs/site.xml
poi/site/src/documentation/skinconf.xml
Copied: poi/site/src/documentation/content/xdocs/devel/nightly.xml (from r1885697, poi/site/src/documentation/content/xdocs/devel/index.xml)
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/devel/nightly.xml?p2=poi/site/src/documentation/content/xdocs/devel/nightly.xml&p1=poi/site/src/documentation/content/xdocs/devel/index.xml&r1=1885697&r2=1885706&rev=1885706&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/devel/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/devel/nightly.xml Tue Jan 19 23:44:17 2021
@@ -21,162 +21,34 @@
<document>
<header>
- <title>Apache POI - How To Build</title>
- <authors>
- <person email="user@poi.apache.org" name="Glen Stampoultzis" id="GS"/>
- <person email="tetsuya@apache.org" name="Tetsuya Kitahata" id="TK"/>
- <person email="dfisher@jmlafferty.com" name="David Fisher" id="DF"/>
- </authors>
+ <title>Apache POI - Nightly Builds</title>
</header>
<body>
- <section>
- <title>JDK Version</title>
- <p>
- POI 4.0 and later require JDK version 1.8 or later.
- </p>
- <p>
- POI 3.11 and later 3.x versions require JDK version 1.6 or later.
- </p>
- <p>
- POI 3.5 to 3.10 required the JDK version 1.5 or later.
- Versions prior to 3.5 required JDK 1.4+.
- </p>
- </section>
- <section>
- <title>Install Apache Ant</title>
- <p>
- The POI build system requires <a href="https://ant.apache.org/">Apache Ant</a>
- version 1.8 - 1.9.x for Java 1.6 and higher. Newer versions (1.10.x) require Java 8 or higher.
- </p>
- <p>
- The current source code has been tested to work with Ant version 1.9.x and 1.10.x.
- </p>
- <p>
- Remember to set the ANT_HOME environment variable to where Ant was installed/extracted and add
- ANT_HOME/bin to your shell's PATH.
- </p>
- <p>
- If you are unsure about the correct value for ANT_HOME, search your file system for "ant.jar".
- This file will be in the directory %ANT_HOME%/lib." For example, if the path to ant.jar is
- "C:/Programs/Ant/lib/ant.jar", then set ANT_HOME to "C:/Progams/Ant".
- </p>
- </section>
- <section>
- <title>Install Apache Forrest</title>
- <p>
- The POI build system requires
- <a href="https://forrest.apache.org/">Apache Forrest</a>
- to build the documentation.
- </p>
- <p>
- Specifically, the build has been tested to work with Forrest 0.90.
- </p>
- <p>
- Remember to set the FORREST_HOME environment variable.
- </p>
- </section>
- <section>
- <title>Building Targets with Ant</title>
- <p>
- The main targets of interest to our users are:
- </p>
- <table>
- <tr>
- <th>Ant Target</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>clean</td>
- <td>Erase all build work products (ie. everything in the
- build directory</td>
- </tr>
- <tr>
- <td>compile</td>
- <td>Compiles all files from main, ooxml and scratchpad</td>
- </tr>
- <tr>
- <td>test</td>
- <td>Run all unit tests from main, ooxml and scratchpad</td>
- </tr>
- <tr>
- <td>jar</td>
- <td>Produce jar files</td>
- </tr>
- <tr>
- <td>assemble</td>
- <td>Produce .zip and tar.gz distribution packages</td>
- </tr>
- <tr>
- <td>docs</td>
- <td>Generate all documentation (Requires Apache Forrest)</td>
- </tr>
- <tr>
- <td>jenkins</td>
- <td>Runs the tests which Jenkins, our Continuous Integration system, does. This includes the unit tests and various code quality checks.</td>
- </tr>
- </table>
- </section>
- <section>
- <title>Working with Eclipse</title>
- <p>
- Apache POI includes a pre-defined Eclipse project file which can be
- used to quickly get set up in the Eclipse IDE.
- </p>
- <p>
- First make sure that Java is set up properly and that you can execute the 'javac' executable in your shell.
- </p>
- <p>
- Next, open Eclipse and create either a local SVN repository, or a copy of the Git repository,
- and import the project into Eclipse.
- </p>
- <p>
- Right-click on "build.xml", and select "Run As / Ant Build...". The "Edit Configuration"
- dialog should appear. In the "Targets" tab, select the "Compile" target and click on "Run".
- </p>
- <p>
- Note: when executing junit tests from within Eclipse, you might need to set the system
- property "POI.testdata.path" to the actual location of the 'test-data' directory to make
- the test framework find the required test-files. A simple value of 'test-data' usually works.
- </p>
- </section>
- <section>
- <title>Working with IntelliJ Idea</title>
- <p>
- Import the Gradle project into your IDE. Execute a build to get all the dependencies and generated code
- in place.
- </p>
- <p>
- Note: when executing junit tests from within IntelliJ, you might need to set the system
- property "POI.testdata.path" to the actual location of the 'test-data' directory to make
- the test framework find the required test-files. A simple value of 'test-data' usually works.
- </p>
- </section>
- <section>
- <title>Using Maven</title>
- <p>Building Apache POI using Maven is not currently officially
- supported, and we strongly suggest continuing to use the official
- Ant build.</p>
- <p>However, including Apache POI within your own Maven project
- is fully supported, and widely used. Please see the
- <a href="site:components">Components Page</a>
- for details of the Maven artifacts available.</p>
- </section>
- <section>
- <title>Setting environment variables</title>
- <p>Linux:
- <a href="https://help.ubuntu.com/community/EnvironmentVariables">help.ubuntu.com</a>,
- <a href="http://unix.stackexchange.com/questions/117467/how-to-permanently-set-environmental-variables">unix.stackexchange.com</a>
- </p>
- <p>Windows:
- <a href="https://en.wikipedia.org/wiki/Environment_variable#DOS.2C_OS.2F2_and_Windows">en.wikipedia.org</a>
- </p>
+ <section id="nightly">
+ <title>Nightly Builds</title>
+ <p>The POI nightly builds are run on the <a href="https://ci-builds.apache.org/job/POI/">Jenkins</a>
+ continuous integration server.<br/>
+ <strong>These builds should not be used in production</strong>: they are mostly intended for use by
+ developers to help with resolving bugs and evaluating new features or users who want to try out the
+ latest version.
+ </p>
+ <ul>
+ <li>
+ <a href="https://ci-builds.apache.org/job/POI/job/POI-DSL-1.8/lastSuccessfulBuild/artifact/build/dist/">
+ Last Successful Jenkins build for POI-trunk
+ </a>
+ </li>
+ <li>
+ <a href="https://sonarcloud.io/dashboard?id=poi-parent">Sonar statistics for the nightly</a>
+ </li>
+ </ul>
</section>
</body>
<footer>
<legal>
Copyright (c) @year@ The Apache Software Foundation. All rights reserved.
<br />
- Apache POI, POI, Apache, the Apache feather logo, and the Apache
+ Apache POI, POI, Apache, the Apache feather logo, and the Apache
POI project logo are trademarks of The Apache Software Foundation.
</legal>
</footer>
Modified: poi/site/src/documentation/content/xdocs/download.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/download.xml?rev=1885706&r1=1885705&r2=1885706&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/download.xml (original)
+++ poi/site/src/documentation/content/xdocs/download.xml Tue Jan 19 23:44:17 2021
@@ -36,7 +36,7 @@
<a href="#POI-5.0.0">The latest stable release is Apache POI 5.0.0</a>
</li>
<li>
- <a href="#nightly">Nightly/CI builds are available as well</a>
+ <a href="site:nightly" class="sebb">Nightly/CI builds are available as well</a>
</li>
<li>
<a href="#archive">Archives of all prior releases</a>
@@ -104,23 +104,6 @@
</section>
</section>
- <section id="nightly">
- <title>Nightly Builds</title>
- <p>The POI nightly builds are run on the <a href="https://ci-builds.apache.org/job/POI/">Jenkins</a>
- continuous integration server.<br/>
- <strong>These builds should not be used in production</strong>: they are mostly intended for use by
- developers to help with resolving bugs and evaluating new features or users who want to try out the
- latest version.
- </p>
- <ul>
- <li>
- <a href="https://ci-builds.apache.org/job/POI/job/POI-DSL-1.8/lastSuccessfulBuild/artifact/build/dist/">
- Last Successful Jenkins build for POI-trunk
- </a>
- </li>
- </ul>
- </section>
-
<section id="verify">
<title>Verify</title>
<p>
@@ -180,9 +163,6 @@ sub 4096g/7B45A98A 2007-06-18 [expires
<a href="https://archive.apache.org/dist/poi/release/src/">Source Artifacts</a>
</li>
<li>
- <a href="https://archive.apache.org/dist/poi/">Keys</a>
- </li>
- <li>
<a href="https://archive.apache.org/dist/jakarta/poi/release/">Artifacts from prior to 3.0</a>
</li>
</ul>
Modified: poi/site/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/site.xml?rev=1885706&r1=1885705&r2=1885706&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/site.xml (original)
+++ poi/site/src/documentation/content/xdocs/site.xml Tue Jan 19 23:44:17 2021
@@ -120,6 +120,7 @@ See http://xml.apache.org/forrest/linkin
<!-- can't use directory "community" because of forrest default rules in sitemap.xmap -> revisions -->
<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"/>
<guidelines label="Contribution Guidelines" href="guidelines.html"/>
<whoweare label="Who We Are" href="who.html"/>
Modified: poi/site/src/documentation/skinconf.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/skinconf.xml?rev=1885706&r1=1885705&r2=1885706&view=diff
==============================================================================
--- poi/site/src/documentation/skinconf.xml (original)
+++ poi/site/src/documentation/skinconf.xml Tue Jan 19 23:44:17 2021
@@ -283,6 +283,10 @@ which will be used to configure the chos
tr.action td:nth-child(1), tr.action td:nth-child(2), tr.action td:nth-child(3) {
text-align: center;
}
+
+ .sebb, a.sebb:link {
+ color: white;
+ }
</extra-css>
<colors>
<!-- These values are used for the generated CSS files.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org