pietsch 2003/03/13 16:12:11 Modified: src/documentation/content/xdocs gethelp.xml pdfencryption.xml running.xml Log: 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. Revision Changes Path 1.3 +68 -44 xml-fop/src/documentation/content/xdocs/gethelp.xml Index: gethelp.xml =================================================================== RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/gethelp.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- gethelp.xml 19 Nov 2002 07:57:27 -0000 1.2 +++ gethelp.xml 14 Mar 2003 00:12:10 -0000 1.3 @@ -1,50 +1,74 @@ <?xml version="1.0" standalone="no"?> <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd"> - - -<!-- How to get Help --> <document> - <header> - <title>How to Get Help</title> - <subtitle>Solving problems</subtitle> - </header> - - <body> -<section> - <title>How to get Help</title> - <ol> - <li> - 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. - </li> - <li> - Consult the <link href="faq.html">FAQ</link> to see if your question has already been answered before. - </li> - <li> - If you have a question concerning XSL:FO that is not related to FOP directly, please consult the various - resources on the net. See <link href="resources.html">Resources</link> for some interesting links. - </li> - <li> - 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 <link href="resources.html">Resources</link>. - </li> - <li> - 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 <link href="resources.html">Resources</link> - </li> - <li> -You should probably read ESR's -<link href="http://www.tuxedo.org/~esr/faqs/smart-questions.html">"How to Ask Questions the Smart Way"</link> - </li> - </ol> - <note> - 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. - </note> -</section> - </body> + <header> + <title>How to Get Help</title> + <subtitle>Solving problems</subtitle> + </header> + <body> + <section> + <title>How to get Help</title> + <ol> + <li> + 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. + </li> + <li> + Consult the <link href="faq.html">FAQ</link> to see if your question + has already been answered before. + </li> + <li> + 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 <link href="resources.html">Resources</link> for some + interesting links. + </li> + <li> + 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 + <link href="resources.html">Resources</link>. + </li> + <li> + 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: + <ol> + <li>State the version of FOP you're using.</li> + <li>Include detailed error messages, if there are any.</li> + <li>Provide FO code instead of XSLT snippets or DocBook source. + See <link href="running.html#running_xalan">Running Xalan</link> + for how to produce FO from your XML+XSLT.</li> + <li>Provide complete, <strong>self-contained</strong> FO code. + This includes images. Be careful with confidential material + though.</li> + <li>Provide <strong>short</strong>, self-contained FO code. Cut + out everything unnecessary to demonstrate the effect, in + particular images.</li> + <li>Prune stack traces sensibly instead of dumping the whole + shebang.</li> + <li>Instead of attaching large PDF files or screen shots, use a + small B&W GIF, JPG or PNG of the area of interest.</li> + </ol> + This makes it easier to help you. The instructions on how to + subscribe to the mailin lists can be found in the <link + href="resources.html">Resources</link>. + </li> + <li> + You should probably read <link + href="http://www.tuxedo.org/~esr/faqs/smart-questions.html">"How to + Ask Questions the Smart Way"</link>. + </li> + </ol> + <note> + Please don't use Bugzilla to post questions. Please ask on the user + mailing list first if you think you've found a bug. + </note> + </section> + </body> </document> 1.3 +23 -17 xml-fop/src/documentation/content/xdocs/pdfencryption.xml Index: pdfencryption.xml =================================================================== RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/pdfencryption.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- pdfencryption.xml 12 Mar 2003 15:53:31 -0000 1.2 +++ pdfencryption.xml 14 Mar 2003 00:12:10 -0000 1.3 @@ -6,7 +6,7 @@ <header> <title>PDF encryption.</title> <authors> - <person name="Patrick C. Lankswert" email=""/> + <person name="J.Pietschmann" email="[EMAIL PROTECTED]"/> </authors> </header> <body> @@ -15,7 +15,7 @@ <p> 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 @@ <section> <title>Usage</title> <p> - Encryption is enabled by supplying an owner password with the - <code>-o</code> 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. + </p> + <p> + An owner password with the <code>-o</code> 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. + </p> + <p> + If no owner password has been supplied but FOP was asked to apply some + restrictions, a random password is used. </p> <p> A user password, supplied with the <code>-u</code> option, will @@ -44,11 +50,10 @@ supplied, viewing the content is not restricted. </p> <p> - Further restrictions can be imposed by using the - <code>-noprint</code>, <code>-nocopy</code>, - <code>-noedit</code> and <code>-noannotations</code> options, - which disable printing, copy text, editing in Adobe Acrobat and making - annotations, respectively. + Further restrictions can be imposed by using the <code>-noprint</code>, + <code>-nocopy</code>, <code>-noedit</code> and + <code>-noannotations</code> options, which disable printing, copying + text, editing in Adobe Acrobat and making annotations, respectively. </p> </section> <section> @@ -58,8 +63,9 @@ support. Currently, only <link href="http://java.sun.com/j2se/1.4/docs/guide/security/jce/JCERefGuide.html">JCE</link> 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. </p> <p> Cryptography support must also be present at run time. In particular, a @@ -69,7 +75,7 @@ </p> <source>"Cannot find any provider supporting RC4"</source> <p> - you don't have the needed support. + then you don't have the needed support. </p> <p> There are several commercial and a few Open Source packages which @@ -80,7 +86,7 @@ JSS</link> is an interface to a native implementation. </p> </section> - <section> + <section id="install_crypto"> <title>Installing a crypto provider</title> <p> The pure Java implementation from <link @@ -90,7 +96,7 @@ <ol> <li> 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. </li> <li> Unpack the distribution. Add the jar file to your classpath. A 1.6 +26 -8 xml-fop/src/documentation/content/xdocs/running.xml Index: running.xml =================================================================== RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/running.xml,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- running.xml 5 Mar 2003 23:15:25 -0000 1.5 +++ running.xml 14 Mar 2003 00:12:11 -0000 1.6 @@ -80,12 +80,30 @@ fop foo.fo -print or Fop -print foo.fo fop foo.fo -awt</source> <p>PDF encryption is only available if FOP was compiled with encryption support <strong>and</strong> if compatible encryption support is availabe at run time. Currently, only the JCE is supported. Check the <link href="pdfencryption.html">Details</link>.</p> - </section> - - <section> - <title>Problems</title> - <p>If you have problems running FOP, please have a look at the <jump href="gethelp.html">"How to get Help" page</jump>.</p> - </section> - -</body> + </section> + <section id="running_xalan"> + <title>Running Xalan</title> + <p> + 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. + </p> + <p> + The scripts are invoked the same way <link href="http://xml.apache.org/xalan-j/commandline.html">Xalan</link> is, in short: + </p> + <p> + <code>xalan -in xmlfile -xsl file -out outfile</code> + </p> + <p> + Note that there are subtle differences to the FOP command line. + </p> + </section> + <section> + <title>Problems</title> + <p>If you have problems running FOP, please have a look at the <jump href="gethelp.html">"How to get Help" page</jump>.</p> + </section> + </body> </document>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]