You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2018/10/30 11:55:38 UTC
svn commit: r1845228 - in /poi/site/src/documentation: ./ content/xdocs/
content/xdocs/components/ content/xdocs/components/spreadsheet/
content/xdocs/help/
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 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ 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 obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!--+
+ | This is the Apache Cocoon command line configuration file.
+ | Here you give the command line interface details of where
+ | to find various aspects of your Cocoon installation.
+ |
+ | If you wish, you can also use this file to specify the URIs
+ | that you wish to generate.
+ |
+ | The current configuration information in this file is for
+ | building the Cocoon documentation. Therefore, all links here
+ | are relative to the build context dir, which, in the build.xml
+ | file, is set to ${build.context}
+ |
+ | Options:
+ | verbose: increase amount of information presented
+ | to standard output (default: false)
+ | follow-links: whether linked pages should also be
+ | generated (default: true)
+ | precompile-only: precompile sitemaps and XSP pages, but
+ | do not generate any pages (default: false)
+ | confirm-extensions: check the mime type for the generated page
+ | and adjust filename and links extensions
+ | to match the mime type
+ | (e.g. text/html->.html)
+ |
+ | Note: Whilst using an xconf file to configure the Cocoon
+ | Command Line gives access to more features, the use of
+ | command line parameters is more stable, as there are
+ | currently plans to improve the xconf format to allow
+ | greater flexibility. If you require a stable and
+ | consistent method for accessing the CLI, it is recommended
+ | that you use the command line parameters to configure
+ | the CLI. See documentation at:
+ | http://cocoon.apache.org/2.1/userdocs/offline/
+ | http://wiki.apache.org/cocoon/CommandLine
+ |
+ +-->
+
+<cocoon verbose="true"
+ follow-links="true"
+ precompile-only="false"
+ confirm-extensions="false">
+
+ <!--+
+ | The context directory is usually the webapp directory
+ | containing the sitemap.xmap file.
+ |
+ | The config file is the cocoon.xconf file.
+ |
+ | The work directory is used by Cocoon to store temporary
+ | files and cache files.
+ |
+ | The destination directory is where generated pages will
+ | be written (assuming the 'simple' mapper is used, see
+ | below)
+ +-->
+ <context-dir>.</context-dir>
+ <config-file>WEB-INF/cocoon.xconf</config-file>
+ <work-dir>../tmp/cocoon-work</work-dir>
+ <dest-dir>../site</dest-dir>
+
+ <!--+
+ | A checksum file can be used to store checksums for pages
+ | as they are generated. When the site is next generated,
+ | files will not be written if their checksum has not changed.
+ | This means that it will be easier to detect which files
+ | need to be uploaded to a server, using the timestamp.
+ |
+ | The default path is relative to the core webapp directory.
+ | An asolute path can be used.
+ +-->
+ <!-- <checksums-uri>build/work/checksums</checksums-uri>-->
+
+ <!--+
+ | Broken link reporting options:
+ | Report into a text file, one link per line:
+ | <broken-links type="text" report="filename"/>
+ | Report into an XML file:
+ | <broken-links type="xml" report="filename"/>
+ | Ignore broken links (default):
+ | <broken-links type="none"/>
+ |
+ | Two attributes to this node specify whether a page should
+ | be generated when an error has occured. 'generate' specifies
+ | whether a page should be generated (default: true) and
+ | extension specifies an extension that should be appended
+ | to the generated page's filename (default: none)
+ |
+ | Using this, a quick scan through the destination directory
+ | will show broken links, by their filename extension.
+ +-->
+ <broken-links type="xml"
+ file="../brokenlinks.xml"
+ generate="false"
+ extension=".error"
+ show-referrers="true"/>
+
+ <!--+
+ | Load classes at startup. This is necessary for generating
+ | from sites that use SQL databases and JDBC.
+ | The <load-class> element can be repeated if multiple classes
+ | are needed.
+ +-->
+ <!--
+ <load-class>org.firebirdsql.jdbc.Driver</load-class>
+ -->
+
+ <!--+
+ | Configures logging.
+ | The 'log-kit' parameter specifies the location of the log kit
+ | configuration file (usually called logkit.xconf.
+ |
+ | Logger specifies the logging category (for all logging prior
+ | to other Cocoon logging categories taking over)
+ |
+ | Available log levels are:
+ | DEBUG: prints all level of log messages.
+ | INFO: prints all level of log messages except DEBUG
+ | ones.
+ | WARN: prints all level of log messages except DEBUG
+ | and INFO ones.
+ | ERROR: prints all level of log messages except DEBUG,
+ | INFO and WARN ones.
+ | FATAL_ERROR: prints only log messages of this level
+ +-->
+ <!-- <logging log-kit="WEB-INF/logkit.xconf" logger="cli" level="ERROR" /> -->
+
+ <!--+
+ | Specifies the filename to be appended to URIs that
+ | refer to a directory (i.e. end with a forward slash).
+ +-->
+ <default-filename>index.html</default-filename>
+
+ <!--+
+ | Specifies a user agent string to the sitemap when
+ | generating the site.
+ |
+ | A generic term for a web browser is "user agent". Any
+ | user agent, when connecting to a web server, will provide
+ | a string to identify itself (e.g. as Internet Explorer or
+ | Mozilla). It is possible to have Cocoon serve different
+ | content depending upon the user agent string provided by
+ | the browser. If your site does this, then you may want to
+ | use this <user-agent> entry to provide a 'fake' user agent
+ | to Cocoon, so that it generates the correct version of your
+ | site.
+ |
+ | For most sites, this can be ignored.
+ +-->
+ <!--
+ <user-agent>Cocoon Command Line Environment 2.1</user-agent>
+ -->
+
+ <!--+
+ | Specifies an accept string to the sitemap when generating
+ | the site.
+ | User agents can specify to an HTTP server what types of content
+ | (by mime-type) they are able to receive. E.g. a browser may be
+ | able to handle jpegs, but not pngs. The HTTP accept header
+ | allows the server to take the browser's capabilities into account,
+ | and only send back content that it can handle.
+ |
+ | For most sites, this can be ignored.
+ +-->
+
+ <accept>*/*</accept>
+
+ <!--+
+ | Specifies which URIs should be included or excluded, according
+ | to wildcard patterns.
+ |
+ | These includes/excludes are only relevant when you are following
+ | links. A link URI must match an include pattern (if one is given)
+ | and not match an exclude pattern, if it is to be followed by
+ | Cocoon. It can be useful, for example, where there are links in
+ | your site to pages that are not generated by Cocoon, such as
+ | references to api-documentation.
+ |
+ | By default, all URIs are included. If both include and exclude
+ | patterns are specified, a URI is first checked against the
+ | include patterns, and then against the exclude patterns.
+ |
+ | Multiple patterns can be given, using muliple include or exclude
+ | nodes.
+ |
+ | The order of the elements is not significant, as only the first
+ | successful match of each category is used.
+ |
+ | Currently, only the complete source URI can be matched (including
+ | any URI prefix). Future plans include destination URI matching
+ | and regexp matching. If you have requirements for these, contact
+ | dev@cocoon.apache.org.
+ +-->
+
+ <exclude pattern="**/"/>
+ <exclude pattern="api/**"/>
+ <!-- POI Customisation - allow us to have an index page at /apidocs/ -->
+ <exclude pattern="**apidocs/dev/**"/>
+ <exclude pattern="**apidocs/3.*/**"/>
+ <exclude pattern="**apidocs/4.*/**"/>
+
+<!--
+ This is a workaround for FOR-284 "link rewriting broken when
+ linking to xml source views which contain site: links".
+ See the explanation there and in declare-broken-site-links.xsl
+-->
+ <exclude pattern="site:**"/>
+ <exclude pattern="ext:**"/>
+ <exclude pattern="lm:**"/>
+ <exclude pattern="**/site:**"/>
+ <exclude pattern="**/ext:**"/>
+ <exclude pattern="**/lm:**"/>
+
+ <!-- Exclude tokens used in URLs to ASF mirrors (interpreted by a CGI) -->
+ <exclude pattern="[preferred]/**"/>
+ <exclude pattern="[location]"/>
+
+ <!-- <include-links extension=".html"/>-->
+
+ <!--+
+ | <uri> nodes specify the URIs that should be generated, and
+ | where required, what should be done with the generated pages.
+ | They describe the way the URI of the generated file is created
+ | from the source page's URI. There are three ways that a generated
+ | file URI can be created: append, replace and insert.
+ |
+ | The "type" attribute specifies one of (append|replace|insert):
+ |
+ | append:
+ | Append the generated page's URI to the end of the source URI:
+ |
+ | <uri type="append" src-prefix="documents/" src="index.html"
+ | dest="build/dest/"/>
+ |
+ | This means that
+ | (1) the "documents/index.html" page is generated
+ | (2) the file will be written to "build/dest/documents/index.html"
+ |
+ | replace:
+ | Completely ignore the generated page's URI - just
+ | use the destination URI:
+ |
+ | <uri type="replace" src-prefix="documents/" src="index.html"
+ | dest="build/dest/docs.html"/>
+ |
+ | This means that
+ | (1) the "documents/index.html" page is generated
+ | (2) the result is written to "build/dest/docs.html"
+ | (3) this works only for "single" pages - and not when links
+ | are followed
+ |
+ | insert:
+ | Insert generated page's URI into the destination
+ | URI at the point marked with a * (example uses fictional
+ | zip protocol)
+ |
+ | <uri type="insert" src-prefix="documents/" src="index.html"
+ | dest="zip://*.zip/page.html"/>
+ |
+ | This means that
+ | (1)
+ |
+ | In any of these scenarios, if the dest attribute is omitted,
+ | the value provided globally using the <dest-dir> node will
+ | be used instead.
+ +-->
+ <!--
+ <uri type="replace"
+ src-prefix="samples/"
+ src="hello-world/hello.html"
+ dest="build/dest/hello-world.html"/>
+ -->
+
+ <!--+
+ | <uri> nodes can be grouped together in a <uris> node. This
+ | enables a group of URIs to share properties. The following
+ | properties can be set for a group of URIs:
+ | * follow-links: should pages be crawled for links
+ | * confirm-extensions: should file extensions be checked
+ | for the correct mime type
+ | * src-prefix: all source URIs should be
+ | pre-pended with this prefix before
+ | generation. The prefix is not
+ | included when calculating the
+ | destination URI
+ | * dest: the base destination URI to be
+ | shared by all pages in this group
+ | * type: the method to be used to calculate
+ | the destination URI. See above
+ | section on <uri> node for details.
+ |
+ | Each <uris> node can have a name attribute. When a name
+ | attribute has been specified, the -n switch on the command
+ | line can be used to tell Cocoon to only process the URIs
+ | within this URI group. When no -n switch is given, all
+ | <uris> nodes are processed. Thus, one xconf file can be
+ | used to manage multiple sites.
+ +-->
+ <!--
+ <uris name="mirrors" follow-links="false">
+ <uri type="append" src="mirrors.html"/>
+ </uris>
+ -->
+
+ <!--+
+ | File containing URIs (plain text, one per line).
+ +-->
+ <!--
+ <uri-file>uris.txt</uri-file>
+ -->
+</cocoon>
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 <a href="../apidocs/org/apache/poi/ss/usermodel/WorkbookFactory.html">WorkbookFactory</a>, <a href="../apidocs/org/apache/poi/ss/usermodel/DataFormatter.html">DataFormatter</a>
+ from org.apache.poi.ss.usermodel import <a href="../apidocs/dev/org/apache/poi/ss/usermodel/WorkbookFactory.html">WorkbookFactory</a>, <a href="../apidocs/dev/org/apache/poi/ss/usermodel/DataFormatter.html">DataFormatter</a>
# Read the contents of the workbook
wb = WorkbookFactory.create(File('<a href="https://svn.apache.org/viewvc/poi/trunk/test-data/spreadsheet/SampleSS.xlsx">SampleSS.xlsx</a>'))
@@ -159,7 +159,7 @@
<section><title>XSSFMain.scala</title>
<source> <!-- lang="scala" -->
// Import the required classes
- import org.apache.poi.ss.usermodel.{<a href="../apidocs/org/apache/poi/ss/usermodel/WorkbookFactory.html">WorkbookFactory</a>, <a href="../apidocs/org/apache/poi/ss/usermodel/DataFormatter.html">DataFormatter</a>}
+ import org.apache.poi.ss.usermodel.{<a href="../apidocs/dev/org/apache/poi/ss/usermodel/WorkbookFactory.html">WorkbookFactory</a>, <a href="../apidocs/dev/org/apache/poi/ss/usermodel/DataFormatter.html">DataFormatter</a>}
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 @@
<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/overview-summary.html">POI API documentation</a> for more details.
+ See also the <a href="../apidocs/dev/overview-summary.html">POI API documentation</a> for more details.
</p>
</section>
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 <a href="eval-devguide.html"> Formula
- evaluation development guide</a> and <a href="../../apidocs/org/apache/poi/hssf/record/formula/functions/package-summary.html">javadocs</a>
+ evaluation development guide</a> and <a href="../../apidocs/dev/org/apache/poi/hssf/record/formula/functions/package-summary.html">javadocs</a>
for details. </p>
<p> Both HSSFWorkbook and XSSFWorkbook are supported, so you can
evaluate formulas on both .xls and .xlsx files.</p>
@@ -298,7 +298,7 @@ for (Sheet sheet : wb) {
</source>
<p>If you don't have access to these other workbooks, then you
should call
- <a href="../../apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks(true)</a>
+ <a href="../../apidocs/dev/org/apache/poi/ss/usermodel/FormulaEvaluator.html#setIgnoreMissingWorkbooks(boolean)">setIgnoreMissingWorkbooks(true)</a>
to tell the Formula Evaluator to skip evaluating any external
references it can't look up.</p>
<p>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
- <a href="../../apidocs/org/apache/poi/ss/usermodel/FormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> workbooks)</a>
+ <a href="../../apidocs/dev/org/apache/poi/ss/usermodel/FormulaEvaluator.html#setupReferencedWorkbooks(java.util.Map)">setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> workbooks)</a>
method. You should normally do something like:</p>
<source>
// 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 @@
<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
- <a href="../../apidocs/org/apache/poi/ss/formula/eval/FunctionEval.html">org.apache.poi.ss.formula.eval.FunctionEval</a>.
+ <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
- <a href="../../apidocs/org/apache/poi/ss/formula/eval/FunctionEval.html#getSupportedFunctionNames()">getSupportedFunctionNames()</a>
+ <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
- <a href="../../apidocs/org/apache/poi/ss/formula/eval/FunctionEval.html#getNotSupportedFunctionNames()">getNotSupportedFunctionNames()</a>
+ <a href="../../apidocs/dev/org/apache/poi/ss/formula/eval/FunctionEval.html#getNotSupportedFunctionNames()">getNotSupportedFunctionNames()</a>
</p>
</section>
@@ -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/">javadocs </a> for details.
+ <p>Check out the <a href="../../apidocs/dev/">javadocs </a> for details.
</p>
</section>
</body>
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 @@
<ul>
<li>
There are some inherent limits in the Excel file formats. These are defined in class
- <a href="../../apidocs/org/apache/poi/ss/SpreadsheetVersion.html">SpreadsheetVersion</a>.
+ <a href="../../apidocs/dev/org/apache/poi/ss/SpreadsheetVersion.html">SpreadsheetVersion</a>.
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.
<br/>
@@ -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 <a href="../../apidocs/org/apache/poi/poifs/macros/VBAMacroExtractor.html">VBAMacroExtractor</a>
- and <a href="../../apidocs/org/apache/poi/poifs/macros/VBAMacroReader.html">VBAMacroReader</a><br/><br/>
+ via <a href="../../apidocs/dev/org/apache/poi/poifs/macros/VBAMacroExtractor.html">VBAMacroExtractor</a>
+ and <a href="../../apidocs/dev/org/apache/poi/poifs/macros/VBAMacroReader.html">VBAMacroReader</a><br/><br/>
</li>
<li>
Pivot Tables<br/><br/>
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 @@
<p>In cases such as these, you should fetch the first and last column
information for a row, then call <em>getCell(int, MissingCellPolicy)</em>
to fetch the cell. Use a
- <a href="../../apidocs/org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html">MissingCellPolicy</a>
+ <a href="../../apidocs/dev/org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html">MissingCellPolicy</a>
to control how blank or null cells are handled.</p>
<source>
// Decide which rows to process
@@ -2401,7 +2401,7 @@ the data to populate another drop down l
<p>
To apply a single set of text formatting (colour, style, font etc)
to a cell, you should create a
- <a href="/../apidocs/org/apache/poi/ss/usermodel/CellStyle.html">CellStyle</a>
+ <a href="/../apidocs/dev/org/apache/poi/ss/usermodel/CellStyle.html">CellStyle</a>
for the workbook, then apply to the cells.
</p>
<source>
@@ -2438,16 +2438,16 @@ the data to populate another drop down l
<p>
To apply different formatting to different parts of a cell, you
need to use
- <a href="../../apidocs/org/apache/poi/ss/usermodel/RichTextString.html">RichTextString</a>,
+ <a href="../../apidocs/dev/org/apache/poi/ss/usermodel/RichTextString.html">RichTextString</a>,
which permits styling of parts of the text within the cell.
</p>
<p>
There are some slight differences between HSSF and XSSF, especially
around font colours (the two formats store colours quite differently
internally), refer to the
- <a href="../../apidocs/org/apache/poi/hssf/usermodel/HSSFRichTextString.html">HSSF Rich Text String</a>
+ <a href="../../apidocs/dev/org/apache/poi/hssf/usermodel/HSSFRichTextString.html">HSSF Rich Text String</a>
and
- <a href="../../apidocs/org/apache/poi/xssf/usermodel/XSSFRichTextString.html">XSSF Rich Text String</a>
+ <a href="../../apidocs/dev/org/apache/poi/xssf/usermodel/XSSFRichTextString.html">XSSF Rich Text String</a>
javadocs for more details.
</p>
</section>
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 @@
<ul>
<li>Binary formats (.xls, .ppt, .doc, ...)<br/>
encryption is format-dependent and needs to be implemented per format differently.<br/>
- Use <a href="apidocs/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html">
- Biff8EncryptionKey</a>.<a href="apidocs/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html#setCurrentUserPassword(java.lang.String)">setCurrentUserPassword</a>(String password)
+ Use <a href="apidocs/dev/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html">
+ Biff8EncryptionKey</a>.<a href="apidocs/dev/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html#setCurrentUserPassword(java.lang.String)">setCurrentUserPassword</a>(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.<br/>
The password is set in a thread local variable. Do not forget to reset it to null after text extraction.
@@ -129,8 +129,8 @@
<section><title>Binary formats</title>
<p>As mentioned above, use
- <a href="apidocs/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html">
- Biff8EncryptionKey</a>.<a href="apidocs/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html#setCurrentUserPassword(java.lang.String)">setCurrentUserPassword</a>(String password)
+ <a href="apidocs/dev/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html">
+ Biff8EncryptionKey</a>.<a href="apidocs/dev/org/apache/poi/hssf/record/crypto/Biff8EncryptionKey.html#setCurrentUserPassword(java.lang.String)">setCurrentUserPassword</a>(String password)
to specify the password.</p>
<source>
@@ -192,7 +192,7 @@ try {
<section><title>XML-based formats - Encryption</title>
<p>Encrypting a file is similar to the above decryption process. Basically you'll need to choose between
- <a href="apidocs/org/apache/poi/poifs/crypt/EncryptionMode.html">binaryRC4, standard and agile encryption</a>,
+ <a href="apidocs/dev/org/apache/poi/poifs/crypt/EncryptionMode.html">binaryRC4, standard and agile encryption</a>,
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.</p>
@@ -234,8 +234,8 @@ fos.close();
<li>Apache Santuario "xmlsec" (tested against 2.1.0)</li>
<li>and slf4j-api (tested against 1.7.25)</li>
</ul>
- <p>Depending on the <a href="apidocs/org/apache/poi/poifs/crypt/dsig/SignatureConfig.html">configuration</a>
- and the activated <a href="apidocs/org/apache/poi/poifs/crypt/dsig/facets/package-summary.html">facets</a>
+ <p>Depending on the <a href="apidocs/dev/org/apache/poi/poifs/crypt/dsig/SignatureConfig.html">configuration</a>
+ and the activated <a href="apidocs/dev/org/apache/poi/poifs/crypt/dsig/facets/package-summary.html">facets</a>
various <a href="https://en.wikipedia.org/wiki/XAdES">XAdES levels</a> 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:
</question>
<answer>
<p>Across most of the UserModel classes (
-<a href="../apidocs/org/apache/poi/POIDocument.html">POIDocument</a>
+<a href="../apidocs/dev/org/apache/poi/POIDocument.html">POIDocument</a>
and
-<a href="../apidocs/org/apache/poi/POIXMLDocument.html">POIXMLDocument</a>),
+<a href="../apidocs/dev/org/apache/poi/POIXMLDocument.html">POIXMLDocument</a>),
you can open the document from a read-only <em>File</em>, a read-write <em>File</em>
or an <em>InputStream</em>. You can always write out to an <em>OutputStream</em>,
and increasing also to a <em>File</em>.
@@ -557,21 +557,21 @@ and
<p>When writing, you can use an <em>OutputStream</em> to write to a new file, or
overwrite an existing one (provided it isn't already open!). On slow links / disks,
wrapping with a <em>BufferedOutputStream</em> is suggested. To write like this, use
-<a href="../apidocs/org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write(OutputStream)</a>.
+<a href="../apidocs/dev/org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write(OutputStream)</a>.
</p>
<p>To write to the currently open file (an in-place write / replace), you need to
have opened your document from a <em>File</em>, not an <em>InputStream</em>. In
addition, you need to have opened from the <em>File</em> in read-write mode, not
read-only mode. To write to the currently open file, on formats that support it
(not all do), use
-<a href="../apidocs/org/apache/poi/POIDocument.html#write()">write()</a>.
+<a href="../apidocs/dev/org/apache/poi/POIDocument.html#write()">write()</a>.
</p>
<p>You can also write out to a new <em>File</em>. 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 <em>OutputStream</em>. 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
-<a href="../apidocs/org/apache/poi/POIDocument.html#write(java.io.File)">write(File)</a>
+<a href="../apidocs/dev/org/apache/poi/POIDocument.html#write(java.io.File)">write(File)</a>
</p>
<p>More information is also available in the
<a href="../components/spreadsheet/quick-guide.html#FileInputStream">HSSF and XSSF documentation</a>,
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
<index label="Home" href="index.html"/>
<download label="Download" href="download.html"/>
<changes label="Changelog" href="changes.html"/>
- <javadocs label="Javadocs" href="ext:javadoc"/>
+ <javadocs label="Javadocs" href="apidocs/index.html"/>
<extraction label="Text Extraction" href="text-extraction.html"/>
<encryption label="Encryption support" href="encryption.html"/>
<casestudies label="Case Studies" href="casestudies.html"/>
@@ -148,8 +148,8 @@ 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"/>
- <javadoc href="apidocs/index.html"/>
<download href="https://www.apache.org/dyn/closer.lua/poi/"/>
</external-refs>
</site>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org