Merge pull request AllenDowney#13 from trinketapp/trinket-poc

ChrisMayfield · web-flow · commit 802057b3edc6 · 2017-02-21T15:42:07.000-05:00
Trinket proof of concept
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,7 @@ thinkjava.toc
 # Java examples
 *.class
 checkstyle*.jar
+
+# HTML output
+trinkethtml/*
+html/*
diff --git a/Makefile b/Makefile
@@ -1,5 +1,7 @@
 F=thinkjava
 
+.PHONY: trinket
+
 all:
 	pdflatex $(F)
 	makeindex $(F).idx        # shouldn't need .idx here, but we do
@@ -57,13 +59,15 @@ distrib:
 # a bug (in ocaml?) causes "make trinket" to fail; use "make -i trinket" instead
 trinket: thinkjava.tex header.html footer.html
 	cp $(F).tex $(F)6.tex
-	rm -rf html
-	mkdir html
+	rm -rf trinkethtml
+	mkdir trinkethtml
 	hevea -O -exec xxdate.exe -e latexonly trinket $(F)6
 	hevea -O -exec xxdate.exe -e latexonly trinket $(F)6
 	imagen -png -pdf $(F)6
 	imagen -png -pdf $(F)6
 	hacha $(F)6.html
-	cp up.png next.png back.png html
-	mv index.html $(F)6.css $(F)6?*.html $(F)6*.png html
+	cp up.png next.png back.png trinkethtml
+	mv index.html $(F)6.css $(F)6?*.html $(F)6*.png trinkethtml
 	rm *motif.gif $(F)6.*
+	# perl postprocessing (woot) seems easier than escaping through Latex and Hevea
+	perl -i -pe 's/\[\[\[\[\s?(\S*?)\s?\]\]\]\]/----{\1}----/g' trinkethtml/*.html
diff --git a/thinkjava.tex b/thinkjava.tex
@@ -561,7 +561,7 @@ \section{The hello world program}
 % more precise, but also to reduce the number of times ``print'' appears,
 % which is a lot!
 
-\begin{trinket}
+\begin{trinket}{Hello.java}
 public class Hello {
 
     public static void main(String[] args) {
@@ -651,7 +651,7 @@ \section{Displaying strings}
 You can put as many statements as you like in \java{main}.
 For example, to display more than one line of output:
 
-\begin{code}
+\begin{trinket}{Hello.java}
 public class Hello {
 
     public static void main(String[] args) {
@@ -660,7 +660,7 @@ \section{Displaying strings}
         System.out.println("How are you?");   // another line
     }
 }
-\end{code}
+\end{trinket}
 
 As this example shows, you can put comments at the end of a line as well as on lines all by themselves.
 
@@ -762,36 +762,36 @@ \section{Formatting code}
 In Java programs, some spaces are required.
 For example, you need at least one space between words, so this program is not legal:
 
-\begin{code}
+\begin{trinket}{Goodbye.java}
 publicclassGoodbye{
 
     publicstaticvoidmain(String[] args) {
         System.out.print("Goodbye, ");
         System.out.println("cruel world");
     }
 }
-\end{code}
+\end{trinket}
 
 But most other spaces are optional.
 For example, this program is legal:
 
-\begin{code}
+\begin{trinket}{Goodbye.java}
 public class Goodbye {
 public static void main(String[] args) {
 System.out.print("Goodbye, ");
 System.out.println("cruel world");
 }
 }
-\end{code}
+\end{trinket}
 
 The newlines are optional, too.
 So we could just write:
 
-\begin{code}
+\begin{trinket}{Goodbye.java}
 public class Goodbye { public static void main(String[] args)
 { System.out.print("Goodbye, "); System.out.println
 ("cruel world");}}
-\end{code}
+\end{trinket}
 
 It still works, but the program is getting harder and harder to read.
 Newlines and spaces are important for organizing your program visually, making it easier to understand the program and find errors when they occur.
@@ -1661,15 +1661,15 @@ \section{Types of errors}
 Error messages from the compiler usually indicate where in the program the error occurred, and sometimes they can tell you exactly what the error is.
 As an example, let's get back to the hello world program from Section~\ref{hello}.
 
-\begin{code}
+\begin{trinket}{Hello.java}
 public class Hello {
 
     public static void main(String[] args) {
         // generate some simple output
         System.out.println("Hello, World!");
     }
 }
-\end{code}
+\end{trinket}
 
 \index{semicolon}
 
@@ -1753,15 +1753,15 @@ \section{Types of errors}
 Instead, it will do exactly what you told it to do.
 For example, here is a version of the hello world program with a logic error:
 
-\begin{code}
+\begin{trinket}{Hello.java}
 public class Hello {
 
     public static void main(String[] args) {
         System.out.println("Hello, ");
         System.out.println("World!");
     }
 }
-\end{code}
+\end{trinket}
 
 This program compiles and runs just fine, but the output is:
 
@@ -2068,7 +2068,7 @@ \section{The Scanner class}
 \java{Scanner} provides a method called \java{nextLine} that reads a line of input from the keyboard and returns a \java{String}.
 The following example reads two lines and repeats them back to the user:
 
-\begin{code}
+\begin{trinket}{Echo.java}
 import java.util.Scanner;
 
 public class Echo {
@@ -2086,7 +2086,7 @@ \section{The Scanner class}
         System.out.println("You also said: " + line);
     }
 }
-\end{code}
+\end{trinket}
 
 If you omit the import statement and later refer to \java{Scanner}, you will get a compiler error like ``cannot find symbol''.
 That means the compiler doesn't know what you mean by \java{Scanner}.
@@ -2397,7 +2397,7 @@ \section{Putting it all together}
 %Since we've looked at each of these topics in isolation, it's important to see how they fit together in a complete program.
 %If you've been working through the examples on your computer as you've been reading (like we recommended in Section~\ref{sec:examples}), then good job!
 
-\begin{code}
+\begin{trinket}{Convert.java}
 import java.util.Scanner;
 
 /**
@@ -2424,7 +2424,7 @@ \section{Putting it all together}
                           cm, feet, remainder);
     }
 }
-\end{code}
+\end{trinket}
 
 Although not required, all variables and constants are declared at the top of \java{main}.
 This practice makes it easier to find their types later on, and it helps the reader know what data is involved in the algorithm.
@@ -2645,7 +2645,7 @@ \section{Exercises}
 To choose a random number, you can use the \java{Random} class in \java{java.util}.
 Here's how it works:
 
-\begin{code}
+\begin{trinket}{GuessStarter.java}
 import java.util.Random;
 
 public class GuessStarter {
@@ -2657,7 +2657,7 @@ \section{Exercises}
         System.out.println(number);
     }
 }
-\end{code}
+\end{trinket}
 
 \index{new}
 \index{operator!new}
@@ -2833,7 +2833,7 @@ \section{Adding new methods}
 You have probably guessed by now that you can define more than one method in a class.
 Here's an example:
 
-\begin{code}
+\begin{trinket}{NweLine.java}
 public class NewLine {
 
     public static void newLine() {
@@ -2846,7 +2846,7 @@ \section{Adding new methods}
         System.out.println("Second line.");
     }
 }
-\end{code}
+\end{trinket}
 
 \index{main}
 \index{case-sensitive}
@@ -2948,7 +2948,7 @@ \section{Flow of execution}
 
 Pulling together the code from the previous section, the complete program looks like this:
 
-\begin{code}
+\begin{trinket}{NewLine.java}
 public class NewLine {
 
     public static void newLine() {
@@ -2967,7 +2967,7 @@ \section{Flow of execution}
         System.out.println("Second line.");
     }
 }
-\end{code}
+\end{trinket}
 
 \index{flow of execution}
 
@@ -3008,7 +3008,7 @@ \section{Parameters and arguments}
 The parameter list indicates what arguments are required.
 The following class shows an example:
 
-\begin{code}
+\begin{trinket}{PrintTwice.java}
 public class PrintTwice {
 
     public static void printTwice(String s) {
@@ -3020,7 +3020,7 @@ \section{Parameters and arguments}
         printTwice("Don't make me say this twice!");
     }
 }
-\end{code}
+\end{trinket}
 
 \java{printTwice} has a parameter named \java{s} with type \java{String}.
 When we invoke \java{printTwice}, we have to provide an argument with type \java{String}.
@@ -3128,7 +3128,7 @@ \section{Stack diagrams}
 
 Pulling together the code fragments from the previous section, here is a complete class definition:
 
-\begin{code}
+\begin{trinket}{PrintTime.java}
 public class PrintTime {
 
     public static void printTime(int hour, int minute) {
@@ -3143,7 +3143,7 @@ \section{Stack diagrams}
         printTime(hour, minute);
     }
 }
-\end{code}
+\end{trinket}
 
 \java{printTime} has two parameters, named \java{hour} and \java{minute}.
 And \java{main} has two variables, also named \java{hour} and \java{minute}.
@@ -3311,7 +3311,7 @@ \section{Writing documentation}
 
 Here's a class definition with two Javadoc comments, one for the class and one for the \java{main} method:
 
-\begin{code}
+\begin{trinket}{Goodbye.java}
 /**
  * Example program that demonstrates print vs println.
  */
