From b8e604c5610887c5f96df1994a85605b317a6540 Mon Sep 17 00:00:00 2001 From: stfm Date: Sat, 23 Jun 2012 15:26:33 +0200 Subject: [PATCH] README.md updated and doc file added --- README.md | 15 ++++++--- doc/README_by_SoerenCaspersen.txt | 53 +++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+), 4 deletions(-) create mode 100644 doc/README_by_SoerenCaspersen.txt diff --git a/README.md b/README.md index 3784110..9906ba0 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,7 @@ TeXDoclet is a Java doclet implementation that generates a LaTeX file from you J The doclet is based on the doclet originally created by Greg Wonderly of [C2 technologies Inc.](http://www.c2-tech.com>) and its revision by Soeren Caspersen of -[XO Software](http://www.xosoftware.dk). The project of Greg Wonderly is available here: -. +[XO Software](http://www.xosoftware.dk). See for more information. @@ -18,7 +17,7 @@ Build Run --- -You have to specify that *javadoc* has to use another doclet than the default doclet by giving the following parameters to the *javadoc* call : +You have to specify that *javadoc* has to use another doclet than the default doclet by giving the following options to the *javadoc* call : javadoc -docletpath TeXDoclet.jar \ -doclet org.stfm.texdoclet.TeXDoclet \ @@ -41,10 +40,14 @@ Example : See `createDocs.sh` scripts in `/examples` subdirectory for more examples. -Print help : +Print help (TeXDoclet + javadoc help) : javadoc -docletpath target/TeXDoclet.jar -doclet org.stfm.texdoclet.TeXDoclet +or (TeXDoclet help only) : + + java -jar target/TeXDoclet.jar -h + TeXDoclet usage : -title A title to use for the generated output document. @@ -80,4 +83,8 @@ TeXDoclet usage : -imagespath Path to the texdoclet_images dir (absolute or relative to the output document .tex file). +Previous versions +----------------- +- The intitial project of Greg Wonderly is available here : <http://java.net/projects/texdoclet>. +- Its [revision](http://egee-jra1-integration.web.cern.ch/egee-jra1-integration/repository/texdoclet/1.3/share/README.txt) by Soeren Caspersen you find here : <http://egee-jra1-integration.web.cern.ch/egee-jra1-integration/repository/texdoclet>. diff --git a/doc/README_by_SoerenCaspersen.txt b/doc/README_by_SoerenCaspersen.txt new file mode 100644 index 0000000..7a18450 --- /dev/null +++ b/doc/README_by_SoerenCaspersen.txt @@ -0,0 +1,53 @@ +This is a variant of the TexDoclet written by Greg Wonderly of C2 technologies. +The original can be found at http://www.c2-tech.com/java/texdoclet. + +If you are familiar with the original TexDoclet, these are the additional features +this doclet has to offer: + +- hyperref. This doclet uses the hyperref package, which means that + you will be able to produce a browsable PDF-file with much similar + features to those of Sun's standard doclet. +- A complete class hierarchy. +- Support for the standard option "-overview", which will generate a new + chapter "Introduction". +- An index of all classes, interfaces, methods and fields. +- Support for double sided printing, +- Support for version tags. +- Support for throws tags +- A re engineered HTML to LaTeX translator. Gregs HTML-parser was not + very robust to "sloppy" HTML (no offense Greg:-). Instead a back end + to swings HTML-parser has been implemented. The result is a much more + robust translation. However, the number of supported HTML tags is still + about the same. +- A new exciting feature is the possibility of passing TeX directly to + the TeX-compiler. This of course can seriously compromise the translation + of HTML into LaTeX, but offers great possibilities for TeXperts. For example + + <TEX txt="\LaTeX{}">LaTeX</TEX> + + will result in the well known LaTeX-logo. Between the begin-tag and end-tag + it is possible to give some alternative HTML that will be ignored by the + TexDoclet, but will appear if the HTML is parsed by a doclet other that the + TexDoclet. It is encouraged to use this feature since it ensures that your + javadoc also makes sense when used with other doclets. + This feature makes it possible to use scientific notation and to include + postscript images and much more. +- If an method is undocumented, the javadoc of the overridden method (if any) or + javadoc of implementet interfaces is copied, as is the case in the standard + doclet provided by Sun. +- "All known subclasses" and "All classes known to implement interface" sections + are createt for each class/interface. +- Support for the HTML tags <IMG>, <SUP> and <SUB>. +- Summaries of fields, constructors and methods. + + +TeXDocumentation.bat provides an example of how to use the doclet and compile +the result using the pdflatex compiler. JDK1.2 or higher and pdflatex is assumed +to be available on your path. + +The TexDoclet now ships with the PngEncoder which is distributed under the LGPL +(Lesser Gnu Public License). + + +Søren Caspersen +XO Software \ No newline at end of file