How to Get Help

Date: Fri, 14 Mar 2003 00:12:11 +0000 Subject: [PATCH] Took pdfencryption autorship back. Fixed some weak formulations and spelling errors. Added documentation for xalan scripts. Added a few short guidelines for posting to the mailing lists. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196093 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/gethelp.xml | 112 +++++++++++------- .../content/xdocs/pdfencryption.xml | 40 ++++--- src/documentation/content/xdocs/running.xml | 34 ++++-- 3 files changed, 117 insertions(+), 69 deletions(-) diff --git a/src/documentation/content/xdocs/gethelp.xml b/src/documentation/content/xdocs/gethelp.xml index b7587e61f..431aab99a 100644 --- a/src/documentation/content/xdocs/gethelp.xml +++ b/src/documentation/content/xdocs/gethelp.xml @@ -1,50 +1,74 @@ - - - -

- How to Get Help - Solving problems -

- - -

- How to get Help -

- Have a look at the documentation pages on this site. You can find information on how to run FOP, - how to embed it, how to add custom fonts etc. -
- Consult the FAQ to see if your question has already been answered before. -
- If you have a question concerning XSL:FO that is not related to FOP directly, please consult the various - resources on the net. See Resources for some interesting links. -
- Before you post your questions to one of the mailing lists, please search the mailing list archives, since it's - possible that your question has already been answered but it may not have found its way into the FAQ. You'll - find links to the mailing list archive in the Resources. -
- If you still can't solve your problem subscribe to FOP's user mailing list and post your question there. Please - don't forget to supply the version you're using, detailed error messages etc. This makes it easier to help you. - The instructions on how to subscribe can be found in the Resources -
-You should probably read ESR's -"How to Ask Questions the Smart Way" -

- - Please don't use Bugzilla to post questions and please ask on the user mailing list first, if you think you've - found a bug. - -

- +

+ How to Get Help + Solving problems +

+ +

+ How to get Help +

+ Have a look at the documentation pages on this site. You can find + information on how to run FOP, how to embed it, how to add custom + fonts etc. +
+ Consult the FAQ to see if your question + has already been answered before. +
+ If you have a question concerning XSLFO that is not related to FOP + directly or regarding XSLT, please consult the various resources on + the net. See Resources for some + interesting links. +
+ Before you post your questions to one of the mailing lists, please + search the mailing list archives, since it's possible that your + question has already been answered but it may not have found its way + into the FAQ. You'll find links to the mailing list archive in the + Resources. +
+ If you still can't solve your problem subscribe to FOP's user mailing + list and post your question there. Your question is likely to be + handled more favorably the further down the following checklist + you get: +
1. State the version of FOP you're using.
2. Include detailed error messages, if there are any.
3. Provide FO code instead of XSLT snippets or DocBook source. + See Running Xalan + for how to produce FO from your XML+XSLT.
4. Provide complete, self-contained FO code. + This includes images. Be careful with confidential material + though.
5. Provide short, self-contained FO code. Cut + out everything unnecessary to demonstrate the effect, in + particular images.
6. Prune stack traces sensibly instead of dumping the whole + shebang.
7. Instead of attaching large PDF files or screen shots, use a + small B&W GIF, JPG or PNG of the area of interest.
+ This makes it easier to help you. The instructions on how to + subscribe to the mailin lists can be found in the Resources. +
+ You should probably read "How to + Ask Questions the Smart Way". +

+ + Please don't use Bugzilla to post questions. Please ask on the user + mailing list first if you think you've found a bug. + +

+ diff --git a/src/documentation/content/xdocs/pdfencryption.xml b/src/documentation/content/xdocs/pdfencryption.xml index e7f0e7bcc..b555fc832 100755 --- a/src/documentation/content/xdocs/pdfencryption.xml +++ b/src/documentation/content/xdocs/pdfencryption.xml @@ -6,7 +6,7 @@

PDF encryption. - +

@@ -15,7 +15,7 @@

FOP supports encryption of PDF output, thanks to Patrick C. Lankswert. This feature is commonly used to prevent unauthorized - printing, editing and copying text from the document or to forbid + viewing, printing, editing and copying text from the document annotations. It is also possible to ask the user for a password in order to view the contents. Note that there already exist third party applications which can decrypt an encrypted PDF without effort and allow @@ -31,11 +31,17 @@

Usage

- Encryption is enabled by supplying an owner password with the - -o option. The owner password can be used to disregard - any restriction imposed on the PDF document. If no owner password has - been supplied but FOP was asked to apply some restrictions, a random - password is used. + Encryption is enabled by supplying any of the encryption related + options. +

+ An owner password with the -o option. This password is + actually used as encryption key. Usually it is also used by most tools + to disregard any restriction imposed on the PDF document. +

+ If no owner password has been supplied but FOP was asked to apply some + restrictions, a random password is used.

A user password, supplied with the -u option, will @@ -44,11 +50,10 @@ supplied, viewing the content is not restricted.

- Further restrictions can be imposed by using the - -noprint, -nocopy, - -noedit and -noannotations options, - which disable printing, copy text, editing in Adobe Acrobat and making - annotations, respectively. + Further restrictions can be imposed by using the -noprint, + -nocopy, -noedit and + -noannotations options, which disable printing, copying + text, editing in Adobe Acrobat and making annotations, respectively.

@@ -58,8 +63,9 @@ support. Currently, only JCE is supported. JCE is part of JDK 1.4. For earlier JDKs, it can be - installed separately, however, the build process currently recognizes - JCE from JDK 1.4. + installed separately. The build process automatically senses JCE + presence and installs PDF support if possible, otherwise, a stub is + compiled in.

Cryptography support must also be present at run time. In particular, a @@ -69,7 +75,7 @@

"Cannot find any provider supporting RC4"

- you don't have the needed support. + then you don't have the needed support.

There are several commercial and a few Open Source packages which @@ -80,7 +86,7 @@ JSS is an interface to a native implementation.

Installing a crypto provider

The pure Java implementation from

Download the binary distribution for your JDK version. If you have JDK - 1.3 or earlier you must alos download a JCE from the same page. + 1.3 or earlier you must also download a JCE from the same page.

Unpack the distribution. Add the jar file to your classpath. A diff --git a/src/documentation/content/xdocs/running.xml b/src/documentation/content/xdocs/running.xml index 5e420bf98..84d1dd786 100644 --- a/src/documentation/content/xdocs/running.xml +++ b/src/documentation/content/xdocs/running.xml @@ -80,12 +80,30 @@ fop foo.fo -print or Fop -print foo.fo fop foo.fo -awt

PDF encryption is only available if FOP was compiled with encryption support and if compatible encryption support is availabe at run time. Currently, only the JCE is supported. Check the Details.

- -

- Problems -

If you have problems running FOP, please have a look at the "How to get Help" page.

- - +

+ Running Xalan +

+ The FOP distribution provicdes a Xalan.bat and a Xalan.sh + script for conveniently running an XSL transformation without + formatting. This can be useful for tracking down problems + introduced during transformation and for preparing FO files + for all kinds of purposes, including for inquiring help on the + mailing lists. +

+ The scripts are invoked the same way Xalan is, in short: +

+ xalan -in xmlfile -xsl file -out outfile +

+ Note that there are subtle differences to the FOP command line. +

+ Problems +

If you have problems running FOP, please have a look at the "How to get Help" page.

+ -- 2.39.5