Author: kiwiwings Date: Fri Feb 14 21:29:28 2020 New Revision: 1874034 URL: http://svn.apache.org/viewvc?rev=1874034&view=rev Log: use javadocs overview page
Modified: poi/site/src/documentation/content/xdocs/apidocs/index.xml poi/site/src/documentation/content/xdocs/components/poi-ruby.xml poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml poi/site/src/documentation/content/xdocs/site.xml Modified: poi/site/src/documentation/content/xdocs/apidocs/index.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/apidocs/index.xml?rev=1874034&r1=1874033&r2=1874034&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/apidocs/index.xml (original) +++ poi/site/src/documentation/content/xdocs/apidocs/index.xml Fri Feb 14 21:29:28 2020 @@ -31,10 +31,10 @@ <section><title>Apache POI Javadocs</title> <p> The Javadocs for the latest (development) version of Apache POI - can be <a href="/apidocs/dev/">accessed online here</a>, or build - from a <a href="/devel/subversion.html">source code checkout</a> - by running the <em>javadocs</em> Ant task. The - <a href="/apidocs/dev/">latest (development) Javadocs</a> are generally + can be <a href="dev/index.html">accessed online here</a>, or build + from a <a href="site:subversion">source code checkout</a> + by running the <em>javadocs</em> Ant task. The + <a href="dev/index.html">latest (development) Javadocs</a> are generally updated every few weeks, so may lag the most recent development slightly. </p> <p> @@ -42,9 +42,9 @@ each the family can also be browsed online: </p> <ul> - <li><a href="/apidocs/4.1/">Apache POI 4.1.x Javadocs</a></li> - <li><a href="/apidocs/4.0/">Apache POI 4.0.x Javadocs</a></li> - <li><a href="/apidocs/3.17/">Apache POI 3.17 Javadocs</a></li> + <li><a href="4.1/index.html">Apache POI 4.1.x Javadocs</a></li> + <li><a href="4.0/index.html">Apache POI 4.0.x Javadocs</a></li> + <li><a href="3.17/index.html">Apache POI 3.17 Javadocs</a></li> </ul> <section><title>Older Releases</title> @@ -77,7 +77,7 @@ <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/components/poi-ruby.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/poi-ruby.xml?rev=1874034&r1=1874033&r2=1874034&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/poi-ruby.xml (original) +++ poi/site/src/documentation/content/xdocs/components/poi-ruby.xml Fri Feb 14 21:29:28 2020 @@ -113,7 +113,7 @@ <p> The <em>tc_base_tests.rb</em> file in the <em>tests</em> sub directory of the source distribution contains examples of simple uses of the API. The <a href="spreadsheet/quick-guide.html">quick guide </a> is the best place to learn HSSF API use. (Note however that none of the Drawing features are implemented in the Ruby binding.) - See also the <a href="../apidocs/dev/overview-summary.html">POI API documentation</a> for more details. + See also the <a href="site:javadocs">POI API documentation</a> for more details. </p> </section> @@ -145,7 +145,7 @@ <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/components/spreadsheet/formula.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml?rev=1874034&r1=1874033&r2=1874034&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml (original) +++ poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml Fri Feb 14 21:29:28 2020 @@ -29,28 +29,28 @@ <body> <section><title>Introduction</title> <p> - This document describes the current state of formula support in POI. - The information in this document currently applies to the 3.13 version of POI. - Since this area is a work in progress, this document will be updated with new - features as and when they are added. + This document describes the current state of formula support in POI. + The information in this document currently applies to the 3.13 version of POI. + Since this area is a work in progress, this document will be updated with new + features as and when they are added. </p> - + </section> <section><title>The basics</title> <p> In org.apache.poi.ss.usermodel.Cell - <strong> setCellFormula("formulaString") </strong> is used to add a - formula to a sheet, and <strong> getCellFormula() </strong> is used to retrieve - the string representation of a formula. + <strong> setCellFormula("formulaString") </strong> is used to add a + formula to a sheet, and <strong> getCellFormula() </strong> is used to retrieve + the string representation of a formula. </p> <p> - We aim to support the complete excel grammar for formulas. Thus, the string that - you pass in to the <em> setCellFormula </em> call should be what you expect to - type into excel. Also, note that you should NOT add a "=" to the front of the string. + We aim to support the complete excel grammar for formulas. Thus, the string that + you pass in to the <em> setCellFormula </em> call should be what you expect to + type into excel. Also, note that you should NOT add a "=" to the front of the string. </p> <p> - Please note that localized versions of Excel allow to enter localized - function-names. However internally Excel stores the English names and thus POI + Please note that localized versions of Excel allow to enter localized + function-names. However internally Excel stores the English names and thus POI only supports these and not the localized ones. Also note that only commas may be used to separate arguments, as per the Excel English style, alternate delimeters used in other localizations are not supported. @@ -78,9 +78,9 @@ <section><title>Supported Functions</title> <p>To get the list of formula functions that POI supports, you need to call some code!</p> - <p>The methods you need are available on + <p>The methods you need are available on <a href="../../apidocs/dev/org/apache/poi/ss/formula/eval/FunctionEval.html">org.apache.poi.ss.formula.eval.FunctionEval</a>. - To find which functions your copy of Apache POI supports, use + To find which functions your copy of Apache POI supports, use <a href="../../apidocs/dev/org/apache/poi/ss/formula/eval/FunctionEval.html#getSupportedFunctionNames()">getSupportedFunctionNames()</a> to get a list of the implemented function names. For the list of functions that POI knows the name of, but doesn't currently implement, use @@ -90,19 +90,19 @@ <section><title>Internals</title> <p> - Formulas in Excel are stored as sequences of tokens in Reverse Polish Notation order. The + Formulas in Excel are stored as sequences of tokens in Reverse Polish Notation order. The <a href="http://sc.openoffice.org/excelfileformat.pdf">open office XLS spec</a> is the best documentation you will find for the format. </p> <p> The tokens used by excel are modeled as individual *Ptg classes in the <strong> - org.apache.poi.hssf.record.formula</strong> package. + org.apache.poi.hssf.record.formula</strong> package. </p> <p> The task of parsing a formula string into an array of RPN ordered tokens is done by the <strong> - org.apache.poi.ss.formula.FormulaParser</strong> class. This class implements a hand - written recursive descent parser. + org.apache.poi.ss.formula.FormulaParser</strong> class. This class implements a hand + written recursive descent parser. </p> <p> Formula tokens in Excel are stored in one of three possible <em> operand classes </em>: @@ -113,7 +113,7 @@ occurrence of #VALUE! in a cell upon opening a POI generated workbook in excel. (Check that typing the formula into Excel directly gives a valid result.) </p> - <p>Check out the <a href="../../apidocs/dev/">javadocs </a> for details. + <p>Check out the <a href="site:javadocs">javadocs </a> for details. </p> </section> </body> Modified: poi/site/src/documentation/content/xdocs/site.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/site.xml?rev=1874034&r1=1874033&r2=1874034&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/site.xml (original) +++ poi/site/src/documentation/content/xdocs/site.xml Fri Feb 14 21:29:28 2020 @@ -51,7 +51,7 @@ See http://xml.apache.org/forrest/linkin </apache> <components label="Component APIs" href="components/" tab="components"> <index label="Overview" href="index.html"/> - <javadocs label="Javadocs" href="ext:javadoc"/> + <javadocs label="Javadocs" href="site:javadocs"/> <spreadsheet label="Excel (HSSF/XSSF)" href="spreadsheet/"> <index label="Overview" href="index.html"/> <ssquickguide label="Quick Guide" href="quick-guide.html"/> @@ -153,7 +153,6 @@ See http://xml.apache.org/forrest/linkin <cocoon href="http://cocoon.apache.org/"/> <xml.apache.org href="http://xml.apache.org/"/> <junit href="junit/index.html"/> - <javadoc href="apidocs/dev/index.html"/> <jdepend href="jdepend/index.html"/> <download href="https://www.apache.org/dyn/closer.lua/poi/"/> </external-refs> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org For additional commands, e-mail: commits-h...@poi.apache.org