Tools/texdoclet
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

initial code + examples commit

Browse Source
This commit is contained in:
stfm
2012-06-19 01:17:56 +02:00
parent fca776b92b
commit bafa4ca8c9
29 changed files with 5100 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
examples/example1_complete_report/createDocs.sh Executable file
View File

@@ -0,0 +1,24 @@
mkdir texdoclet_output
rm texdoclet_output/TeXDoclet.aux
javadoc -docletpath ../../target/TeXDoclet.jar \
-doclet org.stfm.texdoclet.TeXDoclet \
-noindex \
-tree \
-hyperref \
-texinit texdoclet_include/preamble.tex \
-imagespath ".." \
-output texdoclet_output/TeXDoclet.tex \
-title "TeXDoclet Java Documentation" \
-subtitle "Created with Javadoc TeXDoclet Doclet" \
-author "Greg Wonderly \and S\"oren Caspersen \and Stefan Marx" \
-sourcepath ../../src/main/java \
-subpackages org:com \
-shortinherited
cd texdoclet_output
pdflatex TeXDoclet.tex
pdflatex TeXDoclet.tex
mkdir ../javadoc
cp TeXDoclet.pdf ../javadoc

31
examples/example2_complete_report/createDocs.sh Executable file
View File

@@ -0,0 +1,31 @@
#
# this example demonstrates the use of different .tex inlude files
#
mkdir texdoclet_output
rm texdoclet_output/TeXDoclet.aux
javadoc -docletpath ../../target/TeXDoclet.jar \
-doclet org.stfm.texdoclet.TeXDoclet \
-noindex \
-tree \
-hyperref \
-texsetup texdoclet_include/setup.tex \
-texintro texdoclet_include/intro.tex \
-texfinish texdoclet_include/finish.tex \
-texinit texdoclet_include/preamble.tex \
-imagespath ".." \
-output texdoclet_output/TeXDoclet.tex \
-title "TeXDoclet Java Documentation" \
-subtitle "Created with Javadoc TeXDoclet Doclet" \
-author "Greg Wonderly \and S\"oren Caspersen \and Stefan Marx" \
-sourcepath ../../src/main/java \
-subpackages org:com \
-sectionlevel section
cd texdoclet_output
pdflatex TeXDoclet.tex
pdflatex TeXDoclet.tex
mkdir ../javadoc
cp TeXDoclet.pdf ../javadoc

16
examples/example2_complete_report/texdoclet_include/finish.tex Normal file
View File

