From commits-return-11760-archive-asf-public=cust-asf.ponee.io@poi.apache.org Tue Oct 30 12:55:42 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id AC03F180652 for ; Tue, 30 Oct 2018 12:55:40 +0100 (CET) Received: (qmail 53597 invoked by uid 500); 30 Oct 2018 11:55:39 -0000 Mailing-List: contact commits-help@poi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@poi.apache.org Delivered-To: mailing list commits@poi.apache.org Received: (qmail 53588 invoked by uid 99); 30 Oct 2018 11:55:39 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 30 Oct 2018 11:55:39 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 188123A00E7 for ; Tue, 30 Oct 2018 11:55:39 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1845228 - in /poi/site/src/documentation: ./ content/xdocs/ content/xdocs/components/ content/xdocs/components/spreadsheet/ content/xdocs/help/ Date: Tue, 30 Oct 2018 11:55:38 -0000 To: commits@poi.apache.org From: nick@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20181030115539.188123A00E7@svn01-us-west.apache.org> Author: nick Date: Tue Oct 30 11:55:38 2018 New Revision: 1845228 URL: http://svn.apache.org/viewvc?rev=1845228&view=rev Log: Update javadocs references to /apidocs/dev/ , and allow for a real page at /apidocs/index.html Added: poi/site/src/documentation/cli.xconf Modified: poi/site/src/documentation/content/xdocs/components/poi-jvm-languages.xml poi/site/src/documentation/content/xdocs/components/poi-ruby.xml poi/site/src/documentation/content/xdocs/components/spreadsheet/eval.xml poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml poi/site/src/documentation/content/xdocs/components/spreadsheet/limitations.xml poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml poi/site/src/documentation/content/xdocs/encryption.xml poi/site/src/documentation/content/xdocs/help/faq.xml poi/site/src/documentation/content/xdocs/site.xml Added: poi/site/src/documentation/cli.xconf URL: http://svn.apache.org/viewvc/poi/site/src/documentation/cli.xconf?rev=1845228&view=auto ============================================================================== --- poi/site/src/documentation/cli.xconf (added) +++ poi/site/src/documentation/cli.xconf Tue Oct 30 11:55:38 2018 @@ -0,0 +1,328 @@ + + + + + + + + . + WEB-INF/cocoon.xconf + ../tmp/cocoon-work + ../site + + + + + + + + + + + + + + + index.html + + + + + + + */* + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modified: poi/site/src/documentation/content/xdocs/components/poi-jvm-languages.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/poi-jvm-languages.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/poi-jvm-languages.xml (original) +++ poi/site/src/documentation/content/xdocs/components/poi-jvm-languages.xml Tue Oct 30 11:55:38 2018 @@ -115,7 +115,7 @@ from contextlib import closing # Import the POI classes - from org.apache.poi.ss.usermodel import WorkbookFactory, DataFormatter + from org.apache.poi.ss.usermodel import WorkbookFactory, DataFormatter # Read the contents of the workbook wb = WorkbookFactory.create(File('SampleSS.xlsx')) @@ -159,7 +159,7 @@
XSSFMain.scala // Import the required classes - import org.apache.poi.ss.usermodel.{WorkbookFactory, DataFormatter} + import org.apache.poi.ss.usermodel.{WorkbookFactory, DataFormatter} import java.io.{File, FileOutputStream} object XSSFMain extends App { 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=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/poi-ruby.xml (original) +++ poi/site/src/documentation/content/xdocs/components/poi-ruby.xml Tue Oct 30 11:55:38 2018 @@ -113,7 +113,7 @@

The tc_base_tests.rb file in the tests sub directory of the source distribution contains examples of simple uses of the API. The quick guide 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 POI API documentation for more details. + See also the POI API documentation for more details.

Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/eval.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/eval.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/spreadsheet/eval.xml (original) +++ poi/site/src/documentation/content/xdocs/components/spreadsheet/eval.xml Tue Oct 30 11:55:38 2018 @@ -58,7 +58,7 @@ It also provides implementations for approx. 140 built in functions in Excel. The framework however makes it easy to add implementation of new functions. See the Formula - evaluation development guide and javadocs + evaluation development guide and javadocs for details.

Both HSSFWorkbook and XSSFWorkbook are supported, so you can evaluate formulas on both .xls and .xlsx files.

@@ -298,7 +298,7 @@ for (Sheet sheet : wb) {

If you don't have access to these other workbooks, then you should call - setIgnoreMissingWorkbooks(true) + setIgnoreMissingWorkbooks(true) to tell the Formula Evaluator to skip evaluating any external references it can't look up.

In order for POI to be able to evaluate external references, it @@ -306,7 +306,7 @@ for (Sheet sheet : wb) { have the same names on your system as in the workbook, you need to give POI a map of external references to open workbooks, through the - setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> workbooks) + setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> workbooks) method. You should normally do something like:

// Create a FormulaEvaluator to use 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=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml (original) +++ poi/site/src/documentation/content/xdocs/components/spreadsheet/formula.xml Tue Oct 30 11:55:38 2018 @@ -79,12 +79,12 @@

To get the list of formula functions that POI supports, you need to call some code!

The methods you need are available on - org.apache.poi.ss.formula.eval.FunctionEval. + org.apache.poi.ss.formula.eval.FunctionEval. To find which functions your copy of Apache POI supports, use - getSupportedFunctionNames() + getSupportedFunctionNames() 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 - getNotSupportedFunctionNames() + getNotSupportedFunctionNames()

@@ -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.)

-

Check out the javadocs for details. +

