Skip to content

Commit 3b48344

Browse files
ggrossetierwinch
ggrossetie
authored and
rwinch
committed
Add an AsciiDoc to PDF example
1 parent 1310788 commit 3b48344

File tree

13 files changed

+387
-1
lines changed

13 files changed

+387
-1
lines changed

‎asciidoc-to-pdf-example/README.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
= PDF Example
2+
3+
An example project that demonstrates how to convert AsciiDoc to PDF using the Asciidoctor Gradle plugin.
4+
5+
== Usage
6+
7+
Convert the AsciiDoc to PDF by invoking the 'asciidoctor' goal:
8+
9+
$ ./gradlew asciidoctor
10+
11+
Open the file _build/docs/asciidocPdf/example-manual.pdf_ in your browser to see the generated PDF file.

‎asciidoc-to-pdf-example/build.gradle

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
plugins {
2+
id 'org.asciidoctor.jvm.pdf' version '3.1.0'
3+
id 'org.asciidoctor.jvm.gems' version '3.1.0'
4+
}
5+
6+
apply plugin: 'java'
7+
8+
version = '1.0.0-SNAPSHOT'
9+
10+
repositories {
11+
jcenter()
12+
ruby.gems()
13+
}
14+
15+
dependencies {
16+
asciidoctorGems 'rubygems:rouge:3.15.0'
17+
}
18+
19+
asciidoctorPdf {
20+
dependsOn asciidoctorGemsPrepare
21+
22+
baseDirFollowsSourceFile()
23+
24+
asciidoctorj {
25+
requires 'rouge'
26+
attributes 'build-gradle': file('build.gradle'),
27+
'sourcedir': project.sourceSets.main.java.srcDirs[0],
28+
'endpoint-url': 'http://example.org',
29+
'source-highlighter': 'rouge',
30+
'imagesdir': './images',
31+
'toc': 'left',
32+
'icons': 'font',
33+
'idprefix': '',
34+
'idseparator': '-'
35+
}
36+
}
37+
38+
// alias
39+
task asciidoctor(dependsOn: asciidoctorPdf)

‎asciidoc-to-pdf-example/gradle/wrapper/gradle-wrapper.jar

52.4 KB
Binary file not shown.

‎asciidoc-to-pdf-example/gradle/wrapper/gradle-wrapper.properties

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Wed Jan 29 14:51:02 CST 2020
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-bin.zip