@@ -0,0 +1,16 @@
% ------- textdoclet_include/finish.tex
% add something here
% closing for \chapter{TeXDoclet Java Documentation} {
}
\chapter{Finish}{
(content from file finish.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
}
% ------- textdoclet_include/finish.tex end

41
examples/example2_complete_report/texdoclet_include/intro.tex Normal file
View File

@@ -0,0 +1,41 @@
% ------- textdoclet_include/intro.tex
% add something here
\chapter{Introduction} {
(content from file intro.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
}
\chapter{Foo} {
(content from file intro.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
}
\chapter{Bar} {
(content from file intro.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.
Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi.
}
\chapter{TeXDoclet Java Documentation} {
% ------- textdoclet_include/intro.tex end

11
examples/example2_complete_report/texdoclet_include/setup.tex Normal file
View File

@@ -0,0 +1,11 @@
% ------- textdoclet_include/setup.tex
% add something here
\begin{abstract}
(content from file setup.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
\end{abstract}
% ------- textdoclet_include/setup.tex end

25
examples/example3_complete_article/createDocs.sh Executable file
View File

@@ -0,0 +1,25 @@
mkdir texdoclet_output
rm texdoclet_output/TeXDoclet.aux
javadoc -docletpath ../../target/TeXDoclet.jar \
-doclet org.stfm.texdoclet.TeXDoclet \
-noindex \
-hyperref \
-texinit texdoclet_include/preamble.tex \
-texsetup texdoclet_include/setup.tex \
-texintro texdoclet_include/intro.tex \
-texfinish texdoclet_include/finish.tex \
-imagespath ".." \
-output texdoclet_output/TeXDoclet.tex \
-sourcepath ../../src/main/java \
-subpackages org:com \
-sectionlevel section \
-docclass article \
-nosummaries
cd texdoclet_output
pdflatex TeXDoclet.tex
pdflatex TeXDoclet.tex
mkdir ../javadoc
cp TeXDoclet.pdf ../javadoc

18
examples/example3_complete_article/texdoclet_include/finish.tex Normal file
View File

@@ -0,0 +1,18 @@
% ------- textdoclet_include/finish.tex
% add something here
%\chapter{Finish}{
\section{Finish}{
%
% or without numbering :
%
%\section*{Finish} {
%\addcontentsline{toc}{section}{Finish}
(content from file finish.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
}
% ------- textdoclet_include/finish.tex end

17
examples/example3_complete_article/texdoclet_include/intro.tex Normal file
View File

@@ -0,0 +1,17 @@
% ------- textdoclet_include/intro.tex
% add something here
\section{Introduction} {
%
% or without numbering :
%
%\section*{Introduction} {
%\addcontentsline{toc}{section}{Introduction}
(content from file intro.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
}
% ------- textdoclet_include/intro.tex end

15
examples/example3_complete_article/texdoclet_include/preamble.tex Normal file
View File

@@ -0,0 +1,15 @@
% ------- textdoclet_include/preamble.tex
% add something here
\date{\today}
\title{TeXDoclet Java Documentation\bigskip\\ \Large Created with Javadoc TeXDoclet Doclet}
\author{Greg Wonderly \and S\"oren Caspersen \and Stefan Marx}
%\usepackage{titlesec}
%\titlespacing*{\chapter}{0pt}{10pt}{5pt}
%\titlespacing*{\section}{0pt}{10pt}{5pt}
%\titlespacing*{\subsection}{0pt}{5pt}{3pt}
%\titlespacing*{\subsubsection}{0pt}{5pt}{3pt}
% ------- textdoclet_include/preamble.tex end

14
examples/example3_complete_article/texdoclet_include/setup.tex Normal file
View File

@@ -0,0 +1,14 @@
% ------- textdoclet_include/setup.tex
% we have to call maketitle here because no title was given in the javadoc -docletpath ../../target/TeXDoclet.jar execution
\maketitle
% add something here
\begin{abstract}
(content from file setup.tex)
\newline
\newline
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
\end{abstract}
% ------- textdoclet_include/setup.tex end

36
examples/example4_include/MyDocument.tex Normal file
View File

@@ -0,0 +1,36 @@
\documentclass[11pt,a4paper]{report}
\usepackage[english]{babel}
\usepackage{blindtext}
% 1. TeXDoclet output include
\input{texdoclet_output/TeXDoclet_preamble}
% use behind of TeXDoclet_preamble.tex because of option clash with pdftex
\usepackage{fullpage}
\usepackage{hyperref}
\hypersetup{
colorlinks=true,allcolors=blue,pdfpagemode=UseOutlines,pdfpagelayout=TwoPageRight
}
\usepackage{hypcap}
\begin{document}
\date{\today}
\title{TeXDoclet Java Documentation\bigskip\\ \Large Created with Javadoc TeXDoclet Doclet}
\author{Greg Wonderly \and S\"oren Caspersen \and Stefan Marx}
\maketitle
\tableofcontents
\chapter{Foo} {\section{Foo1} {\blindtext}}
\chapter{Bar} {\section{Bar1} {\blindtext \newline \newline \blindtext }\section{Bar2} {\blindtext}}
\chapter{TeXdoclet Java Documentation} {
% 2. TeXDoclet output include
\input{texdoclet_output/TeXDoclet}
}
\chapter{FooBar} {\section{FooBar1} {\blindtext}}
\end{document}

31
examples/example4_include/createDocs.sh Executable file
View File

@@ -0,0 +1,31 @@
#
# - this example shows how to use the -include option
# - TeXDoclet generated output (TeXDoclet.tex and TeXDoclet_preamble.tex)
# is included in another Latex document (MyDocument.tex) here
#
mkdir texdoclet_output
rm MyDocument.aux
rm MyDocument.idx
rm MyDocument.out
rm MyDocument.toc
rm MyDocument.pdf
rm texdoclet_output/TeXDoclet.aux
rm texdoclet_output/TeXDoclet_preamble.aux
# -imagespath ".." not needed here because path texdoclet_images is in subdir of MyDocument.tex
javadoc -docletpath ../../target/TeXDoclet.jar \
-doclet org.stfm.texdoclet.TeXDoclet \
-tree \
-noindex \
-hyperref \
-output texdoclet_output/TeXDoclet.tex \
-sourcepath ../../src/main/java \
-subpackages com:org \
-include \
-sectionlevel section
pdflatex MyDocument.tex
pdflatex MyDocument.tex