Check out the javadocs for details.

Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/limitations.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/limitations.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/spreadsheet/limitations.xml (original) +++ poi/site/src/documentation/content/xdocs/components/spreadsheet/limitations.xml Tue Oct 30 11:55:38 2018 @@ -40,7 +40,7 @@
  • There are some inherent limits in the Excel file formats. These are defined in class - SpreadsheetVersion. + SpreadsheetVersion. As long as you have enough main-memory, you should be able to handle files up to these limits. For huge files using the default POI classes you will likely need a very large amount of memory.
    @@ -85,8 +85,8 @@ Macros can not be created. The are currently no plans to support macros. However, reading and re-writing files containing macros will safely preserve the macros. Recent versions of Apache POI support extracting the macro data - via VBAMacroExtractor - and VBAMacroReader

    + via VBAMacroExtractor + and VBAMacroReader

  • Pivot Tables

    Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml (original) +++ poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml Tue Oct 30 11:55:38 2018 @@ -363,7 +363,7 @@

    In cases such as these, you should fetch the first and last column information for a row, then call getCell(int, MissingCellPolicy) to fetch the cell. Use a - MissingCellPolicy + MissingCellPolicy to control how blank or null cells are handled.

    // Decide which rows to process @@ -2401,7 +2401,7 @@ the data to populate another drop down l

    To apply a single set of text formatting (colour, style, font etc) to a cell, you should create a - CellStyle + CellStyle for the workbook, then apply to the cells.

    @@ -2438,16 +2438,16 @@ the data to populate another drop down l

    To apply different formatting to different parts of a cell, you need to use - RichTextString, + RichTextString, which permits styling of parts of the text within the cell.

    There are some slight differences between HSSF and XSSF, especially around font colours (the two formats store colours quite differently internally), refer to the - HSSF Rich Text String + HSSF Rich Text String and - XSSF Rich Text String + XSSF Rich Text String javadocs for more details.

    Modified: poi/site/src/documentation/content/xdocs/encryption.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/encryption.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/encryption.xml (original) +++ poi/site/src/documentation/content/xdocs/encryption.xml Tue Oct 30 11:55:38 2018 @@ -35,8 +35,8 @@
    • Binary formats (.xls, .ppt, .doc, ...)
      encryption is format-dependent and needs to be implemented per format differently.
      - Use - Biff8EncryptionKey.setCurrentUserPassword(String password) + Use + Biff8EncryptionKey.setCurrentUserPassword(String password) to specify the decryption password before opening the file or (where applicable) before saving. Setting a null password before saving removes the password protection.
      The password is set in a thread local variable. Do not forget to reset it to null after text extraction. @@ -129,8 +129,8 @@
      Binary formats

      As mentioned above, use - - Biff8EncryptionKey.setCurrentUserPassword(String password) + + Biff8EncryptionKey.setCurrentUserPassword(String password) to specify the password.

      @@ -192,7 +192,7 @@ try {
      XML-based formats - Encryption

      Encrypting a file is similar to the above decryption process. Basically you'll need to choose between - binaryRC4, standard and agile encryption, + binaryRC4, standard and agile encryption, the cryptoAPI mode is used internally and it's direct use would result in an incomplete file. Apart of the CipherMode, the EncryptionInfo class provides further parameters to specify the cipher and hashing algorithm to be used.

      @@ -234,8 +234,8 @@ fos.close();
    • Apache Santuario "xmlsec" (tested against 2.1.0)
    • and slf4j-api (tested against 1.7.25)
    -

    Depending on the configuration - and the activated facets +

    Depending on the configuration + and the activated facets various XAdES levels are supported - the support for higher levels (XAdES-T+) depend on supporting services and although the code is adopted, the integration is not well tested ... please support us on integration (testing) with timestamp and revocation (OCSP) services. Modified: poi/site/src/documentation/content/xdocs/help/faq.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/help/faq.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/help/faq.xml (original) +++ poi/site/src/documentation/content/xdocs/help/faq.xml Tue Oct 30 11:55:38 2018 @@ -544,9 +544,9 @@ case HSSFCell.CELL_TYPE_NUMERIC:

    Across most of the UserModel classes ( -POIDocument +POIDocument and -POIXMLDocument), +POIXMLDocument), you can open the document from a read-only File, a read-write File or an InputStream. You can always write out to an OutputStream, and increasing also to a File. @@ -557,21 +557,21 @@ and

    When writing, you can use an OutputStream to write to a new file, or overwrite an existing one (provided it isn't already open!). On slow links / disks, wrapping with a BufferedOutputStream is suggested. To write like this, use -write(OutputStream). +write(OutputStream).

    To write to the currently open file (an in-place write / replace), you need to have opened your document from a File, not an InputStream. In addition, you need to have opened from the File in read-write mode, not read-only mode. To write to the currently open file, on formats that support it (not all do), use -write(). +write().

    You can also write out to a new File. This is available no matter how you opened the document, and will create/replace a new file. It is faster and lower memory than writing to an OutputStream. However, you can't use this to replace the currently open file, only files not currently open. To write to a new / different file, use -write(File) +write(File)

    More information is also available in the HSSF and XSSF documentation, Modified: poi/site/src/documentation/content/xdocs/site.xml URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/site.xml?rev=1845228&r1=1845227&r2=1845228&view=diff ============================================================================== --- poi/site/src/documentation/content/xdocs/site.xml (original) +++ poi/site/src/documentation/content/xdocs/site.xml Tue Oct 30 11:55:38 2018 @@ -35,7 +35,7 @@ See http://xml.apache.org/forrest/linkin - + @@ -148,8 +148,8 @@ See http://xml.apache.org/forrest/linkin + - --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org For additional commands, e-mail: commits-help@poi.apache.org