‎asciidoc-to-pdf-example/gradlew

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
#!/usr/bin/env bash
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10+
DEFAULT_JVM_OPTS=""
11+
12+
APP_NAME="Gradle"
13+
APP_BASE_NAME=`basename "$0"`
14+
15+
# Use the maximum available, or set MAX_FD != -1 to use that value.
16+
MAX_FD="maximum"
17+
18+
warn ( ) {
19+
echo "$*"
20+
}
21+
22+
die ( ) {
23+
echo
24+
echo "$*"
25+
echo
26+
exit 1
27+
}
28+
29+
# OS specific support (must be 'true' or 'false').
30+
cygwin=false
31+
msys=false
32+
darwin=false
33+
case "`uname`" in
34+
CYGWIN* )
35+
cygwin=true
36+
;;
37+
Darwin* )
38+
darwin=true
39+
;;
40+
MINGW* )
41+
msys=true
42+
;;
43+
esac
44+
45+
# Attempt to set APP_HOME
46+
# Resolve links: $0 may be a link
47+
PRG="$0"
48+
# Need this for relative symlinks.
49+
while [ -h "$PRG" ] ; do
50+
ls=`ls -ld "$PRG"`
51+
link=`expr "$ls" : '.*-> \(.*\)$'`
52+
if expr "$link" : '/.*' > /dev/null; then
53+
PRG="$link"
54+
else
55+
PRG=`dirname "$PRG"`"/$link"
56+
fi
57+
done
58+
SAVED="`pwd`"
59+
cd "`dirname \"$PRG\"`/" >/dev/null
60+
APP_HOME="`pwd -P`"
61+
cd "$SAVED" >/dev/null
62+
63+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
64+
65+
# Determine the Java command to use to start the JVM.
66+
if [ -n "$JAVA_HOME" ] ; then
67+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
68+
# IBM's JDK on AIX uses strange locations for the executables
69+
JAVACMD="$JAVA_HOME/jre/sh/java"
70+
else
71+
JAVACMD="$JAVA_HOME/bin/java"
72+
fi
73+
if [ ! -x "$JAVACMD" ] ; then
74+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
75+
76+
Please set the JAVA_HOME variable in your environment to match the
77+
location of your Java installation."
78+
fi
79+
else
80+
JAVACMD="java"
81+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
82+
83+
Please set the JAVA_HOME variable in your environment to match the
84+
location of your Java installation."
85+
fi
86+
87+
# Increase the maximum file descriptors if we can.
88+
if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
89+
MAX_FD_LIMIT=`ulimit -H -n`
90+
if [ $? -eq 0 ] ; then
91+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
92+
MAX_FD="$MAX_FD_LIMIT"
93+
fi
94+
ulimit -n $MAX_FD
95+
if [ $? -ne 0 ] ; then
96+
warn "Could not set maximum file descriptor limit: $MAX_FD"
97+
fi
98+
else
99+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
100+
fi
101+
fi
102+
103+
# For Darwin, add options to specify how the application appears in the dock
104+
if $darwin; then
105+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
106+
fi
107+
108+
# For Cygwin, switch paths to Windows format before running java
109+
if $cygwin ; then
110+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
111+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
112+
JAVACMD=`cygpath --unix "$JAVACMD"`
113+
114+
# We build the pattern for arguments to be converted via cygpath
115+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
116+
SEP=""
117+
for dir in $ROOTDIRSRAW ; do
118+
ROOTDIRS="$ROOTDIRS$SEP$dir"
119+
SEP="|"
120+
done
121+
OURCYGPATTERN="(^($ROOTDIRS))"
122+
# Add a user-defined pattern to the cygpath arguments
123+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
124+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
125+
fi
126+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
127+
i=0
128+
for arg in "$@" ; do
129+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
130+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
131+
132+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
133+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
134+
else
135+
eval `echo args$i`="\"$arg\""
136+
fi
137+
i=$((i+1))
138+
done
139+
case $i in
140+
(0) set -- ;;
141+
(1) set -- "$args0" ;;
142+
(2) set -- "$args0" "$args1" ;;
143+
(3) set -- "$args0" "$args1" "$args2" ;;
144+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
145+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
146+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
147+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
148+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
149+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
150+
esac
151+
fi
152+
153+
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
154+
function splitJvmOpts() {
155+
JVM_OPTS=("$@")
156+
}
157+
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
158+
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
159+
160+
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"

‎asciidoc-to-pdf-example/gradlew.bat

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
@if "%DEBUG%" == "" @echo off
2+
@rem ##########################################################################
3+
@rem
4+
@rem Gradle startup script for Windows
5+
@rem
6+
@rem ##########################################################################
7+
8+
@rem Set local scope for the variables with windows NT shell
9+
if "%OS%"=="Windows_NT" setlocal
10+
11+
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12+
set DEFAULT_JVM_OPTS=
13+
14+
set DIRNAME=%~dp0
15+
if "%DIRNAME%" == "" set DIRNAME=.
16+
set APP_BASE_NAME=%~n0
17+
set APP_HOME=%DIRNAME%
18+
19+
@rem Find java.exe
20+
if defined JAVA_HOME goto findJavaFromJavaHome
21+
22+
set JAVA_EXE=java.exe
23+
%JAVA_EXE% -version >NUL 2>&1
24+
if "%ERRORLEVEL%" == "0" goto init
25+
26+
echo.
27+
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28+
echo.
29+
echo Please set the JAVA_HOME variable in your environment to match the
30+
echo location of your Java installation.
31+
32+
goto fail
33+
34+
:findJavaFromJavaHome
35+
set JAVA_HOME=%JAVA_HOME:"=%
36+
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37+
38+
if exist "%JAVA_EXE%" goto init
39+
40+
echo.
41+
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42+
echo.
43+
echo Please set the JAVA_HOME variable in your environment to match the
44+
echo location of your Java installation.
45+
46+
goto fail
47+
48+
:init
49+
@rem Get command-line arguments, handling Windows variants
50+
51+
if not "%OS%" == "Windows_NT" goto win9xME_args
52+
if "%@eval[2+2]" == "4" goto 4NT_args
53+
54+
:win9xME_args
55+
@rem Slurp the command line arguments.
56+
set CMD_LINE_ARGS=
57+
set _SKIP=2
58+
59+
:win9xME_args_slurp
60+
if "x%~1" == "x" goto execute
61+
62+
set CMD_LINE_ARGS=%*
63+
goto execute
64+
65+
:4NT_args
66+
@rem Get arguments from the 4NT Shell from JP Software
67+
set CMD_LINE_ARGS=%$
68+
69+
:execute
70+
@rem Setup the command line
71+
72+
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73+
74+
@rem Execute Gradle
75+
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76+
77+
:end
78+
@rem End local scope for the variables with windows NT shell
79+
if "%ERRORLEVEL%"=="0" goto mainEnd
80+
81+
:fail
82+
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83+
rem the _cmd.exe /c_ return code!
84+
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85+
exit /b 1
86+
87+
:mainEnd
88+
if "%OS%"=="Windows_NT" endlocal
89+
90+
:omega