@@ -3325,7 +3325,7 @@ \section{Writing documentation}
         System.out.println("cruel world");
     }
 }
-\end{code}
+\end{trinket}
 
 The class comment explains the purpose of the class.
 The method comment explains what the method does.
@@ -4246,7 +4246,7 @@ \section{Exercises}
 This exercise reviews the flow of execution through a program with multiple methods.
 Read the following code and answer the questions.
 
-\begin{code}
+\begin{trinket}{Buzz.java}
 public class Buzz {
 
     public static void baffle(String blimp) {
@@ -4269,7 +4269,7 @@ \section{Exercises}
     }
 
 }
-\end{code}
+\end{trinket}
 
 \begin{enumerate}
 
@@ -7245,13 +7245,13 @@ \section{Command-line arguments}
 Rather than read the numbers from \java{System.in}, we'll pass them as command-line arguments.
 Here is a starting point:
 
-\begin{code}
+\begin{trinket}{Max.java}
 public class Max {
     public static void main(String[] args) {
         System.out.println(Arrays.toString(args));
     }
 }
-\end{code}
+\end{trinket}
 
 You can run this program from the command line by typing:
 
@@ -12560,4 +12560,4 @@ \subsection*{I found the bug!}
 
 %\cleardoublepage
 
-\end{document}
+\end{document}
diff --git a/trinket b/trinket
@@ -63,9 +63,10 @@
 
 % custom HTML for Trinket publisher tools
 % see http://hevea.inria.fr/doc/manual018.html
-\newenvironment{trinket}
-{\@print{<b>TODO begin Trinket</b>}\rawhtml}
-{\endrawhtml\@print{<b>TODO end Trinket</b>}}
+\newenvironment{trinket}[1]
+{\@print{<script type="text/javascript">(function(d,l,s,i,c){function n(e){e=e.nextSibling;return (!e||e.nodeType!=3)?e:n(e);};function r(f){/in/.test(d.readyState) ? setTimeout(function(){r(f);},9):f()};l=d.getElementsByTagName('script');s=l[l.length-1];r(function(){i=n(s),c=n(i);i.setAttribute('src','https://trinket.io/tools/1.0/jekyll/embed/java#code='+encodeURIComponent(c.nodeValue.replace(/^\s+|\s+$/g,'')));});})(document)</script><iframe width="100%" height="400" frameborder="0" marginwidth="0" marginheight="0" class="lazyload" allowfullscreen></iframe><!--}
+[[[[ #1 ]]]]\rawhtml}
+{\endrawhtml\@print{-->}}
 
 % inline syntax formatting
 \newcommand{\java}{\lstinline}%}