‎asciidoc-to-pdf-example/settings.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
rootProject.name = 'asciidoc-to-pdf-example'

‎asciidoc-to-pdf-example/src/docs/asciidoc/example-manual.adoc

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
= Example Manual
2+
Doc Writer <doc[email protected]>
3+
2014-09-09
4+
:revnumber: {project-version}
5+
:example-caption!:
6+
ifndef::imagesdir[:imagesdir: images]
7+
ifndef::sourcedir[:sourcedir: ../java]
8+
9+
This is a user manual for an example project.
10+
11+
== Introduction
12+
13+
This project does something.
14+
We just haven't decided what that is yet.
15+
16+
== Source Code
17+
18+
[source,java]
19+
.Java code from project
20+
----
21+
include::{sourcedir}/example/StringUtils.java[tags=contains,indent=0]
22+
----
23+
24+
This page was built by the following command:
25+
26+
$ ./gradlew asciidoctor
27+
28+
== Images
29+
30+
[.thumb]
31+
image::sunset.jpg[scaledwidth=75%]
32+
33+
== Attributes
34+
35+
.Built-in
36+
asciidoctor-version:: {asciidoctor-version}
37+
safe-mode-name:: {safe-mode-name}
38+
docdir:: {docdir}
39+
docfile:: {docfile}
40+
imagesdir:: {imagesdir}
41+
42+
.Custom
43+
project-version:: {project-version}
44+
sourcedir:: {sourcedir}
45+
endpoint-url:: {endpoint-url}
46+
47+
== Includes
48+
49+
.include::subdir/_b.adoc[]
50+
====
51+
include::subdir/_b.adoc[]
52+
====
53+
54+
WARNING: Includes can be tricky!
55+
56+
== build.gradle
57+
58+
[source,groovy]
59+
----
60+
include::{build-gradle}[]
61+
----

‎asciidoc-to-pdf-example/src/docs/asciidoc/images/sunset.jpg

120 KB
Loading

‎asciidoc-to-pdf-example/src/docs/asciidoc/subdir/_b.adoc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
content from _src/docs/asciidoc/subdir/_b.adoc_.
2+
3+
.include::_c.adoc[]
4+
[example]
5+
--
6+
include::_c.adoc[]
7+
--

‎asciidoc-to-pdf-example/src/docs/asciidoc/subdir/_c.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
content from _src/docs/asciidoc/subdir/c.adoc_.

‎asciidoc-to-pdf-example/src/main/java/example/StringUtils.java

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package example;
2+
3+
public class StringUtils {
4+
// tag::contains[]
5+
public boolean contains(String haystack, String needle) {
6+
return haystack.contains(needle);
7+
}
8+
// end::contains[]
9+
}

0 commit comments

Comments
 (0)